@readme/eslint-config NPM

@readme/eslint-config

Core coding standards for ReadMe projects.

Installation

You'll need to install ESLint and Prettier into your project. Use this shortcut to install them alongside the config (if using npm 5+):

npx install-peerdeps --dev @readme/eslint-config

If you already have eslint and prettier installed in your project you run this command to install the config:

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

Usage

Create a .eslintrc file with the following contents:

{
  "extends": [
    "@readme/eslint-config"
  ]
}

Configs

Config	Description
`@readme/eslint-config`	Rules for a pure JS codebase.

Specialties

Note If you use one, or both of these, you should also extend @readme/eslint-config.

Config	Description
`@readme/eslint-config/esm`	Rules for ESM codebases.
`@readme/eslint-config/react`	Rules for codebases that use React.
`@readme/eslint-config/typescript`	Rules for a TS codebase.

Unit testing

Config	Description
`@readme/eslint-config/testing/jest`	Rules specific to the Jest test runner.
`@readme/eslint-config/testing/jest-dom`	Jest-specific rules for when testing, and using jest-dom. Automaticaly imports `@readme/eslint-config/testing/jest`.
`@readme/eslint-config/testing/react`	Rules specific to React codebases where you use @testing-library/react. Is specific to neither Jest or Vitest.
`@readme/eslint-config/testing/vitest`	Rules specific to the Vitest test runner.

Prettier

Included in this is our shared Prettier config. You can use it in your application by adding the following to your package.json:

"prettier": "@readme/eslint-config/prettier"

@infinitebrahmanuniverse/nolb-_read @everything-registry/sub-chunk-768 @zalastax/nolb-_read

8 months ago

5 months ago

9 months ago

8 months ago

5 months ago

8 months ago

6 months ago

6 months ago

8 months ago

8 months ago

8 months ago

5 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago