Package Exports

@iceworks/eslint-plugin-best-practices

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@iceworks/eslint-plugin-best-practices) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@iceworks/eslint-plugin-best-practices

Iceworks doctor best practices eslint plugin.

Installation

Install esLint, @ice/spec and @iceworks/eslint-plugin-best-practices:

$ npm install --save-dev eslint @ice/spec @iceworks/eslint-plugin-best-practices

Usage

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

{
    "plugins": [
        "@iceworks/best-practices"
    ]
}

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

{
    "rules": {
        "@iceworks/best-practices/rule-name": 2
    }
}

Or you can only use extends to set default rules config.

{
    "extends": ["plugin:@iceworks/best-practices/recommended"]
};

Supported Rules

deps-no-ice-scripts It is not recommended to use ice-scripts, the new version is ice.js.
deps-no-resolutions It is not recommended to use resolutions to lock the version.
deps-no-router-library It is not recommended to directly rely on routing libraries, such as react-router-dom, react-router.
deps-recommend-update-rax Rax version < 1.0 , recommend to update Rax.
no-broad-semantic-versioning Recommended the semantic versioning include everything greater than a particular version in the same major range.
no-js-in-ts-project It is not recommended to use js and ts files at the same time.
no-lowercase-component-name It is not recommended to name components in lower case.
no-multi-nested-page Multiple nested pages are not recommended.
recommend-functional-component It is not recommended to use class component.