@nx-pkg/eslint-plugin NPM

@nx-pkg/eslint-plugin

An ESLint plugin to enforce a consistent code styles across NxPKG projects

Installation

You'll first need to install ESLint:

$ yarn add -D eslint

Next, install @nx-pkg/eslint-plugin:

$ yarn add -D @nx-pkg/eslint-plugin

Note: If you installed ESLint globally (using the -g flag) then you must also install @nx-pkg/eslint-plugin globally.

Usage

Add @nx-pkg/eslint-plugin to the extends section of your .eslintrc.js or .eslintrc.json configuration file and and configure parser and parserOptions. For the plugin, you can omit the eslint-plugin-:

{
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "ecmaVersion": 2019,
    "sourceType": "module",
    "ecmaFeatures": {
      "modules": true
    }
  },
  "extends": ["plugin:@nx-pkg/recommended"]
}

Custom Rules

eslint eslint-plugin nxpkg

@typescript-eslint/eslint-plugin @typescript-eslint/parser @typescript-eslint/utils common-tags eslint eslint-config-prettier eslint-plugin-jsonc eslint-plugin-prettier

0.0.42

1 year ago