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

An ESLint plugin to provide custom rules necessary for the ESLint config
https://github.com/yoast/eslint-plugin

Last synced: 3 days ago
JSON representation

An ESLint plugin to provide custom rules necessary for the ESLint config

• Host: GitHub
• URL: https://github.com/yoast/eslint-plugin
• Owner: Yoast
• License: gpl-3.0
• Created: 2016-05-02T19:44:04.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2022-09-29T13:34:21.000Z (over 3 years ago)
• Last Synced: 2025-01-02T08:31:21.491Z (over 1 year ago)
• Language: JavaScript
• Size: 17.6 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# eslint-plugin-yoast

An ESLint plugin to provide custom rules necessary for the ESLint config

## Installation

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

```

$ npm i eslint --save-dev

```

Next, install `eslint-plugin-yoast`:

```

$ npm install eslint-plugin-yoast --save-dev

```

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

## Usage

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

```json

{

    "plugins": [

        "yoast"

    ]

}

```

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

```json

{

    "rules": {

        "yoast/rule-name": 2

    }

}

```

## Supported Rules

* Fill in provided rules here