Winniepukki Guidelines

Static AST checker for accessibility rules on PWA projects Heads-up! Use together with Winniepukki Guardian for the best experience

Installation

Ensure that you have ESLint installed ESLint:

npm i -D eslint

Install the package itself:

npm i -D eslint-plugin-winniepukki-guidelines

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

Usage

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

{
    "plugins": [
        "winniepukki-guidelines"
    ]
}

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

{
    "rules": {
        "winniepukki-guidelines/rule-name": 2
    }
}

Supported rules

• avoid-names: Enforces a list of namings for developers to avoid
• derived-class-names: Enforces class name to match the name of the file it is declared in
• file-structure: Enforces file structure to be flat having certain postfixes and prohibit extending root directory src with custom folders
• use-license: Enforces files to begin with a given license comment