Skip to content

geosense/eslint-config-cleerio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

eslint-config-cleerio

This package provides Cleerio's .eslintrc as an extensible shared config. It was forked from eslint-config-airbnb.

Usage

We export three ESLint configurations for your usage.

eslint-config-cleerio

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

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

eslint-config-cleerio/base

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

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

eslint-config-cleerio/legacy

Lints ES5 and below. Only requires eslint.

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

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

Improving this config

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.