@bitovi/eslint-plugin-nx-glue

ESLint Plugin Nx Glue

Allows local ESLint Rules written in TypeScript to be available within a Nx workspace or any project. This means that developers can create their own custom ESLint Plugins within a project and consume them within that project without having to publish or use Symlinks.

Installation

npm install -D @bitovi/eslint-plugin-nx-glue

This library assumes your project is an Nx workspace. If you are not, you will have to also install nx as a dev-dependency:

npm install -D nx@15

How to Use

Create an eslint-plugin-nx-glue.config.js file at the root of your project. This file will export your ESLint Plugins by name, a path to its exported rules, and which TypeScript configuration to use:

// eslint-plugin-nx-glue.config.js

module.exports = {
  'my-plugin': {
    dir: 'tools/my-rules',
    tsconfig: 'tools/my-rules/tsconfig.json',
  },
};

This example will check tools/my-rules for index.ts that exports an ESLint Plugin:

// tools/my-rules/index.ts

import { myCustomRule} from './rules/my-custom-rule';
import { mySecondCustomRule } from './rules/my-second-custom-rule';

module.exports = {
  rules: {
    'some-custom-rule-name': myCustomRule,
    'another-custom-rule-name': mySecondCustomRule,
  },
};

Now you can include these rules into your eslint configuration by adding @bitovi/nx-glue to your plugins and listing which rules you want to use within overrides:

// .eslintrc

{
  "plugins": ["@bitovi/nx-glue"],
  "overrides": [
    {
      "files": ["*.ts"],
      "rules": {
        "@bitovi/nx-glue/my-plugin/some-custom-rule-name": "error",
        "@bitovi/nx-glue/my-plugin/another-custom-rule-name": "warn"
      }
    }
  ]
}

Configuration Schema

Listed below is a detailed explaination of how the eslint-plugin-glue configuration schema affects how you can consume your custom rules:

// eslint-plugin-nx-glue.config.js

module.exports = {
    '<plugin-name>': {
      dir: 'path/to/rules/from/root/of/project',
      tsconfig: 'path/to/tsconfig/from/root/of/project/tsconfig.json',
    },
    '<plugin-name-2>': {
      dir: 'path/to/rules/from/root/of/project',
      tsconfig: 'path/to/tsconfig/from/root/of/project/tsconfig.json',
    },
    // ...
};

Configuration schema:

1. plugin-name: Used to distinguish each plugin. This allows for plugins to have the same named rules within the same project.
2. dir: Path to index.ts from root of project. This is the location of the exported ESLint Plugin.
3. tsconfig: Path to TypeScript configuration from root of project.

This allows you to consume your custom rules exported by your local ESLint Plugins:

// .eslintrc

{
  "plugins": ["@bitovi/nx-glue"],
  "overrides": [
    {
      "files": ["..."],
      "rules": {
        "@bitovi/nx-glue/<plugin-name>/<custom-rule-name>": "...",
        "@bitovi/nx-glue/<plugin-name>/<custom-rule-name-2>": "...",
        "@bitovi/nx-glue/<plugin-name-2>/<another-custom-rule-name>": "..."
      }
    }
  ]
}

ESLint Extention

If you are using VSCode's ESLint extention, you will have to restart your ESLint server whenever you make changes to your ESLint Plugin(s). You can quickly restart your ESLint server by using the Command Palette and selecting ESLint: Restart ESLint Server.

Overriding Configuration Path

You can set path to your eslint-plugin-glue configuration by setting ESLINT_PLUGIN_GLUE_CONFIG_PATH environment variable. By default, eslint-plugin-glue configuration is expected to be at the root of your project and to be named eslint-plugin-glue.config.js.