Eslint-plugin-turmag-special-rules NPM

eslint-plugin-turmag-special-rules

Special eslint rules for your awesome projects

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-turmag-special-rules:

npm install eslint-plugin-turmag-special-rules --save-dev

# Or run this to use yarn
yarn add eslint-plugin-turmag-special-rules --dev

# Or run this to use pnpm
pnpm add eslint-plugin-turmag-special-rules --save-dev

Usage

In your configuration file, import the plugin eslint-plugin-turmag-special-rules and add turmagEslintSpecialRules to the plugins key:

import turmagSpecialRules from "eslint-plugin-turmag-special-rules";

export default [
    {
        plugins: {
            'turmag-special-rules': turmagSpecialRules
        }
    }
];

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

import turmagSpecialRules from "eslint-plugin-turmag-special-rules";

export default [
    {
        plugins: {
            'turmag-special-rules': turmagSpecialRules
        },
        rules: {
            "turmag-special-rules/rule-name": "warn"
        }
    }
];

Rules

🔧 Automatically fixable by the --fix CLI option.

Name	Description	🔧
add-vue-extension	Require .vue in vue files	🔧
import-entities-by-column-or-line	Prefered column or line import	🔧
import-right-order	Prefered right import order	🔧
prefer-true-attribute-shorthand	Require shorthand form attribute when `v-bind` value is `true`	🔧
use-shortest-alias	There are can be used shortest alias	🔧