https://github.com/flynncao/eslint-plugin-flynncao

https://github.com/flynncao/eslint-plugin-flynncao

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/flynncao/eslint-plugin-flynncao
• Owner: FlynnCao
• Created: 2023-07-18T10:25:15.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-18T14:29:30.000Z (over 1 year ago)
• Last Synced: 2023-07-18T14:37:08.401Z (over 1 year ago)
• Language: JavaScript
• Size: 42 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# eslint-plugin-flynncao

Flynn Cao's ESLint Plugin for Demonstration.

## Installation

You'll first need to install [ESLint](https://eslint.org/):

```sh

npm i eslint --save-dev

```

Next, install `eslint-plugin-flynncao`:

```sh

npm install eslint-plugin-flynncao --save-dev

```

## Usage

Add `flynncao` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

```json

{

    "plugins": [

        "flynncao"

    ]

}

```

Then configure the rules you want to use under the rules section.

```json

{

    "rules": {

        "flynncao/rule-name": 2

    }

}

```

## Rules

| Name                                                   | Description                                              |

| :----------------------------------------------------- | :------------------------------------------------------- |

| [mandatory-comments](docs/rules/mandatory-comments.md) | You should write some comments for this kind of function |