/eslint-plugin-mithril

Mithril specific linting rules for ESLint

Primary LanguageJavaScriptMIT LicenseMIT

eslint-plugin-mithril

Mithril specific linting rules for ESLint

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-mithril:

$ npm install eslint-plugin-mithril --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-mithril globally.

Usage

Use our preset to get reasonable defaults:

  "extends": [
    "eslint:recommended",
    "plugin:mithril/recommended"
  ]

If you do not use a preset you will need to specify individual rules and add extra configuration.

Add mithril to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "mithril"
    ]
}

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

{
    "rules": {
        "mithril/jsx-uses-vars": 2
    }
}

Supported Rules

JSX-common rules

Mithril specific rules

Comming soon

Shareable configurations

Recommended

This plugin exports a recommended configuration that enforces Mithril good practices.

To enable this configuration use the extends property in your .eslintrc config file:

{
  "extends": ["eslint:recommended", "plugin:mithril/recommended"]
}

See ESLint documentation for more information about extending configuration files.

The rules enabled in this configuration are:

All

This plugin also exports an all configuration that includes every available rule. This pairs well with the eslint:all rule.

{
  "plugins": [
    "mithril"
  ],
  "extends": ["eslint:all", "plugin:mithril/all"]
}

Note: These configurations will import eslint-plugin-mithril and enable JSX in parser options.

Note: This repo is forked from yannickcr/eslint-plugin-react

License

ESLint-plugin-Mithril is licensed under the MIT License.