build-tools-javascript v1.3.0

build-tools-javascript

Set of tools and configurations to work with JavaScript: linter and documentation.

• Linter: eslint runner and adidas linter configs.
• JavaScript documentation: based on jsdoc tool.

Install

npm install --save-dev build-tools-javascript

Usage

To use adidas linter configurations check https://github.com/adidas/js-linter-configs/tree/master/packages/eslint-config-adidas-es6.

To use jsdoc, create a jsdoc.config.js file with the following:

const jsdocConfig = require('build-tools-javascript/jsdoc.config.js');
const { name } = require('./package.json');

jsdocConfig.systemName = name;

module.exports = jsdocConfig;

Then you can run jsdoc, e.g:

npx jsdoc -r -c ./jsdoc.config.js -R ./README.md -d doc src/

Links

• Base configuration
• ESLint
• JSDoc