Table of Contents

• Installation
• Usage
  • Other configs
• Issues
  • 🐛 Bugs
  • 💡 Feature Requests
• Contributors ✨
• LICENSE

Installation

This module is distributed via npm which is bundled with node and should be installed as one of your project's devDependencies:

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

This library has a required peerDependencies listing for eslint

Note: If you are working with a registry other than the standard npm, it becomes necessary to pass the argument: --registry=https://registry.npmjs.org/ at installation.

Usage

Then add the extends to your .eslintrc.js:

module.exports = {
  extends: '@arquivei/eslint-config',
  rules: {
    // your overrides
  },
}

Other configs

This config also exposes a few other configs that I use often and pull in as needed.

You can use them standalone:

module.exports = {
  extends: '@arquivei/eslint-config/<config-name>',
}

Or in combination with the base config (recommended)

module.exports = {
  extends: ['@arquivei/eslint-config', '@arquivei/eslint-config/<config-name>'],
}

Example of config

module.exports = {
  extends: [
    '@arquivei/eslint-config',
    '@arquivei/eslint-config/jest',
    '@arquivei/eslint-config/react',
  ],
  rules: {
    /* custom rules */
  },
}

If you're using Next.js

Example of config

module.exports = {
  extends: [
    '@arquivei/eslint-config',
    '@arquivei/eslint-config/jest',
    '@arquivei/eslint-config/react',
    '@arquivei/eslint-config/next-js',
  ],
  rules: {
    /* custom rules */
  },
}

And add the command to section scripts on the package.json of your project

"lint:next": "next lint"

Issues

Looking to contribute? Look for the Good First Issue label.

🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

See Bugs

💡 Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.

See Feature Requests

Contributors ✨

Thanks goes to these people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

LICENSE

MIT