Skip to content

ardalanamini/eslint-config-noir

Repository files navigation

eslint-config-noir

Test Npm Version License Pull Requests Known Vulnerabilities Npm Total Downloads Npm Monthly Downloads Github Stars Github Forks

Noir ESLint shareable config.

Installation

You'll first need to install ESLint:

npm i -D eslint

Next, install eslint-config-noir:

npm i -D eslint-config-noir

Usage

Add noir to the extends section of your .eslintrc configuration file. You can omit the eslint-config- prefix:

{
  "extends": [
    "eslint:recommended",
    "noir"
  ]
}

With Import support:

You'll first need to install Import ESLint Plugin.

{
  "extends": [
    "eslint:recommended",
    "noir",
    "plugin:@typescript-eslint/recommended",
    "plugin:import/recommended",
    "noir/import"
  ]
}

With TypeScript support:

You'll first need to install TypeScript ESLint.

{
  "extends": [
    "eslint:recommended",
    "noir",
    "plugin:@typescript-eslint/recommended",
    "noir/typescript"
  ]
}

Or all of the configs at once:

{
  "extends": "noir/all"
}