@ehmicky/dev-tasks

Automated development tasks for my own projects

Usage no npm install needed!

<script type="module">
  import ehmickyDevTasks from 'https://cdn.skypack.dev/@ehmicky/dev-tasks';
</script>

README

Codecov Build Node Twitter Medium

Automated development tasks (linting, testing, building) used in my own projects.

This is not meant to be shared and semantic versioning is not followed.

The task runner is Gulp, 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, so you can use the latest JavaScript features.

Linting and formatting are performed with ESLint, Prettier and 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 to run tests. Each line of code must be tested.

Usage

Any task can be run using gulp for example:

gulp build

If you're on cmd.exe (Windows) use npx gulp ... instead.

Overview

The main commands are:

  • gulp check: lint/format the JavaScript files.
  • gulp build: build source files and test files. Must be run before running any code or unit tests.
  • gulp unit: run unit tests.
  • gulp test: perform the three tasks above.

Use gulp checkw, gulp buildw and gulp unitw to run them in watch mode.

GitHub actions 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:

gulp build

Build source files and test files:

  • JavaScript files are transpiled with Babel.
  • 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.

To specify Ava options, 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.

gulp test

Runs gulp check then gulp build then gulp unit.

This is performed on CI (GitHub acitons) 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) and outdated dependencies (using npm outdated).

gulp releasePatch, gulp releaseMinor, gulp releaseMajor

Release a new patch/minor/major version on npm and GitHub using release-it.

npm publish must also be performed locally.

Only the repository owner can perform these tasks.

gulp uploadCoverage

In CI (GitHub actions), upload test coverage (produced by c8 ava) to codecov.

gulp checkCoverage

Ensures that files are fully covered by tests using c8. This is meant to be performed on CI (GitHub actions).

Custom tasks

Repositories with a gulp top-level directory have additional tasks. Please check those files to see which custom tasks are available.

Support

For any question, don't hesitate to submit an issue on GitHub.

Everyone is welcome regardless of personal background. We enforce a Code of conduct 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, please check our guidelines. Pull requests are welcome!

ehmicky
ehmicky
💻 🎨 🤔 📖