Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unional/eslint-plugin-harmony
Team friendly eslint configurations
https://github.com/unional/eslint-plugin-harmony
eslint eslint-config eslint-configs
Last synced: 18 days ago
JSON representation
Team friendly eslint configurations
- Host: GitHub
- URL: https://github.com/unional/eslint-plugin-harmony
- Owner: unional
- License: mit
- Created: 2016-03-22T00:07:56.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-19T04:39:25.000Z (26 days ago)
- Last Synced: 2024-10-20T09:07:44.114Z (25 days ago)
- Topics: eslint, eslint-config, eslint-configs
- Language: TypeScript
- Homepage:
- Size: 3.48 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-plugin-harmony
[![NPM version][npm-image]][npm-url]
[![NPM downloads][downloads-image]][downloads-url]
[![semantic-release][semantic-release-image]][semantic-release-url]
[![Visual Studio Code][vscode-image]][vscode-url]
[![phpStorm][phpStorm-image]][phpStorm-url]
[![Atom][atom-image]][atom-url]
A [`eslint`](https://eslint.org/) config styles package that work across IDEs.
## Design Principles
There are several configurations available in this package.
Although they are different as they are designed for different programmers,
here are the principles that they all follow:
- They are designed to be used by team
- Each team member can use one of the supported IDE
- The formatter available on each IDE should work with each configuration
- Code should look well and consistent on each IDE with folding
- so that when you stop by your team member's cube, the code looks the same.
- Thrive for easy to write (with the fewest keystrokes) while keeping the code clean
## Supported IDE
- Visual Studio Code (1.20.0):
- phpStorm (2017.3.4):
- Atom (1.24.0):
## Installation
You'll first need to install [ESLint](http://eslint.org):
```sh
npm install --save-dev eslint
```
Next, install `eslint-plugin-harmony`:
```sh
npm install --save-dev eslint-plugin-harmony
```
**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-harmony` globally.
## Usage
To use the ESLint style, extends from one of the following:
```js
{
"extends": "plugin:harmony/recommended",
"extends": "plugin:harmony/latest",
"extends": "plugin:harmony/es5",
"extends": "plugin:harmony/es5-strict",
"extends": "plugin:harmony/ts-prettier", // experimental
"extends": "plugin:harmony/ts-recommended", // or use overrides
"extends": "plugin:harmony/ts-recommended-type-check", // or use overrides
"extends": "plugin:harmony/ts-recommended-cra",
"extends": "plugin:harmony/ts-recommended-type-check-cra",
}
```
### TypeScript
The TypeScript style is extended from [`@typescript-eslint/eslint-plugin`](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin).
They are adjusted to the style in harmony.
Also, the configuration are simplified.
Since you will likely to have some JavaScript files in your TypeScript project (e.g. `jest.config.js`, `webpack.config.js`, etc.),
it is recommended to use the `overrides.extends` feature in `eslint` to support mixed environment:
```js
{
"extends": [
"plugin:harmony/recommended"
],
"overrides": [
{
"files": [
"*.ts",
"*.tsx"
],
"extends": [
"plugin:harmony/ts-recommended"
]
}
]
}
```
Note that for `ts-recommended-type-check` you still need to specify `parserOptions.project`.
```json
{
"extends": [
"plugin:harmony/recommended"
],
"overrides": [
{
"files": [
"*.ts",
"*.tsx"
],
"extends": [
"plugin:harmony/ts-recommended-type-check"
],
"parserOptions": {
"project": "tsconfig.json"
}
}
]
}
```
For more information, please check out [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin).
### JetBrains IDE
After you import the settings,
you need to use them in the setting:
You also need to change your language version appropriately:
## Contribute
```sh
pnpm i
pnpm bootstrap
```
[npm-image]: https://img.shields.io/npm/v/eslint-plugin-harmony.svg?style=flat
[npm-url]: https://npmjs.org/package/eslint-plugin-harmony
[downloads-image]: https://img.shields.io/npm/dm/eslint-plugin-harmony.svg?style=flat
[downloads-url]: https://npmjs.org/package/eslint-plugin-harmony
[semantic-release-image]:https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-release-url]:https://github.com/semantic-release/semantic-release
[vscode-image]:https://img.shields.io/badge/vscode-ready-green.svg
[vscode-url]:https://code.visualstudio.com/
[phpStorm-image]:https://img.shields.io/badge/phpStorm-ready-green.svg
[phpStorm-url]:https://www.jetbrains.com/phpstorm/
[atom-image]:https://img.shields.io/badge/atom-ready-green.svg
[atom-url]:https://atom.io/