https://github.com/akullpp/eslint-plugin-skeleton
Skeleton node module for an ESLint plugin.
https://github.com/akullpp/eslint-plugin-skeleton
Last synced: about 1 month ago
JSON representation
Skeleton node module for an ESLint plugin.
- Host: GitHub
- URL: https://github.com/akullpp/eslint-plugin-skeleton
- Owner: akullpp
- License: mit
- Created: 2015-09-04T10:18:13.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2017-10-17T09:05:29.000Z (over 8 years ago)
- Last Synced: 2025-03-06T05:33:13.822Z (over 1 year ago)
- Language: JavaScript
- Homepage: http://chrysanthium.com/eslint-integration
- Size: 17.6 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-plugin-skeleton
## Note
I will update this module only on request. If you want an update, create a pull request or raise an issue.
## Description
ESLint Plugin with recommended rules and mixins for the different environments of an Angular web application.
## Integration
Either insert it as a local folder with a relative path in the `package.json` (see [akSkeleton](https://github.com/akullpp/akSkeleton)) or use it as node module.
Your root `.eslintrc` needs to look the following:
```json
{
"extends": "./node_modules/eslint-plugin-skeleton/config/eslintrc.base"
}
```
The `.eslintrc` located in your source files (e.g. `src/`) should extend the browser mixin:
```json
{
"extends": "../node_modules/eslint-plugin-skeleton/config/mixins/browser"
}
```
The `.eslintrc` located in your test files (e.g. `test/`) should extend the test mixin:
```json
{
"extends": "../node_modules/eslint-plugin-skeleton/config/mixins/test"
}
```
## Configuration & Mixins
1. The `eslintrc.base` contains all the defaults and main rules. It ensures that the root files are linted as a node environment.
2. The `browser` mixin sets up the rules and environment for linting client-side scripts.
3. The `test` mixin is exclusively used for the test environment.