Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/team23/eslint-config-team23-ngrx
A set of eslint rules used by TEAM23 for angular projects using NgRx
https://github.com/team23/eslint-config-team23-ngrx
Last synced: about 22 hours ago
JSON representation
A set of eslint rules used by TEAM23 for angular projects using NgRx
- Host: GitHub
- URL: https://github.com/team23/eslint-config-team23-ngrx
- Owner: team23
- License: mit
- Created: 2022-12-09T09:19:18.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-16T12:45:34.000Z (almost 2 years ago)
- Last Synced: 2024-10-05T12:36:40.913Z (about 2 months ago)
- Language: TypeScript
- Size: 188 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
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`
```bash
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
```json
{
"extends": "@team23/eslint-config-team23-ngrx"
}
```
#### Extend overrides
```json
{
"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.
```json
{
"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](CHANGELOG.md)
2) Run `npm version [ | major | minor | patch] -m "feat(core): "`
3) Push commits and tags
4) 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](LICENSE)
TEAM23 GmbH