eslint-plugin-nfq

NFQ eslint rules

Installation

First, you need to install ESLint:

$ npm i eslint --save-dev

Next, install @nfq/eslint-plugin:

$ npm install @nfq/eslint-plugin --save-dev

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

Usage

Add @nfq to the plugins section of your .eslintrc configuration file. You can omit the /eslint-plugin suffix:

{
    "plugins": [
        "@nfq"
    ]
}

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

{
    "rules": {
        "@nfq/no-magic-numbers": [
            "error",
            {
                "detectObjects": false,
                "enforceConst": true,
                "ignore": [0, 1],
                "ignoreArrayIndexes": true,
                "ignoreFunctions": []
            }
        ],
        "@nfq/sort-keys": [
            "error",
            "asc",
            {
                "caseSensitive": false,
                "natural": true,
                "ignorePropTypes": true,
                "methodsExtra": true
            }
        ],
        "@nfq/object-property-newline": [
            "error",
            {
                "allowAllPropertiesOnSameLine": false
            }
        ]
    }
}

Supported Rules

@nfq/no-magic-numbers:

This rule is similar to the eslint standard except you can also specify functions that should get ignored. This is useful for utilities with many possible number values e.g. sizes etc.

@nfq/sort-keys:

Enforce alphabethical sorting of object keys. Forked from sort-keys-fix/sort-keys-fix. You can specify that proptypes dont get checked so react can do it for itself. Also you have the possibillity to change sorting behavior that object methods get sorted as its own group and get appended (asc) or prepended (desc)

@nfq/object-property-newline:

This rule enforces placing object properties on separate lines. It improves readability and makes version control diffs cleaner. However, it makes an exception for screensize object properties (xs, sm, md, lg, xl, xxl), which can be on the same line.

The rule is configurable with the following options:

• allowAllPropertiesOnSameLine: If set to true, all properties of an object can be on the same line.
• allowMultiplePropertiesPerLine: This option is deprecated.