https://github.com/infokin/eslint-config-angular
Provides a common Angular specific ESLint configuration.
https://github.com/infokin/eslint-config-angular
angular eslint eslint-config
Last synced: 3 months ago
JSON representation
Provides a common Angular specific ESLint configuration.
- Host: GitHub
- URL: https://github.com/infokin/eslint-config-angular
- Owner: infokin
- License: mit
- Created: 2022-12-11T16:58:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-05T12:42:39.000Z (almost 3 years ago)
- Last Synced: 2025-03-14T19:52:54.831Z (over 1 year ago)
- Topics: angular, eslint, eslint-config
- Language: JavaScript
- Homepage:
- Size: 312 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Angular ESLint Configuration
This package provides a common Angular specific ESLint configuration.
## Installation
Install the latest version of this package with:
```bash
npm install @infokin/eslint-config-angular --save-dev
```
To install a specific version use `@infokin/eslint-config-angular@` instead.
To install this package directly from the `main` branch on GitHub use:
```bash
npm install git://github.com/infokin/eslint-config-angular --save-dev
```
## Usage
First, get your Angular application ready and set up ESLint. Run `ng lint`, if no linter is set up yet and follow the
instructions in the terminal. Proceed with the installation of this package, then extend from the provided configuration
in your project's ESLint configuration file like this:
```javascript
"use strict";
module.exports = {
root: true,
extends: [
"@infokin/eslint-config-angular"
],
overrides: [
{
files: [
"*.ts"
],
parserOptions: {
project: "tsconfig.json"
}
}
]
}
```
### Customization
After extending from the provided ESLint configuration, you can add and override your project specific ESLint rules,
preferably inside the `overrides` block.
## Development
The `package.json` file provides a `lint` script. This is used to check the code style of the project's files.
## Bugs & Issues
If you encounter any issues or bugs, we would appreciate it if you could report them on
the [corresponding GitHub page](https://github.com/infokin/eslint-config-angular/issues). Thank you for your help in
improving this project.
## Author
Johannes Hillert ([GitHub](https://github.com/clovergaze))
## License
Copyright (c) 2023 Johannes Hillert. Licensed under the MIT license, see the included LICENSE file for details.