https://github.com/doodlewind/eslint-plugin-pangu-comment

Pangu whitespace for Chinese comments.
https://github.com/doodlewind/eslint-plugin-pangu-comment

Last synced: 9 months ago
JSON representation

Pangu whitespace for Chinese comments.

• Host: GitHub
• URL: https://github.com/doodlewind/eslint-plugin-pangu-comment
• Owner: doodlewind
• Created: 2018-05-03T01:47:24.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-05-03T02:02:13.000Z (about 8 years ago)
• Last Synced: 2025-07-08T08:46:18.689Z (about 1 year ago)
• Language: JavaScript
• Size: 188 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# eslint-plugin-pangu-comment

Pangu whitespace for Chinese comments.

![demo](./demo.gif)

## Installation

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

```

$ npm i eslint --save-dev

```

Next, install `eslint-plugin-pangu-comment`:

```

$ npm install eslint-plugin-pangu-comment --save-dev

```

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-pangu-comment` globally.

## Usage

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

```json

{

    "plugins": [

        "pangu-comment"

    ]

}

```

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

```json

{

    "rules": {

        "pangu/rule-spacing": 2

    }

}

```

## Supported Rules

* Spacing