@team23/eslint-config-team23-ngrx NPM

eslint-config-team23-ngrx

A set of eslint rules used by TEAM23 for angular projects using NgRx

Installation in your project

Add the library to your package.json as devDependency

npm i --save-dev @team23/eslint-config-team23-ngrx

Usage in your project

If you've enabled eslint locally within your project, just set your .eslintrc.[json|js] config to extend the rules from this repo:

Extend Globally

{
    "extends": "@team23/eslint-config-team23-ngrx"
}

Extend overrides

{
    "overrides": [
        {
            "files": [
                "*.ts",
                "*.tsx"
            ],
            "extends": [
                "@team23/eslint-config-team23-ngrx"
            ],
            "rules": {}
        },
    ]
}

Extending the .eslintrc.json

Simply add a "rules" key to your config, then add your overrides and additions there.

{
    "extends": "@team23/eslint-config-team23-ngrx"
    "rules": {
        "@ngrx/avoid-mapping-selectors": "off",
    }
}

Development

Rules that should be included here

ngrx rules

Rules that should NOT be included here

eslint rules
@typescript-eslint rules
angular rules
rules from other frameworks (react, vue), libraries (nx), etc.

Proposing rule changes

For proposing changes to the ruleset please open either

a merge request
reviewed and approved by at least one mid-senior level developer
additional permission is required if you would like to make a new version after the rule change

Creating a new version after new rule changes

1) update CHANGELOG.md 2) Run npm version [<newversion> | major | minor | patch] -m "feat(core): <versionmessage>" 3) Push commits and tags 4) Run npm publish --access public to publish the new version to npm