To make use of this config, install ESLint (>= 2.0) and this package as a development dependency of your project:
npm install eslint eslint-config-planet --save-dev
Next, add an
eslintConfig member to your project's
package.json. 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
package.json 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-planet package includes a number of ESLint configuration profiles for different types of projects.
Example configuration in
planet/react config is suitable for projects using React. This extends the base config to include the React plugin, enable JSX parsing, and run React specific rules. To use this profile, you'll need to install the
npm install eslint-plugin-react --save-dev
Then your minimal configuration in
package.json would look like this:
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
© Planet Labs, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.