eslint-config-janedeprecated

Deprecated: use eslint-plugin-jane.

Usage no npm install needed!

<script type="module">
  import eslintConfigJane from 'https://cdn.skypack.dev/eslint-config-jane';
</script>

README

eslint-config-jane

Deprecated

Use eslint-plugin-jane.

Shared eslint config for front-end projects at Jane.

Installation

npm i -D eslint-config-jane

You'll also need to install some plugins (peerDependencies), at least until there's some sort of resolution for this issue:

npm i -D babel-eslint eslint-plugin-babel eslint-plugin-promise eslint-plugin-import eslint-plugin-unicorn.

Optionally, you can also install any or all of:

  • eslint-plugin-jest
  • eslint-plugin-jsx-a11y
  • eslint-plugin-prettier
  • eslint-plugin-react

If they're installed, their rules will be used. If eslint-plugin-prettier is installed, our style rules are removed.

Usage

.eslintrc

{
  "root": true,
  "extends": "eslint-config-jane"
  // any custom configs
}

.prettierrc.js

module.exports = require('eslint-config-jane/prettier')

Notes

Our rules are heavily based on Standard.

Most rules only warn. Exceptions (rules that error):

  • comma-dangle: es5 compatible
  • eol-last
  • indent: 2, SwitchCase 1
  • new-cap: newIsCap true, capIsNew false
  • no-duplicate-imports
  • no-eval
  • no-extend-native
  • no-global-assign
  • no-mixed-tabs-and-spaces
  • no-tabs
  • no-undef
  • no-undef-init
  • no-with
  • quotes: single, avoidEscape true
  • unicode-bom: never
  • unicorn/filename-case: kebab

LICENSE

MIT