@swan-bitcoin/eslint-config v0.0.2

@swan-bitcoin/eslint-config

This package includes a shareable ESLint config for Swan projects.

Installation

First, install this package along with ESLint in your project. This package requires at least version 8.1 of ESLint

npm install -D eslint @swan-bitcoin/eslint-config

Then create a file named .eslintrc in the root of your project:

{
  "extends": "@swan-bitcoin/eslint-config"
}

Optionally, for node only environments that do not require React you can extend @swan-bitcoin/eslint-config/node

Jest + Testing Library

This packages also ships with optional configuration options for projects that use Jest with Testing Library. To enable these rules, add the following to your .eslintrc:

{
  "extends": [
    "@swan-bitcoin/eslint-config",
    "@swan-bitcoin/eslint-config/jest-testing-library"
  ]
}

Please note that because this ruleset is optional, we do not include the core libraries as peer dependencies for this package. If you use these rules, be sure that you have the following dependencies installed in your project:

{
  "@testing-library/jest-dom": ">=5.16.0",
  "@testing-library/react": ">=12.0.0",
  "jest": ">=26.0.0"
}

Optionally, for node only environments that do not require React you can extend @swan-bitcoin/eslint-config/jest