README.md

eslint-config-ibmresearch

ESLint shareable config for the IBM Research JavaScript style guide.

Installation

JavaScript

npm install --save-dev eslint eslint-config-ibmresearch prettier

TypeScript

npm install --save-dev eslint eslint-config-ibmresearch prettier @typescript-eslint/eslint-plugin @typescript-eslint/parser

TypeScript (with Lit)

npm install --save-dev eslint eslint-config-ibmresearch prettier @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-lit eslint-plugin-wc eslint-plugin-lit-a11y

Usage

Once the eslint-config-ibmresearch package is installed, you can use it by specifying ibmresearch, ibmresearch/typescript or ibmresearch/typescript-lit in the extends section of your ESLint configuration.

{
  "extends": "ibmresearch",
  "rules": {
    // Additional, per-project rules...
  }
}