Merge pull request #1 from processing/master

p5 changes

Author: paollabd

.all-contributorsrc

@@ -1200,10 +1200,10 @@
       "contributions": []
     },
     {
-      "login": "max-devjs",
-      "name": "max_devjs",
+      "login": "maxdevjs",
+      "name": "maxdevjs",
       "avatar_url": "https://avatars2.githubusercontent.com/u/22229196?v=4",
-      "profile": "http://twitter.com/max_devjs",
+      "profile": "http://twitter.com/maxdevjs",
       "contributions": []
     },
     {
@@ -1524,6 +1524,26 @@
         "doc",
         "example"
       ]
+    },
+    {
+      "login":"singhvisha",
+      "name":"Vishal Singh",
+      "avatar_url":"https://avatars0.githubusercontent.com/u/38842688?s=460&v=4",
+      "profile":"https://github.com/singhvisha",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "coreygo",
+      "name": "Corey Gouker",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/649879?v=4",
+      "profile": "https://www.coreygo.com",
+      "contributions": [
+        "code",
+        "doc",
+        "bug"
+      ]
     }
   ],
   "repoType": "github"

.travis.yml

@@ -1,7 +1,9 @@
 language: node_js
 node_js:
-  - "8"
-  - "10"
-install: for i in {1..3}; do travis_wait 5 npm install && break; rm -rf node_modules; done
-script: npm run grunt
-services: docker
+  - '8'
+  - '10'
+install: for i in {1..3}; do travis_wait 5 npm install && npm install codecov -g && break; rm -rf node_modules; done
+script:
+  - npm run grunt
+  - npx nyc report --reporter=json
+after_success: bash <(curl -s https://codecov.io/bash)

CODE_OF_CONDUCT.md

@@ -33,7 +33,7 @@ In the future:
   * Offensive comments related to gender identity and expression, sexual orientation, race, ethnicity, language, neuro-type, size, ability, class, religion, culture, subculture, political opinion, age, skill level, occupation, or background
   * Threats of violence
   * Deliberate intimidation
-  * Sexually explicit or violent material
+  * Sexually explicit or violent material that is not contextualized and preceded by a considerate warning 
   * Unwelcome sexual attention
   * Stalking or following
   * Or any other kinds of harassment

Gruntfile.js

@@ -59,6 +59,12 @@
  *  all-contributors generate - Generates new contributors list for README
  */
 
+// these requires allow us to use es6 features such as
+// `import`/`export` and `async`/`await` in the Grunt tasks
+// we load from other files (`tasks/`)
+require('regenerator-runtime/runtime');
+require('@babel/register');
+
 function getYuidocOptions() {
   const BASE_YUIDOC_OPTIONS = {
     name: '<%= pkg.name %>',
@@ -163,7 +169,7 @@ module.exports = grunt => {
             ecmaVersion: 5
           }
         },
-        src: ['src/**/*.js', 'lib/addons/p5.dom.js']
+        src: ['src/**/*.js']
       },
       test: {
         src: ['bench/**/*.js', 'test/**/*.js', '!test/js/*.js']
@@ -178,7 +184,7 @@ module.exports = grunt => {
         format: 'unix'
       },
       source: {
-        src: ['src/**/*.js', 'lib/addons/p5.dom.js']
+        src: ['src/**/*.js']
       },
       fix: {
         options: {
@@ -285,7 +291,7 @@ module.exports = grunt => {
       dist: {
         files: {
           'lib/p5.min.js': 'lib/p5.pre-min.js',
-          'lib/addons/p5.dom.min.js': 'lib/addons/p5.dom.js'
+          'lib/modules/p5Custom.min.js': 'lib/modules/p5Custom.pre-min.js'
         }
       }
     },
@@ -328,7 +334,7 @@ module.exports = grunt => {
             middlewares.unshift(
               require('connect-modrewrite')([
                 '^/assets/js/p5(\\.min)?\\.js(.*) /lib/p5$1.js$2 [L]',
-                '^/assets/js/p5\\.(dom|sound)(\\.min)?\\.js(.*) /lib/addons/p5.$1$2.js$3 [L]'
+                '^/assets/js/p5\\.(sound)(\\.min)?\\.js(.*) /lib/addons/p5.$1$2.js$3 [L]'
               ]),
               function(req, res, next) {
                 res.setHeader('Access-Control-Allow-Origin', '*');
@@ -355,7 +361,7 @@ module.exports = grunt => {
             middlewares.unshift(
               require('connect-modrewrite')([
                 '^/assets/js/p5(\\.min)?\\.js(.*) /lib/p5$1.js$2 [L]',
-                '^/assets/js/p5\\.(dom|sound)(\\.min)?\\.js(.*) /lib/addons/p5.$1$2.js$3 [L]'
+                '^/assets/js/p5\\.(sound)(\\.min)?\\.js(.*) /lib/addons/p5.$1$2.js$3 [L]'
               ]),
               function(req, res, next) {
                 res.setHeader('Access-Control-Allow-Origin', '*');
@@ -382,7 +388,7 @@ module.exports = grunt => {
             middlewares.unshift(
               require('connect-modrewrite')([
                 '^/assets/js/p5(\\.min)?\\.js(.*) /lib/p5$1.js$2 [L]',
-                '^/assets/js/p5\\.(dom|sound)(\\.min)?\\.js(.*) /lib/addons/p5.$1$2.js$3 [L]'
+                '^/assets/js/p5\\.(sound)(\\.min)?\\.js(.*) /lib/addons/p5.$1$2.js$3 [L]'
               ]),
               function(req, res, next) {
                 res.setHeader('Access-Control-Allow-Origin', '*');

README.md

@@ -117,7 +117,12 @@ A complete guide to unit testing is beyond the scope of the p5.js documentation,
 
    If you're continuously changing files in the library, you may want to run `npm run dev` to automatically rebuild the library for you whenever any of its source files change without you having to first type the command manually.
 
-6. Make some changes to the codebase and [commit](https://help.github.com/articles/github-glossary/#commit) them with Git.
+6. Make some changes locally to the codebase and [commit](https://help.github.com/articles/github-glossary/#commit) them with Git.
+
+   ```
+   $ git add -u
+   $ git commit -m "YOUR COMMIT MESSAGE"
+   ```
 
 7. Run `npm run grunt` again to make sure there are no syntax errors, test failures, or other problems.
 
@@ -142,7 +147,7 @@ $ npm run docs:dev
 
 The overarching p5.js project includes repositories other than this one.
 
-- [p5.js](https://github.com/processing/p5.js): This repository contains the source code for the p5.js library, as well as the p5.dom.js addon library. The [user-facing p5.js reference manual](https://p5js.org/reference/) is also generated from the [JSDoc](http://usejsdoc.org/) comments included in this source code. It is maintained by [Lauren McCarthy](https://github.com/lmccart).
+- [p5.js](https://github.com/processing/p5.js): This repository contains the source code for the p5.js library. The [user-facing p5.js reference manual](https://p5js.org/reference/) is also generated from the [JSDoc](http://usejsdoc.org/) comments included in this source code. It is maintained by [Lauren McCarthy](https://github.com/lmccart).
 - [website](https://github.com/processing/p5.js-website) This repository contains most of the code for the [p5.js website](http://p5js.org), with the exception of the reference manual. It is maintained by [Lauren McCarthy](https://github.com/lmccart).
 - [sound](https://github.com/processing/p5.js-sound) This repository contains the p5.sound.js library. It is maintained by [Jason Sigal](https://github.com/therewasaguy).
 - [web editor](https://github.com/processing/p5.js-web-editor): This repository contains the source code for the [p5.js web editor](https://editor.p5js.org). It is maintained by [Cassie Tarakajian](https://github.com/catarak). Note that the older [p5.js editor](https://github.com/processing/p5.js-editor) is now deprecated.

developer_docs/README.md

@@ -2,26 +2,43 @@
 
 ## Overview
 
-An excellent new [feature](https://github.com/processing/p5.js/pull/2051) of p5.js allows user to build p5.js as a custom combination of its modules. This greatly helps in reducing the production version size of the library, as well as improves overall performance. 
+An excellent new [feature](https://github.com/processing/p5.js/pull/2051) of p5.js allows user to build p5.js as a custom combination of its modules. This greatly helps in reducing the production version size of the library, as well as improves overall performance.
 
 This feature was suggested as a part of a proposal for Google Summer of Code 2017.
 
-## Usage 
+## Usage
 
-Currently, the usage is through invoking a Grunt task manually from the command line. 
+Currently, the usage is through invoking a Grunt task manually from the command line:
 
-```
+```sh
 git clone https://github.com/processing/p5.js.git
 cd p5.js
 npm install
 npm run grunt
 npm run grunt combineModules:module_x:module_y
 ```
 
-Here, `module_n` refers to the name of the module which you want to select. Multiple modules must be passed as shown above. Also, these modules must have the same name as their folders in `/src` directory to work correctly. While `core` is included by default, `core/shape` needs to be included for shapes like line() and other core features to work.
+Here, `module_n` refers to the name of the modules which you want to select. Multiple modules must be passed as shown above. Also, these modules must have the same name as their folders in `/src` directory to work correctly. While `core` is included by default, `core/shape` needs to be included for shapes like line() and other core features to work.
+
+The above usage example will likely output a `p5Custom.js` larger than the complete `p5.min.js` as the output is not minified using the `uglify` task.
+
+The recommended steps to reduce bundle size as much as possible are:
+
+```sh
+git clone https://github.com/processing/p5.js.git
+cd p5.js
+npm install
+npm run grunt
+npm run grunt combineModules:min:module_x:module_y uglify
+```
+
+## Examples
 
-## Example
+- `npm run grunt combineModules:min:core/shape:color:math:image uglify`  
+  Generates a `p5Custom.min.js` bundle in the `lib/modules` directory with the combineModules and uglify tasks. Note that modules should be listed after `combineModules:min` and the `uglify` task should have a space after the modules list.
 
-`npm run grunt combineModules:core/shape:color:math:image`
+- `npm run grunt combineModules:core/shape:color:math:image`  
+  Generates a non-minified `p5Custom.js` bundle in the `lib/modules` directory.
 
-This will generate your `p5Custom.js` bundle in the `lib/modules` directory.
+- `npm run grunt combineModules:min:core/shape:color:math:image`  
+  Generates a `p5Custom.pre-min.js` in the `lib/modules` directory with the `combineModules:min` task. Note that in this example `npm run grunt uglify` can be run separately after running the `combineModules:min` task.