Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mysticatea/eslint-plugin
ESLint configurations and additional rules for me
https://github.com/mysticatea/eslint-plugin
ecmascript eslint eslint-plugin javascript static-code-analysis
Last synced: 3 months ago
JSON representation
ESLint configurations and additional rules for me
- Host: GitHub
- URL: https://github.com/mysticatea/eslint-plugin
- Owner: mysticatea
- License: mit
- Created: 2015-06-14T10:22:32.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-11-14T23:56:33.000Z (almost 2 years ago)
- Last Synced: 2024-07-19T09:12:42.912Z (4 months ago)
- Topics: ecmascript, eslint, eslint-plugin, javascript, static-code-analysis
- Language: JavaScript
- Homepage:
- Size: 305 KB
- Stars: 25
- Watchers: 5
- Forks: 10
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-eslint - @mysticatea/eslint-plugin - Misc. rules. (Plugins / Code Quality)
README
# @mysticatea/eslint-plugin
[](https://www.npmjs.com/package/@mysticatea/eslint-plugin)
[](http://www.npmtrends.com/@mysticatea/eslint-plugin)
[](https://github.com/mysticatea/eslint-plugin/actions)
[](https://codecov.io/gh/mysticatea/eslint-plugin)
[](https://david-dm.org/mysticatea/eslint-plugin)
Additional ESLint rules and ESLint configurations for me.
## 💿 Installation
```
npm install --save-dev eslint @mysticatea/eslint-plugin
```
### Requirements
- Node.js `^8.10.0` or newer versions.
- ESLint `^6.3.0` or newer versions.
## 📖 Usage
Write in your ESLint configurations: http://eslint.org/docs/user-guide/configuring#using-the-configuration-from-a-plugin
### Configs
- `plugin:@mysticatea/es2020` ... Basic configuration for ES2020.
- `plugin:@mysticatea/es2019` ... Basic configuration for ES2019.
- `plugin:@mysticatea/es2018` ... Basic configuration for ES2018.
- `plugin:@mysticatea/es2017` ... Basic configuration for ES2017.
- `plugin:@mysticatea/es2016` ... Basic configuration for ES2016.
- `plugin:@mysticatea/es2015` ... Basic configuration for ES2015.
- `plugin:@mysticatea/es5` ... Basic configuration for ES5.
- `plugin:@mysticatea/+modules` ... Additional configuration for ES modules.
- `plugin:@mysticatea/+browser` ... Additional configuration for browser environment.
- `plugin:@mysticatea/+node` ... Additional configuration for Node.js environment.
- `plugin:@mysticatea/+eslint-plugin` ... Additional configuration for ESLint plugins. This includes `plugin:mysticatea/+node` setting.
#### Details
The main configurations `plugin:@mysticatea/es*` does:
- detect bug-like code by ESLint rules.
- enforce whitespace style by Prettier.
- handle the `.ts` files as TypeScript then check by `typescript-eslint-parser` and `eslint-plugin-typescript`.
- handle the `.vue` files as Vue.js SFC then check by `vue-eslint-parser` and `eslint-plugin-vue`.
- handle the files in `test`/`tests` directory as `mocha`'s test code.
- handle the files in `scripts` directory as Node.js environment.
- handle the `.eslintrc.js` file as a Node.js script.
- handle the `webpack.config.js` file as a Node.js script.
- handle the `rollup.config.js` file as an ES module.
You can use combination of a main configuration and some additional configurations.
For examples:
##### For Node.js
```json
{
"extends": [
"plugin:@mysticatea/es2015",
"plugin:@mysticatea/+node"
]
}
```
> It handles `.js` files as scripts and `.mjs` files as modules.
##### For Browsers
```json
{
"extends": [
"plugin:@mysticatea/es2015",
"plugin:@mysticatea/+browser"
]
}
```
##### For Browsers with ES modules
```json
{
"extends": [
"plugin:@mysticatea/es2015",
"plugin:@mysticatea/+modules",
"plugin:@mysticatea/+browser"
]
}
```
##### For ESLint plugins
```json
{
"extends": [
"plugin:@mysticatea/es2015",
"plugin:@mysticatea/+eslint-plugin"
]
}
```
### Rules
This plugin has some original rules and foreign rules.
#### Original rules
- [@mysticatea/arrow-parens](docs/rules/arrow-parens.md) enforces parens of argument lists (excludes too redundant parens) (fixable).
- [@mysticatea/block-scoped-var](docs/rules/block-scoped-var.md) handles variables which are declared by `var` declaration as block-scoped. It disallows redeclarations, uses from outside of the scope, shadowing.
- [@mysticatea/no-instanceof-array](docs/rules/no-instanceof-array.md) disallows 'instanceof' for Array (fixable).
- [@mysticatea/no-instanceof-wrapper](docs/rules/no-instanceof-wrapper.md) disallows 'instanceof' for wrapper objects (fixable).
- [@mysticatea/no-literal-call](docs/rules/no-literal-call.md) disallows a call of a literal.
- [@mysticatea/no-this-in-static](docs/rules/no-this-in-static.md) disallows `this`/`super` in static methods.
- [@mysticatea/no-use-ignored-vars](docs/rules/no-use-ignored-vars.md) disallows a use of ignored variables.
- [@mysticatea/no-useless-rest-spread](docs/rules/no-useless-rest-spread.md) disallows unnecessary rest/spread operators (fixable).
- [@mysticatea/prefer-for-of](docs/rules/prefer-for-of.md) requires `for-of` statements instead of `Array#forEach` or something like (fixable).
#### Foreign rules
- All `@mysticatea/eslint-comments/*` rules are imported from [eslint-plugin-eslint-comments](https://www.npmjs.com/package/eslint-plugin-eslint-comments).
- All `@mysticatea/eslint-plugin/*` rules are imported from [eslint-plugin-eslint-plugin](https://www.npmjs.com/package/eslint-plugin-eslint-plugin).
- All `@mysticatea/node/*` rules are imported from [eslint-plugin-node](https://www.npmjs.com/package/eslint-plugin-node).
- All `@mysticatea/ts/*` rules are imported from [eslint-plugin-typescript](https://www.npmjs.com/package/eslint-plugin-typescript).
- All `@mysticatea/vue/*` rules are imported from [eslint-plugin-vue](https://www.npmjs.com/package/eslint-plugin-vue).
- The `@mysticatea/prettier` rule is imported from [eslint-plugin-prettier](https://www.npmjs.com/package/eslint-plugin-prettier).
> **Q:** Why don't you use those plugins directly?
> **A:** The combination with shareable configs and plugins has some problems because shareable configs were not designed to be used with plugins. @nzakas illustrated a way to use plugins as shareable configs together with other plugins in the discussion [eslint/eslint#3458](https://github.com/eslint/eslint/issues/3458#issuecomment-257161846). This is the way.
## 🚥 Semantic Versioning Policy
This plugin follows [semantic versioning](http://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy).
## 📰 Changelog
- [GitHub Releases](https://github.com/mysticatea/eslint-plugin/releases)
## ❤️ Contributing
Welcome contributing!
Please use GitHub's Issues/PRs.
### Development Tools
- `npm test` runs tests and measures coverage.
- `npm run clean` removes the coverage result of `npm test` command.
- `npm run coverage` shows the coverage result of `npm test` command.
- `npm run update` updates auto-generated files.
- `npm run watch` runs tests and measures coverage when source code are changed.