@meludi/eslint-config-react

This package provides ESLint settings as an shareable react eslint configuration.

Installation

Install the package with:

$ npm i -D @meludi/eslint-config-react

Find out and install peerDependencies.

$ npm info "@meludi/eslint-config-react@latest" peerDependencies

Entry points

• @meludi/eslint-config-react
• @meludi/eslint-config-react/hooks
• @meludi/eslint-config-react/a11y

Usage

If you did not already have .eslintrc.js configuration file in the root of your project create them.

Add the following to your .eslintrc.js:

// .eslintrc.js
module.exports = {
  root: true,

  extends: [
    '@meludi/eslint-config-react',

    // optional
    '@meludi/eslint-config-react/hooks',
    '@meludi/eslint-config-react/a11y',
  ],

  // Adjust it to your project
  // https://eslint.org/docs/latest/use/configure/language-options#specifying-environments
  env: {
    browser: true,
    es6: true,
    node: true,
  },

  // optional
  // https://www.npmjs.com/package/eslint-import-resolver-custom-alias
  settings: {
    'import/resolver': {
      'eslint-import-resolver-custom-alias': {
        alias: {
          '@': './src',
        },
      },
    },
  },
};

NPM script

Add the following script to your package.json for easy usage:

"scripts": {
  "lint:js": "eslint './**/*.{js,jsx}'",
  "lint:js:fix": "npm run lint:js -- --fix"
}

Configuration

You can overwrite, extend and unset rules in your .eslintrc.js

Configuring ESLint

Recommendation

Use prettier to format your files: @meludi/eslint-config-prettier

Add the following config files to the root of your project:

• .eslintignore
• .editorconfig

VS Code

Copy .vscode.example to the root of your project and rename it to .vscode.

LICENSE

MIT