Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greenpie/eslint-config-greenpie
GreenPie's ESLint config file
https://github.com/greenpie/eslint-config-greenpie
eslint eslint-config javascript linting
Last synced: 24 days ago
JSON representation
GreenPie's ESLint config file
- Host: GitHub
- URL: https://github.com/greenpie/eslint-config-greenpie
- Owner: GreenPie
- Created: 2017-03-05T09:10:26.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-12-13T09:41:02.000Z (about 1 month ago)
- Last Synced: 2025-01-02T00:07:43.742Z (25 days ago)
- Topics: eslint, eslint-config, javascript, linting
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/eslint-config-greenpie
- Size: 601 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pretty tough ESLint config
[![npm version](https://badge.fury.io/js/eslint-config-greenpie.svg)](http://badge.fury.io/js/eslint-config-greenpie)
This package provides ESLint's shared config that designed to be strict as hell.
## Usage
Install configurations
* `npm install typescript-eslint eslint-config-greenpie --save-dev`
And then add to local `eslint.config.js` following configuration
```js
import tsEslint from 'typescript-eslint';
import eslintGreenPie from 'eslint-config-greenpie';export default tsEslint.config(
...eslintGreenPie.configs.default,
...eslintGreenPie.configs.vue
);
```or see more [examples](#examples) below.
### Configs
| Config | Description |
|-----------|--------------------------------|
| `default` | Includes `js` and `ts` configs |
| `js` | Includes JavaScript rules |
| `ts` | Includes TypeScript rules |
| `vue` | Includes rules for Vue.js |### Examples
#### JS/TS rules
```js
import eslintGreenPie from 'eslint-config-greenpie';export default [
...eslintGreenPie.configs.js
];
```#### JS + Vue
```js
import eslintGreenPie from 'eslint-config-greenpie';export default [
...eslintGreenPie.configs.js,
...eslintGreenPie.configs.vue
];
```#### JS + TS + Vue
You will probably need to [configure another parser](https://github.com/vuejs/vue-eslint-parser#parseroptionsparser) for the `` tag.
```js
import eslintGreenPie from 'eslint-config-greenpie';export default [
...eslintGreenPie.configs.default,
...eslintGreenPie.configs.vue
];
```## Links
* [Registry](https://www.npmjs.com/package/eslint-config-greenpie)
* [Basic ESLint rules](https://eslint.org/docs/rules/)
* [TypeScript rules](https://typescript-eslint.io/rules/)
* [Stylistic JavaScript rules](https://eslint.style/packages/js)
* [Stylistic TypeScript rules](https://eslint.style/packages/ts)
* [Stylistic additional rules](https://eslint.style/packages/plus)
* [Vue rules](https://eslint.vuejs.org/rules/)