@marvinroger/dev-core v1.11.0

Marvin ROGER's JS dev core

This module provides tooling to lint, format, test and write JS modules.

It makes use of the following stack:

• Prettier for code style linting and formatting
• ESLint for TS linting
• Jest for testing
• TypeDoc for documentation generation
• Husky / lint-staged for Git hooks
• Commitizen / commitlint for Git commit messages (Conventional Commits format)
• Standard Version for release versioning and CHANGELOG generation

Install

yarn global add @marvinroger/dev-core

Then, inside a blank Node.js project, run dev-core init. This will install the stack, and add the correct scripts inside the package.json.

Installed scripts

yarn lint

Lint the code with Prettier and ESLint, trying to fix what's fixable.

yarn test

Test the code with Jest.

yarn generate-docs

Generate the HTML docs from the TypeScript code, into the docs/ directory.

yarn commit

Commit with a Conventional Commits compatible format.

yarn release

Bump package.json according to the commits, update CHANGELOG.md and tag a new release.

Note: Due to a TypeDoc restriction, every single exported method will be documented (even if not exported from the entry-point). To ignore such methods, add a @hidden annotation.