diff --git a/contributor_docs/archive/custom_p5_build.md b/contributor_docs/archive/custom_p5_build.md deleted file mode 100644 index 04eab00f67..0000000000 --- a/contributor_docs/archive/custom_p5_build.md +++ /dev/null @@ -1,46 +0,0 @@ - - -# Creating a custom build of p5.js with select components - -## 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. - -This feature was suggested as a part of a proposal for Google Summer of Code 2017. - -## Usage - -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 ci -npm run grunt -npm run grunt combineModules:module_x:module_y -``` - -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 ci -npm run grunt -npm run grunt combineModules:min:module_x:module_y uglify -``` - -## Examples - -- `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` - Generates a non-minified `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. diff --git a/contributor_docs/es/steward_guidelines.md b/contributor_docs/es/steward_guidelines.md index de1ef0f477..3a2c9f4fba 100644 --- a/contributor_docs/es/steward_guidelines.md +++ b/contributor_docs/es/steward_guidelines.md @@ -382,4 +382,3 @@ Al observar un repositorio, eventos como nuevos issues, nuevos pull En algunos casos, también puedes recibir correos electrónicos de GitHub sobre eventos en el repositorio que estás observando, y puedes personalizarlos (incluida la desuscripción completa de ellos) desde tu [página de configuración de notificaciones](https://github.com/settings/notifications). Configurar estas opciones para que se adapten a la forma en que trabajas puede ser la diferencia entre tener que buscar issues/PRs relevantes para revisar manualmente y sentirse abrumado por notificaciones interminables de GitHub. Se requiere un buen equilibrio aquí. Como sugerencia inicial, los supervisores deberían observar este repositorio para Issues y Pull Requests y configurarlo para recibir correos electrónicos solo sobre "Participando, @menciones y personalizadas". - diff --git a/contributor_docs/steward_guidelines.md b/contributor_docs/steward_guidelines.md index 2b271f8ba1..2782279b7e 100644 --- a/contributor_docs/steward_guidelines.md +++ b/contributor_docs/steward_guidelines.md @@ -20,11 +20,10 @@ Whether you are new to p5.js contribution, are already active on the p5.js GitHu - [Pull Requests](#pull-requests) - [Simple fix](#simple-fix) - [Bug fix](#bug-fix) - - [New feature/feature enhancement](#new-feature-feature-enhancement) + - [New feature/feature enhancement](#new-featurefeature-enhancement) - [Dependabot](#dependabot) - [Build Process](#build-process) - [Main build task](#main-build-task) - - [Miscellaneous tasks](#miscellaneous-tasks) - [Release Process](#release-process) - [Tips & Tricks](#tips--tricks) - [Reply templates](#reply-templates) @@ -87,7 +86,7 @@ To remain a steward, you must contribute as a steward to at least 1 of the 2 mos ### Getting Started with Stewardship -1. Keep this guideline handy as a reference - how to help with new issues, bugs, and features. For example, the "Feature request" section includes tips on how to use the the p5.js [access statement](access.md) as a steward. +1. Keep this guideline handy as a reference - how to help with new issues, bugs, and features. For example, the "Feature request" section includes tips on how to use the p5.js [access statement](access.md) as a steward. 2. When helping to answer technical questions or review, try to apply the Processing Foundation [guideline on answering questions](https://discourse.processing.org/t/guidelines-answering-questions/2145) - these can be especially helpful for giving constructive technical feedback. 3. Join the [p5.js Discord](https://discord.com/invite/SHQ8dH25r9) - in the `#contribute-to-p5` you're welcome to ask any questions you have about this process - or suggest how it can be improved! @@ -237,125 +236,70 @@ Dependabot PRs are usually only visible to repo admins so if this does not apply This section will not cover the general build setup nor commands but rather details about what's happening behind the scenes. Please see the [contributor’s guidelines](contributor_guidelines.md#working-on-p5js-codebase) for more detailed build info. -The Gruntfile.js file contains the main build definitions for p5.js. Among the different tools used to build the library and documentation includes but not limited to Grunt, Browserify, YUIDoc, ESLint, Babel, Uglify, and Mocha. It may be helpful for us to start with the `default` task and work backward from there. It may be helpful at this point to open up the Gruntfile.js document while going through the explainer below. +Starting with p5.js version 2.0, the project no longer uses Grunt for task automation. Instead, the build and test processes are handled using modern tools like npm scripts, ESLint, and [Vitest](https://vitest.dev/). ### Main build task -``` -grunt.registerTask('default', ['lint', 'test']); -``` - -When we run `grunt` or the npm script `npm test`, we run the default task consisting of `lint` then `test`. - - -#### `lint` Task +To run lint checks and unit tests, simply run: ``` -grunt.registerTask('lint', ['lint:source', 'lint:samples']); +npm test ``` -The `lint` task consists of two sub tasks: `lint:source` and `lint:samples`. `lint:source` is further subdivided into three more sub tasks `eslint:build`, `eslint:source`, and `eslint:test`, which uses ESLint to check the build scripts, the source code, and the test scripts. +This command runs ESLint to check code style and then execute unit and visual tests using Vitest. -The `lint:samples` task will first run the `yui` task which itself consists of `yuidoc:prod`, `clean:reference`, and `minjson`, which extract the documentation from the source code into a JSON document, remove unused files from the previous step, and minify the generated JSON file into `data.min.json` respectively. - -Next in `lint:samples` is `eslint-samples:source`, which is a custom written task whose definition is in [../tasks/build/eslint-samples.js](../tasks/build/eslint-samples.js); it will run ESLint to check the documentation example code to make sure they follow the same coding convention as the rest of p5.js (`yui` is run first here because we need the JSON file to be built first before we can lint the examples). +#### `lint` Task +In p5.js 2.0, ESLint is used directly via npm scripts for all linting tasks. -#### `test` Task +To run lint checks on the codebase: -```js -grunt.registerTask('test', [ - 'build', - 'connect:server', - 'mochaChrome', - 'mochaTest', - 'nyc:report' -]); ``` - -First let's look at the `build` task under `test`. - -```js -grunt.registerTask('build', [ - 'browserify', - 'browserify:min', - 'uglify', - 'browserify:test' -]); +npm run lint ``` -Tasks that start with `browserify` are defined in [../tasks/build/browserify.js](../tasks/build/browserify.js). They all have similar steps with minor differences. These are the main steps to build the full p5.js library from its many source code files into one: - -- `browserify` builds p5.js while `browserify:min` builds an intermediate file to be minified in the next step. The difference between `browserify` and `browserify:min` is that `browserify:min` does not contain data needed for FES to function. -- `uglify` takes the output file of `browserify:min` and minify it into the final p5.min.js (configuration of this step is in the main Gruntfile.js). -- `browserify:test` is building a version identical to the full p5.js except for added code that is used for test code coverage reporting (using [Istanbul](https://istanbul.js.org/)). +This checks the source files, build scripts, test files, and documentation examples using ESLint. -First, use of the `fs.readFileSync()` node.js specific code is replaced with the file's actual content using `brfs-babel`. This is used mainly by WebGL code to inline shader code from source code written as separate files. - -Next, the source code, including all dependencies from node\_modules, is transpiled using Babel to match the [Browserslist](https://browsersl.ist/) requirement defined in package.json as well as to make the ES6 import statements into CommonJS `require()` that browserify understands. This also enables us to use newer syntax available in ES6 and beyond without worrying about browser compatibility. - -After bundling but before the bundled code is written to file, the code is passed through `pretty-fast`, if it is not meant to be minified, it should be cleaned up so the final formatting is a bit more consistent (we anticipate the p5.js source code can be read and inspected if desired). - -A few small detailed steps are left out here; you can check out the browserify build definition file linked above to have a closer look at everything. +If you only want to run linting for specific files or directories, you can use ESLint directly: ``` -connect:server +npx eslint src/ +npx eslint test/ ``` -This step spins up a local server hosting the test files and built source code files so that automated tests can be run in Chrome. - -``` -mochaChrome -``` +There is no separate sample linter or YUIDoc-based pipeline anymore. -This step is defined in [../tasks/test/mocha-chrome.js](../tasks/test/mocha-chrome.js). It uses Puppeteer to spin up a headless version of Chrome that can be remote controlled and runs the tests associated with the HTML files in the `./test` folder, which includes testing the unminified and minified version of the library against the unit test suites as well as testing all reference examples. +#### `test` Task -``` -mochaTest -``` +In p5.js 2.0, the testing system no longer uses Mocha via Grunt. Instead, tests are run using [Vitest](https://vitest.dev/) through npm scripts. -This step differs from `mochaChrome` in that it is run in node.js instead of in Chrome and only tests a small subset of features in the library. Most features in p5.js will require a browser environment, so this set of tests should only be expanded if the new tests really don't need a browser environment. +To run the full test suite (unit and visual tests), use: ``` -nyc:report +npm test ``` -Finally, after all builds and tests are complete, this step will gather the test coverage report while `mochaChrome` was testing the full version of the library and print the test coverage data to the console. Test coverage for p5.js is mainly for monitoring and having some additional data points; having 100% test coverage is not a goal. - -And that covers the default task in the Gruntfile.js configuration! +This command performs: +- Linting via ESLint +- Unit tests using Vitest +- Visual tests (render-based snapshots) +Tests are located in the `test/unit` folder, organized to mirror the `src` directory structure. For example, tests for `src/color/p5.Color.js` live in `test/unit/color/p5.Color.js`. -### Miscellaneous tasks - -All of the steps can be run directly with `npx grunt [step]`. There are also a few tasks that are not covered above but could be useful in certain cases. +To run tests interactively in a browser-like environment (useful for debugging), run: ``` -grunt yui:dev +npx vitest --ui ``` -This task will run the documentation and library builds described above, followed by spinning up a web server that serves a functionally similar version of the reference page you will find on the website on [http://localhost:9001/docs/reference/](http://localhost:9001/docs/reference/). It will then monitor the source code for changes and rebuild the documentation and library. - -`grunt` `yui:dev` is useful when you are working on the reference in the inline documentation because you don't have to move built files from the p5.js repository to a local p5.js-website repository and rebuild the website each time you make a change, and you can just preview your changes with this slightly simplified version of the reference in your browser. This way, you can also be more confident that the changes you made are likely to show up correctly on the website. Note that this is only meant for modifications to the inline documentation; changes to the reference page itself, including styling and layout, should be made and tested on the website repository. +Code coverage is also supported using Vitest's built-in tools. Run: ``` -grunt watch -grunt watch:main -grunt watch:quick +npx vitest run --coverage ``` -The watch tasks will watch a series of files for changes and run associated tasks to build the reference or the library according to what files have changed. These tasks all do the same thing, with the only difference being the scope. - -The `watch` task will run all builds and tests similar to running the full default task on detecting changes in the source code. - -The `watch:main` task will run the library build and tests but not rebuild the reference on detecting changes in the source code. - -The `watch:quick` task will run the library build only on detecting changes in the source code. - -Depending on what you are working on, choosing the most minimal watch task here can save you from having to manually run a rebuild whenever you want to make some changes. - ---- - +**Note:** The Browserify/Grunt build pipeline (e.g., `browserify`, `uglify`, `brfs-babel`) was removed in v2. ## Release process @@ -443,4 +387,3 @@ By watching a repo, events such as new issues, new pull requests, mentions of yo In some cases, you may receive emails from GitHub about events in the repo you are watching as well, and you can customize these (including unsubscribing from them completely) from your [notifications settings page](https://github.com/settings/notifications). Setting these up to fit the way you work can be the difference between having to find relevant issues/PRs to review manually and being overwhelmed by endless notifications from GitHub. A good balance is required here. As a starting suggestion, stewards should watch this repo for "Issues" and "Pull Requests" and set it to only receive emails on "Participating, @mentions and custom." -