@clipboard-health/eslint-plugin

Clipboard's ESLint plugin.

Table of contents

• Install
• Local development commands

Install

[!NOTE] Take a look at our eslint-config which contains this plugin. In most cases you can just use the eslint-config instead of directly installing this plugin.

npm install -D @clipboard-health/eslint-plugin

Then, modify your .eslintrc.js file to configure individual rules in this plugin:

module.exports = {
  plugins: ["@clipboard-health"],
  overrides: [
    {
      files: ["**/*.controller.ts", "**/*.controllers.ts"],
      rules: {
        "@clipboard-health/enforce-ts-rest-in-controllers": "error",
      },
    },
  ],
  root: true,
};

Local development commands

See package.json scripts for a list of commands.