Skip to content

ridi/eslint-config

Repository files navigation

@ridi/eslint-config

npm version
A rule set of RIDI's ESLint configurations based on Airbnb's.

Installation

Install @ridi/eslint-config package:

  1. Install the correct versions of each package, which are listed by the command:
npm info "@ridi/eslint-config" peerDependencies

if using npm 5+, use this shortcut

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

if using yarn, use this command

yarn add --peer --dev @ridi/eslint-config
  1. Install via package manager:
npm install --save-dev @ridi/eslint-config

or

yarn --dev @ridi/eslint-config

Usage

Javascript

module.exports = {
  extends: [
    '@ridi/eslint-config'
  ]
}

@ridi/eslint-config/typescript

  • @typescript-eslint/eslint-plugin
  • typescript

Typescript

module.exports = {
  extends: [
    '@ridi/eslint-config',
    '@ridi/eslint-config/typescript'
  ]
}

@ridi/eslint-config/react

  • eslint-plugin-import
  • eslint-plugin-jsx-a11y
  • eslint-plugin-react
  • eslint-plugin-react-hooks

Javascript + React

{
  "extends": [
    '@ridi/eslint-config',
    '@ridi/eslint-config/react',
  ],
}

Typescript + React

module.exports = {
  extends: [
    '@ridi/eslint-config',
    '@ridi/eslint-config/typescript',
    '@ridi/eslint-config/react'
  ]
}

@ridi/eslint-config/prettier

  • eslint-plugin-prettier

Prettier

works fine with local configuration file (e.g. .prettierrc)

{
  "extends": [
    '@ridi/eslint-config',
    '@ridi/eslint-config/prettier',
  ],
}