eslint-plugin-etc's Introduction

eslint-plugin-etc

This repo is a WIP.

Eventually, it will contain ESLint versions of the rules in the tslint-etc package.

Install

Install the ESLint TypeScript parser using npm:

npm install @typescript-eslint/parser --save-dev

Install the package using npm:

npm install eslint-plugin-etc --save-dev

Configure the parser and the parserOptions for ESLint. Here, I use a .eslintrc.js file for the configuration:

const { join } = require("path");
module.exports = {
  parser: "@typescript-eslint/parser",
  parserOptions: {
    ecmaVersion: 2019,
    project: join(__dirname, "./tsconfig.json"),
    sourceType: "module"
  },
  plugins: ["etc"],
  extends: [],
  rules: {
    "etc/no-t": "error"
  }
};

Rules

The package includes the following rules:

Rule	Description	Recommended
`ban-imports`	Forbids using the configured import locations.	TBD
`deprecation`	Forbids the use of deprecated APIs.	TBD
`no-assign-mutated-array`	Forbids the assignment of returned, mutated arrays.	TBD
`no-const-enum`	Forbids the use of `const enum`. Constant enums are not compatible with isolated modules.	TBD
`no-enum`	Forbids the use of `enum`.	TBD
`no-implicit-any-catch`	Like the `no-implicit-any-catch` rule in `@typescript-eslint/eslint-plugin`, but for `Promise` rejections instead of `catch` clauses.	TBD
`no-t`	Forbids single-character type parameters.	TBD
`no-unused-declaration`	Forbids unused declarations.	TBD
`throw-error`	Forbids throwing - or rejecting with - non-`Error` values.	TBD

Recommend Projects