ESLint Configurations

This package contains eslint configurations which I tend to re-use across projects. Each is an extension of existing configurations and plugins which are listed below.

Installation

Install the package by issuing:

  npm install @sun33t/eslint-config --save-dev

  // or

  yarn add -D @sun33t/eslint-config

Peer Dependencies

In accordance with ESLint documentation, the elsint plugins which this package consumes are registered as peer-dependencies, and as such, they will need to be installed in addition to the package. Currently those peerDeps are the following:

 "peerDependencies": {
    "eslint-plugin-import": "2.22.1",
    "eslint-plugin-jsx-a11y": "6.4.1",
    "eslint-plugin-react": "7.21.5",
    "eslint-plugin-react-hooks": "4"
  },

Usage/Examples

Within your eslintrc file, add this package as the last item in your extends array:

{
  "extends": [
    "existing configs...",
    "@sun33t/eslint-config/[path-to-config-file]"
  ]
}

Configurations

Default - This is the eslint-config-airbnb for react + node, which also included eslint-config-prettier. It can be added as follows:

{
  "extends": ["existing configs...", "@sun33t"]
}
// or
{
  "extends": ["existing configs...", "@sun33t/eslint-config"]
}

NextJS - JavaScript - This is the same configuration as above, but with some modification specific to NextJS projects which I create in JavaScript

{
  "extends": ["existing configs...", "@sun33t/eslint-config/javascript/next"]
}

Authors

• @sun33t

Feedback

If you have any feedback, please reach out to us at [email protected]

Acknowledgements

• ESLint Shareable Configs
• eslint-config-airbnb
• eslint-config-prettier