https://github.com/zengxiaoluan/eslint-plugin-jlc
An opinionated collection of ESLint rules used by JLC.
https://github.com/zengxiaoluan/eslint-plugin-jlc
eslint-plugin eslint-rules jlc
Last synced: 4 months ago
JSON representation
An opinionated collection of ESLint rules used by JLC.
- Host: GitHub
- URL: https://github.com/zengxiaoluan/eslint-plugin-jlc
- Owner: zengxiaoluan
- License: mit
- Created: 2024-07-10T06:09:31.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-08-28T11:14:41.000Z (10 months ago)
- Last Synced: 2025-02-01T13:03:04.577Z (4 months ago)
- Topics: eslint-plugin, eslint-rules, jlc
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/eslint-plugin-jlc
- Size: 207 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-plugin-jlc [](https://www.npmjs.com/package/eslint-plugin-jlc) [](https://github.com/zengxiaoluan/eslint-plugin-jlc/actions/workflows/node.js.yml) [](https://www.npmjs.com/package/eslint-plugin-jlc)
An opinionated collection of ESLint rules used by JLC.
## Installation
You'll first need to install [ESLint](https://eslint.org/):
```sh
npm i eslint --save-dev
```
Next, install `eslint-plugin-jlc`:
```sh
npm install eslint-plugin-jlc --save-dev
```
## Usage
Add `jlc` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
```json
{
"plugins": ["jlc"]
}
```
Then configure the rules you want to use under the rules section.
```json
{
"rules": {
"jlc/comments-need-space": 2
}
}
```
## Configurations
| | Name |
| :- | :------------ |
| ✅ | `recommended` |
## Rules
💼 Configurations enabled in.\
✅ Set in the `recommended` configuration.
| Name | Description | 💼 |
| :--------------------------------------------------------------- | :-------------------------------------------- | :- |
| [always-camel-case](docs/rules/always-camel-case.md) | Always camel case every thing | ✅ |
| [comments-need-space](docs/rules/comments-need-space.md) | comments need space | ✅ |
| [kebab-case](docs/rules/kebab-case.md) | kebab case your file name and directory name. | ✅ |
| [no-then](docs/rules/no-then.md) | No then with promise | ✅ |
| [prefer-template-literal](docs/rules/prefer-template-literal.md) | prefer template literal | ✅ |