To make use of this config, install ESLint and this package as a development dependency of your project:
npm install eslint eslint-config-openlayers --save-dev
Next, create a
.eslintrc file at the root of your project. At a minimum, this config file must include an
See the ESLint configuration guide for details on additional configuration options. Any rules configured in your
.eslintrc file will override those provided by the
pretest entry in your
src directory of your project using your
.eslintrc config when tests are run:
See the ESLint CLI guide for additional options when running ESLint.
In addition to running the linter when your tests are run, you should configure your editor to run the linter as well. See the ESLint integration page to find details on configuring your editor to warn you of ESLint errors.
See the examples directory for more usage examples.
eslint-config-openlayers package includes a number of ESLint configuration profiles for different types of projects.
To add another configuration profile, add a new config script to the root of the repository directory (e.g.
new-config.js). This script should export an ESLint config object and should have an
extends: './index.js' property. People using this config will add
extends/new-config to their own ESLint config.
You should add and example for your new profile and ensure that tests pass with any changes.
After adding a new config profile or modifying an existing one, publish a new version of the package. Adding a new "error" level rule constitutes a major release. A new profile or non-breaking modification to an existing profile (e.g. a "warning" level rule) can be a minor release.
Publishing a new minor release would look like this:
# commit and push any changes first npm version minor # this bumps the package.json version number and tags git push --tags origin master npm publish