README.md

eslint-plugin-doist

A collection of Doist ESLint rules.

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-doist:

npm install eslint-plugin-doist --save-dev

Usage

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

{
    "plugins": [
        "@doist/doist"
    ]
}

Supported Rules

gettext-literal-arg

Enforce only string literals as arguments to our i18n helpers _().

import-file-naming

Enforce naming conventions when importing certain file types using ES6 modules.

static-path-literal-arg

Enforce only string literals as arguments to our static deployment tool $static_path.

Add a new rule

Use generator-eslint:

yo eslint:rule

Stick to the ESLint recomendations regarding working with rules and working with plugins.