Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Core #27

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from
Draft

Core #27

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
/node_modules
!.eslintrc.*
!.eslintrc.js
!.ncurc.js
coverage
2 changes: 1 addition & 1 deletion .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node: [12.x, 10.x, 8.x]
node: [12.x, 10.x]
steps:
- name: Checkout
uses: actions/checkout@v1
Expand Down
8 changes: 8 additions & 0 deletions .ncurc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
"use strict"

module.exports = {
// Whitelist all for checking besides `peer` which indicates
// somewhat older versions of `eslint` we still support even
// while our devDeps point to a more recent version
dep: "prod,dev,optional,bundle",
}
2 changes: 0 additions & 2 deletions .nycrc.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
include:
- lib
exclude:
- lib/processors/vue.js
reporter:
- text-summary
- lcov
110 changes: 10 additions & 100 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# @mysticatea/eslint-plugin
# @mysticatea/eslint-plugin-core

[![npm version](https://img.shields.io/npm/v/@mysticatea/eslint-plugin.svg)](https://www.npmjs.com/package/@mysticatea/eslint-plugin)
[![Downloads/month](https://img.shields.io/npm/dm/@mysticatea/eslint-plugin.svg)](http://www.npmtrends.com/@mysticatea/eslint-plugin)
[![Build Status](https://github.com/mysticatea/eslint-plugin/workflows/CI/badge.svg)](https://github.com/mysticatea/eslint-plugin/actions)
[![codecov](https://codecov.io/gh/mysticatea/eslint-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/mysticatea/eslint-plugin)
[![Dependency Status](https://david-dm.org/mysticatea/eslint-plugin.svg)](https://david-dm.org/mysticatea/eslint-plugin)
[![npm version](https://img.shields.io/npm/v/@mysticatea/eslint-plugin-core.svg)](https://www.npmjs.com/package/@mysticatea/eslint-plugin-core)
[![Downloads/month](https://img.shields.io/npm/dm/@mysticatea/eslint-plugin-core.svg)](http://www.npmtrends.com/@mysticatea/eslint-plugin-core)
[![Build Status](https://github.com/mysticatea/eslint-plugin-core/workflows/CI/badge.svg)](https://github.com/mysticatea/eslint-plugin-core/actions)
[![codecov](https://codecov.io/gh/mysticatea/eslint-plugin-core/branch/master/graph/badge.svg)](https://codecov.io/gh/mysticatea/eslint-plugin-core)
[![Dependency Status](https://david-dm.org/mysticatea/eslint-plugin-core.svg)](https://david-dm.org/mysticatea/eslint-plugin-core)

Additional ESLint rules and ESLint configurations for me.
Additional ESLint rules and ESLint configurations.

## 💿 Installation

```
npm install --save-dev eslint @mysticatea/eslint-plugin
npm install --save-dev eslint @mysticatea/eslint-plugin-core
```

### Requirements
Expand All @@ -25,88 +25,10 @@ Write in your ESLint configurations: http://eslint.org/docs/user-guide/configuri

### 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"
]
}
```
- `plugin:@mysticatea/core/es5` ... Basic configuration for ES5.

### 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).
Expand All @@ -117,25 +39,13 @@ This plugin has some original rules and foreign rules.
- [@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?<br>
> **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)
- [GitHub Releases](https://github.com/mysticatea/eslint-plugin-core/releases)

## ❤️ Contributing

Expand Down
2 changes: 0 additions & 2 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,5 @@

module.exports = {
configs: require("./lib/configs"),
processors: require("./lib/processors"),
rules: require("./lib/rules"),
utils: require("./lib/utils"),
}
10 changes: 1 addition & 9 deletions lib/configs.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,7 @@
"use strict"

module.exports = {
"+browser": require("./configs/+browser"),
"+eslint-plugin": require("./configs/+eslint-plugin"),
"+modules": require("./configs/+modules"),
"+node": require("./configs/+node"),
all: require("./configs/all"),
es2015: require("./configs/es2015"),
es2016: require("./configs/es2016"),
es2017: require("./configs/es2017"),
es2018: require("./configs/es2018"),
es2019: require("./configs/es2019"),
es2020: require("./configs/es2020"),
es5: require("./configs/es5"),
}
69 changes: 0 additions & 69 deletions lib/configs/+eslint-plugin.js

This file was deleted.

41 changes: 0 additions & 41 deletions lib/configs/+modules.js

This file was deleted.

Loading