Skip to content

ESLint configuration for JobTeaser projects.

License

Notifications You must be signed in to change notification settings

jobteaser/eslint-config-jobteaser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

eslint-config-jobteaser

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

Usage

We export three ESLint configurations for your usage.

eslint-config-jobteaser

Our default export contains all of our ESLint rules, including ECMAScript 6+ and React. It requires eslint, eslint-plugin-import, eslint-plugin-react, and eslint-plugin-jsx-a11y. It extends good eslint-config-airbnb configuration file.

If you use yarn, run npm info "eslint-config-jobteaser@latest" peerDependencies to list the peer dependencies and versions, then run yarn add --dev <dependency>@<version> for each listed peer dependency. See below for npm instructions.

  1. Install the correct versions of each package, which are listed by the command:
npm info "eslint-config-jobteaser@latest" peerDependencies

Linux/OSX users can run

(
  export PKG=eslint-config-jobteaser;
  npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest"
)

Which produces and runs a command like:

npm install --save-dev eslint-config-jobteaser eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.#

Windows users can either install all the peer dependencies manually, or use the install-peerdeps cli tool.

npm install -g install-peerdeps
install-peerdeps --dev eslint-config-jobteaser

The cli will produce and run a command like:

npm install --save-dev eslint-config-jobteaser eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.#
  1. Add "extends": "jobteaser" to your .eslintrc

for more information.

Improving this config

  • You can make sure this module lints with itself using npm run lint.
  • if you want to add a new rule, open an issue to discuss it.