README
🌹 @sharyn/eslint-config
You can use this package as a standalone, but I recommend following the development setup tutorial to also install Babel, Flow, Jest, React, and their ESLint-related plugins.
🌹 Install
Minimal install:
yarn add --dev @sharyn/eslint-config eslint
Add to your package.json
:
"eslintConfig": {
"extends": "@sharyn"
},
🌹 Auto-configured Modules
The following supported modules are automatically configured for ESLint if they are detected in your package.json
:
- @babel/plugin-proposal-do-expressions – To use
do { }
expressions - @babel/plugin-proposal-nullish-coalescing-operator – To use
isUndef ?? 'default'
- @babel/plugin-proposal-optional-chaining – To use
isUndef?.property
- @babel/plugin-proposal-pipeline-operator – To use
'hello' |> console.log
- babel-eslint – Used to parse Flow and the new Babel syntax proposals
- eslint-config-airbnb – ESLint configuration by Airbnb (with React rules)
- eslint-config-airbnb-base – ESLint configuration by Airbnb (without React rules)
- eslint-config-prettier – Disables ESLint rules conflicting with Prettier
- eslint-import-resolver-babel-module@5.0.0-beta.0 – For ESLint to use
babel-plugin-module-resolver
- eslint-plugin-import – Add support for
import
syntax to ESLint, and import rules - eslint-plugin-jsx-a11y – ESLint rules for JSX and accessibility
- eslint-plugin-react – ESLint rules for React
- eslint-plugin-flowtype – ESLint rules for Flow annotations
- eslint-plugin-prettier – Show Prettier errors in ESLint
- flow-bin – Flow (type checker) core library and CLI
- jest – Jest (test runner) core library and CLI
- jest-puppeteer – Jest preset for Puppeteer
- react – React and JSX core
See the implementation.