[![Codecov](https://img.shields.io/codecov/c/github/ehmicky/gulp-shared-tasks.svg?label=tested&logo=codecov)](https://codecov.io/gh/ehmicky/gulp-shared-tasks) [![Travis](https://img.shields.io/badge/cross-platform-4cc61e.svg?logo=travis)](https://travis-ci.org/ehmicky/gulp-shared-tasks) [![Node](https://img.shields.io/node/v/gulp-shared-tasks.svg?logo=node.js)](https://www.npmjs.com/package/gulp-shared-tasks) [![Gitter](https://img.shields.io/gitter/room/ehmicky/gulp-shared-tasks.svg?logo=gitter)](https://gitter.im/ehmicky/gulp-shared-tasks) [![Twitter](https://img.shields.io/badge/%E2%80%8B-twitter-4cc61e.svg?logo=twitter)](https://twitter.com/intent/follow?screen_name=ehmicky) [![Medium](https://img.shields.io/badge/%E2%80%8B-medium-4cc61e.svg?logo=medium)](https://medium.com/@ehmicky) Automated tasks (linting, testing, building) for a Node.js development workflow using [Babel](https://babeljs.io/), [ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [Jscpd](https://github.com/kucherenko/jscpd), [Ava](https://github.com/avajs/ava), [Travis](https://travis-ci.org/), [nyc](https://github.com/istanbuljs/nyc) and [codecov](https://codecov.io/). The task runner is [Gulp](https://gulpjs.com/), but you don't need to know Gulp to use these tasks. # Workflow Code is compiled from the `src` to the `build` directory using [Babel](https://babeljs.io/), so you can use the latest JavaScript features. Linting and formatting are performed with [ESLint](https://eslint.org/), [Prettier](https://prettier.io/) and [Jscpd](https://github.com/kucherenko/jscpd). We recommend using plugins with your IDE (code editor) for both Prettier and ESLint so that linting/formatting is performed as you code. We use [Ava](https://github.com/avajs/ava) to run tests. Each line of code must be tested. # Usage Any task can be run using `gulp` for example: ```bash gulp build ``` If you're on `cmd.exe` (Windows) use `npx gulp ...` instead. # Overview The main commands are: - [`gulp check`](#gulp-check): lint/format the JavaScript files. - [`gulp build`](#gulp-build): build source files and test files. Must be run before running any code or unit tests. - [`gulp unit`](#gulp-unit): run unit tests. - [`gulp test`](#gulp-test): perform the three tasks above. Use `gulp checkw`, `gulp buildw` and `gulp unitw` to run them in watch mode. [Travis CI](https://travis-ci.org/) ensures that: - tests pass on all supported environments. - all source files are covered by tests and follow the same coding style. # Available tasks ## `gulp check` Lint and check source files: - format JavaScript files with [Prettier](https://prettier.io/). - lint and [autofix](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) JavaScript files using [ESLint](https://eslint.org/) (see the [coding style](https://github.com/ehmicky/eslint-config#coding-style)). - find duplicated code with [Jscpd](https://github.com/kucherenko/jscpd). This is automatically triggered before any `git push`. ## `gulp build` Build source files and test files: - JavaScript files are transpiled with [Babel](https://babeljs.io/). - Other files are copied as is. Source files are built from the `src` directory to the `build/src` directory. Test files are built from the `test` directory to the `build/test` directory. This must be done before running any code or unit tests. ## `gulp unit` Run unit tests with [Ava](https://github.com/avajs/ava). To specify [Ava options](https://github.com/avajs/ava/blob/master/docs/05-command-line.md), please call `ava` directly instead. For example: `ava --update-snapshots`. To target a single test file, use `ava build/test/file.js` not `ava test/file.js`. Test coverage is performed in CI ([Travis](https://travis-ci.org/)) and uploaded to [codecov](https://codecov.io/). It can also be performed locally using `nyc ava`. ## `gulp test` Runs [`gulp check`](#gulp-check) then [`gulp build`](#gulp-build) then [`gulp unit`](#gulp-unit). This is performed on CI ([Travis](https://travis-ci.org/)) for each OS (Windows, Mac, Linux) and supported Node.js version. ## `gulp checkw`, `gulp buildw`, `gulp unitw`, `gulp warnw` Like `gulp check`, `gulp build`, `gulp unit` and `gulp warn` but in watch mode. The watch mode works even when installing/updating/uninstalling dependencies or changing the Gulp tasks themselves. They can be performed together, e.g. `gulp buildw` in one terminal tab and `gulp unitw` in another. # Other tasks ## `gulp warn` Check for security vulnerabilities (using [`npm audit`](https://docs.npmjs.com/cli/audit)) and outdated dependencies (using [`npm outdated`](https://docs.npmjs.com/cli/outdated)). ## `gulp releasePatch`, `gulp releaseMinor`, `gulp releaseMajor` Release a new patch/minor/major version on npm and GitHub using [`release-it`](https://github.com/webpro/release-it). The new version will only be published to npm after CI tests have passed. Only the repository owner can perform these tasks. ## `gulp coverage` Ensures that files are fully covered by tests using [nyc](https://github.com/istanbuljs/nyc). This is meant to be performed on CI ([Travis](https://travis-ci.org/)). # Custom tasks Repositories with a `gulp` top-level directory have additional tasks. Please check those files to see which custom tasks are available. # Support If you found a bug or would like a new feature, _don't hesitate_ to [submit an issue on GitHub](../../issues). For other questions, feel free to [chat with us on Gitter](https://gitter.im/ehmicky/gulp-shared-tasks). Everyone is welcome regardless of personal background. We enforce a [Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and inclusive environment. # Contributing This project was made with ❤️. The simplest way to give back is by starring and sharing it online. If the documentation is unclear or has a typo, please click on the page's `Edit` button (pencil icon) and suggest a correction. If you would like to help us fix a bug or add a new feature, please check our [guidelines](CONTRIBUTING.md). Pull requests are welcome!
ehmicky
ehmicky
💻 🎨 🤔 📖