eslint-plugin-tyrecheck

Custom ESLint rules by Tyrecheck

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-tyrecheck:

npm install eslint-plugin-tyrecheck --save-dev

Usage

In your configuration file, import the plugin eslint-plugin-tyrecheck and add tyrecheck to the plugins key:

import tyrecheck from "eslint-plugin-tyrecheck";

export default [
    {
        plugins: {
            tyrecheck
        }
    }
];

Then configure the rules you want to use under the rules key.

import tyrecheck from "eslint-plugin-tyrecheck";

export default [
    {
        plugins: {
            tyrecheck
        },
        rules: {
            "tyrecheck/rule-name": "warn"
        }
    }
];

Configurations

TODO: Run eslint-doc-generator to generate the configs list (or delete this section if no configs are offered).

Rules

🔧 Automatically fixable by the --fix CLI option.

| Name | Description | 🔧 | | :--------------------------------------------------- | :--------------------- | :- | | safe-translations | An example ESLint rule | 🔧 |