@readme/eslint-config

14.0.0 • Public • Published

@readme/eslint-config

Core coding standards for ReadMe projects.

npm Build

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"

Readme

Keywords

none

Package Sidebar

Install

npm i @readme/eslint-config

Weekly Downloads

2,634

Version

14.0.0

License

ISC

Unpacked Size

31.1 kB

Total Files

16

Last publish

Collaborators

  • gratcliff
  • dannobytes
  • gkoberger
  • domharrington
  • mjcuva
  • kanadgupta
  • jonursenbach
  • rafegoldberg
  • dashron
  • iliast