Generate TypeScript definitions

Gruntfile.js

@@ -383,6 +383,11 @@ module.exports = function(grunt) {
   // Load release task
   grunt.loadTasks('tasks/release');
 
+  // Load typescript task
+  grunt.registerTask('typescript', function() {
+    require('./tasks/typescript/task.js')(grunt);
+  });
+
   // Load the external libraries used.
   grunt.loadNpmTasks('grunt-contrib-compress');
   grunt.loadNpmTasks('grunt-contrib-connect');
@@ -426,7 +431,7 @@ module.exports = function(grunt) {
     'mochaTest'
   ]);
   grunt.registerTask('test:nobuild', ['eslint:test', 'connect', 'mocha']);
-  grunt.registerTask('yui', ['yuidoc:prod', 'minjson']);
+  grunt.registerTask('yui', ['yuidoc:prod', 'minjson', 'typescript']);
   grunt.registerTask('yui:test', ['yuidoc:prod', 'connect', 'mocha:yui']);
   grunt.registerTask('default', ['test']);
   grunt.registerTask('saucetest', ['connect', 'saucelabs-mocha']);

package.json

@@ -71,6 +71,7 @@
     "grunt-release-it": "^1.0.1",
     "grunt-saucelabs": "8.6.1",
     "grunt-update-json": "^0.2.1",
+    "html2plaintext": "^1.1.1",
     "husky": "^0.14.3",
     "jscs-stylish": "^0.3.1",
     "karma": "^1.7.1",
@@ -87,7 +88,8 @@
     "mocha": "^3.2.0",
     "phantomjs": "^2.1.7",
     "prettier": "^1.7.4",
-    "request": "^2.81.0"
+    "request": "^2.81.0",
+    "word-wrap": "^1.2.3"
   },
   "license": "LGPL-2.1",
   "dependencies": {
@@ -100,14 +102,17 @@
     "whatwg-fetch": "^2.0.3"
   },
   "main": "./lib/p5.js",
+  "types": "./lib/p5.d.ts",
   "files": [
     "license.txt",
     "lib/p5.min.js",
     "lib/p5.js",
     "lib/addons/p5.sound.js",
     "lib/addons/p5.sound.min.js",
     "lib/addons/p5.dom.js",
-    "lib/addons/p5.dom.min.js"
+    "lib/addons/p5.dom.min.js",
+    "lib/p5.d.ts",
+    "lib/p5.global-mode.d.ts"
   ],
   "description": "[![Build Status](https://travis-ci.org/processing/p5.js.svg?branch=master)](https://travis-ci.org/processing/p5.js) [![npm version](https://badge.fury.io/js/p5.svg)](https://www.npmjs.com/package/p5)",
   "bugs": {

src/core/core.js

@@ -26,13 +26,14 @@ var constants = require('./constants');
  * "global"   - all properties and methods are attached to the window
  * "instance" - all properties and methods are bound to this p5 object
  *
- * @private
+ * @class p5
+ * @constructor
  * @param  {function}    sketch a closure that can set optional preload(),
  *                              setup(), and/or draw() properties on the
  *                              given p5 instance
- * @param  {HTMLElement|boolean} [node] element to attach canvas to, if a
+ * @param  {HTMLElement|Boolean} [node] element to attach canvas to, if a
  *                                      boolean is passed in use it as sync
- * @param  {boolean}     [sync] start synchronously (optional)
+ * @param  {Boolean}     [sync] start synchronously (optional)
  * @return {p5}                 a p5 instance
  */
 var p5 = function(sketch, node, sync) {

tasks/release/release-github.js

@@ -63,6 +63,12 @@ module.exports = function(grunt) {
         './lib/addons/p5.sound.min.js',
         'application/javascript'
       ],
+      p5ts: ['p5.d.ts', './lib/p5.d.ts', 'text/plain'],
+      p5globalts: [
+        'p5.global-mode.d.ts',
+        './lib/p5.global-mode.d.ts',
+        'text/plain'
+      ],
       p5zip: ['p5.zip', './p5.zip', 'application/zip']
     };
 

tasks/typescript/emit.js

@@ -0,0 +1,119 @@
+var fs = require('fs');
+var h2p = require('html2plaintext');
+var wrap = require('word-wrap');
+
+function shortenDescription(desc) {
+  return wrap(h2p(desc).replace(/[\r\n]+/, ''), {
+    width: 50
+  });
+}
+
+function createEmitter(filename) {
+  var indentLevel = 0;
+  var lastText = '';
+  var currentSourceFile;
+  var fd = fs.openSync(filename, 'w');
+
+  var emit = function(text) {
+    var indentation = [];
+    var finalText;
+
+    for (var i = 0; i < indentLevel; i++) {
+      indentation.push('  ');
+    }
+
+    finalText = indentation.join('') + text + '\n';
+    fs.writeSync(fd, finalText);
+
+    lastText = text;
+  };
+
+  emit.description = function(classitem, overload) {
+    var desc = classitem.description;
+    if (!desc) {
+      return;
+    }
+
+    function emitDescription(desc) {
+      shortenDescription(desc)
+        .split('\n')
+        .forEach(function(line) {
+          emit(' * ' + line);
+        });
+    }
+
+    emit.sectionBreak();
+    emit('/**');
+    emitDescription(desc);
+    emit(' *');
+    if (overload) {
+      var alloverloads = [classitem];
+      if (classitem.overloads) {
+        alloverloads = alloverloads.concat(classitem.overloads);
+      }
+      if (overload.params) {
+        overload.params.forEach(function(p) {
+          var arg = p.name;
+          var p2;
+          for (var i = 0; !p2 && i < alloverloads.length; i++) {
+            if (alloverloads[i].params) {
+              p2 = alloverloads[i].params.find(
+                p3 => p3.description && p3.name === arg
+              );
+              if (p2) {
+                if (p.optional) {
+                  arg = '[' + arg + ']';
+                }
+                emitDescription('@param ' + arg + ' ' + p2.description);
+                break;
+              }
+            }
+          }
+        });
+      }
+      if (overload.chainable) {
+        emitDescription('@chainable');
+      } else if (overload.return && overload.return.description) {
+        emitDescription('@return ' + overload.return.description);
+      }
+    }
+    emit(' */');
+  };
+
+  emit.setCurrentSourceFile = function(file) {
+    if (file !== currentSourceFile) {
+      currentSourceFile = file;
+      emit.sectionBreak();
+      emit('// ' + file);
+      emit.sectionBreak();
+    }
+  };
+
+  emit.sectionBreak = function() {
+    if (lastText !== '' && !/\{$/.test(lastText)) {
+      emit('');
+    }
+  };
+
+  emit.getIndentLevel = function() {
+    return indentLevel;
+  };
+
+  emit.indent = function() {
+    indentLevel++;
+  };
+
+  emit.dedent = function() {
+    indentLevel--;
+  };
+
+  emit.close = function() {
+    fs.closeSync(fd);
+  };
+
+  emit('// This file was auto-generated. Please do not edit it.\n');
+
+  return emit;
+}
+
+module.exports = createEmitter;