https://github.com/lakshyabatman/eslint-comment-box-plugin

A simple Eslint Plugin which enforces adding a comment box before functions! 🤯🚀
https://github.com/lakshyabatman/eslint-comment-box-plugin

Last synced: about 2 months ago
JSON representation

A simple Eslint Plugin which enforces adding a comment box before functions! 🤯🚀

• Host: GitHub
• URL: https://github.com/lakshyabatman/eslint-comment-box-plugin
• Owner: lakshyabatman
• Created: 2020-11-14T08:04:01.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2020-11-14T10:23:15.000Z (about 4 years ago)
• Last Synced: 2024-11-05T16:54:21.766Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 15.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# eslint-plugin-comment-box-plugin

A small plugin to enforce some good practices

## Installation

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

```

$ npm i eslint --save-dev

```

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

```

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

```

## Usage

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

```json

{

  "plugins": ["comment-box-plugin"]

}

```

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

```json

{

  "rules": {

    "comment-box-plugin/rule-name": 2

  }

}

```

## Supported Rules

- Fill in provided rules here