JavaScript Style Resources

This repository includes a written style guide and lint configurations for various environments. It also includes a test runner that verifies the style guide against lint rules.

Using Lint Configurations in Your Project

To use one of the lint configurations in this repository, first install this module as well as eslint:

npm install --save-dev eslint eslint-config-apm

Then, add a .eslintrc file to the root of your project and extend the lint configuration:

extends: 'apm'

You can use JSON or YAML.

To extend a configuration other than the root, add the configuration's path to the module name:

extends: 'apm/es6'

TODO notes on overriding rules / extending

For more info, see the eslint guide to shareable configurations.

Running Tests

Install all dependencies with npm install and then run tests with npm test.

The test runner verifies that positive examples contain no lint errors and that negative examples violate the rule they specify (but no other rules). Negative examples that do not contain a rule are not checked, as they likely do not have a corresponding lint rule.