https://github.com/byteever/eslint-plugin
https://github.com/byteever/eslint-plugin
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/byteever/eslint-plugin
- Owner: byteever
- Created: 2021-04-06T20:04:33.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-06T20:06:18.000Z (about 5 years ago)
- Last Synced: 2025-10-11T03:35:34.846Z (9 months ago)
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# ESLint Plugin
[@byteever/eslint-plugin](https://github.com/byteever/eslint-plugin) is built on top of [`@wordpress/eslint-plugin/recommended`](https://github.com/WordPress/gutenberg/tree/master/packages/eslint-plugin) ruleset to meet ByteEver's coding standards.
## Installation
Install [@byteever/eslint-plugin](https://github.com/byteever/eslint-plugin) as a development dependency of your project:
```sh
npm install @byteever/eslint-plugin --save-dev
```
## Usage
In order to use this config, add this configuration to your `package.json`:
```json
{
"eslintConfig": {
"extends": "@byteever/eslint-plugin/recommended"
}
}
```
Or add a `.eslintrc.js` file to your project root containing:
```js
module.exports = {
extends: ['@byteever/eslint-plugin/recommended'],
};
```
## Editor integration
If you want to use prettier in your code editor, you'll need to create a `.prettierrc.js` file at the root of your project with the following:
```js
module.exports = require("@byteever/eslint-plugin/recommended");
```
We recommend turning on VSCode settings to automatically run `eslint --fix` on save.
```json
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true,
}
```
This will automagically format your code once you save. You don't need VSCode prettier extension enabled or running on save as eslint will automatically run `prettier` for you.