@arquivei/eslint-config

---

!Build Statusbuild-badgebuild !versionversion-badgepackage !downloadsdownloads-badgenpmtrends !MIT Licenselicense-badgelicense !All Contributorsall-contributors-badge !PRs Welcomeprs-badgeprs !Code of Conductcoc-badgecoc

Table of Contents

• Installation
• Usage

- Other configs

• Issues

- 🐛 Bugs - 💡 Feature Requests

• Contributors ✨
• LICENSE

Installation

This module is distributed via npmnpm which is bundled with nodenode 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 eslinteslint
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 Issuegood-first-issue label.

🐛 Bugs

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

💡 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 Requestsrequests

Contributors ✨

Thanks goes to these people (emoji keyemojis):

<td align="center"><a href="https://github.com/hugo-marcelo"><img src="https://avatars.githubusercontent.com/u/26742187?v=3" width="100px;" alt=""/><br /><sub><b>Hugo Silva</b></sub></a><br /><a href="https://github.com/arquivei/arquivei-tools/commits?author=hugo-marcelo" title="Code">💻</a> <a href="https://github.com/arquivei/arquivei-tools/commits?author=hugo-marcelo" title="Documentation">📖</a> <a href="#infra-arquivei" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
<td align="center"><a href="https://github.com/gabrielferreiraa"><img src="https://avatars.githubusercontent.com/u/17201177?v=3" width="100px;" alt=""/><br /><sub><b>Gabriel Ferreira</b></sub></a><br /><a href="https://github.com/arquivei/arquivei-tools/commits?author=gabrielferreiraa" title="Code">💻</a> <a href="https://github.com/arquivei/arquivei-tools/commits?author=gabrielferreiraa" title="Documentation">📖</a><a href="#infra-arquivei" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
<td align="center"><a href="https://github.com/marcusmourao"><img src="https://avatars.githubusercontent.com/u/12806522?v=3" width="100px;" alt=""/><br /><sub><b>Marcus Mourão</b></sub></a><br /><a href="https://github.com/arquivei/arquivei-tools/commits?author=marcusmourao" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/victorlacorte"><img src="https://avatars.githubusercontent.com/u/1683634" width="100px;" alt=""/><br /><sub><b>Victor Lacorte</b></sub></a><br /><a href="https://github.com/arquivei/arquivei-tools/commits?author=victorlacorte" title="Code">💻</a></td>

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

LICENSE

MIT