Package Exports

@team23/eslint-config-team23-ngrx
@team23/eslint-config-team23-ngrx/.eslintrc.js

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 (@team23/eslint-config-team23-ngrx) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

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

Usage inside of this project

If you want a brief test of this repo, do the following:

npm ci
Run npm run lint

License

TEAM23 GmbH