Forked from Airbnb's Style Guide

This package provides HubSpot's .eslintrc as an extensible shared config.

We export three ESLint configurations for your usage.

Our default export contains all of our ESLint rules, including EcmaScript 6+ and React, but excludes experimental features. It requires eslint and eslint-plugin-react.

1. npm install --save-dev eslint-config-hubspot eslint-plugin-react eslint
2. add "extends": "hubspot" to your .eslintrc

Lints ES6+ but does not lint React. Requires eslint.

1. npm install --save-dev eslint-config-hubspot eslint
2. add "extends": "hubspot/base" to your .eslintrc

Lints EcmaScript 6+, React, and ES6/7 experimental features. It requires eslint, eslint-plugin-react, eslint-plugin-babel, and babel-eslint.

1. npm install --save-dev eslint-config-hubspot eslint-plugin-react eslint-plugin-babel babel-eslint eslint
2. add "extends": "hubspot/experimental" to your .eslintrc

Lints ES5 and below. Only requires eslint.

1. npm install --save-dev eslint-config-hubspot eslint
2. add "extends": "hubspot/legacy" to your .eslintrc

See HubSpot's Javascript styleguide and the ESlint config docs for more information.

Consider adding test cases if you're making complicated rules changes, like anything involving regexes. Perhaps in a distant future, we could use literate programming to structure our README as test cases for our .eslintrc?

You can run tests with npm test.

You can make sure this module lints with itself using npm run lint.