https://github.com/comcast/eslint-plugin-polymer-components

Polymer specific linting rules for ESLint
https://github.com/comcast/eslint-plugin-polymer-components

eslint eslint-plugin polymer

Last synced: 2 months ago
JSON representation

Polymer specific linting rules for ESLint

• Host: GitHub
• URL: https://github.com/comcast/eslint-plugin-polymer-components
• Owner: Comcast
• License: apache-2.0
• Created: 2018-07-26T18:31:45.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-09-11T19:00:16.000Z (over 4 years ago)
• Last Synced: 2024-11-01T02:49:39.442Z (3 months ago)
• Topics: eslint, eslint-plugin, polymer
• Language: JavaScript
• Homepage:
• Size: 27.3 KB
• Stars: 2
• Watchers: 5
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-plugin-polymer-components

Polymer specific linting rules for ESLint

## Installation

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

```

$ npm i eslint --save-dev

```

Next, install `eslint-plugin-polymer-components`:

```

$ npm install eslint-plugin-polymer-components --save-dev

```

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

## Usage

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

```json

{

    "plugins": [

        "polymer-components"

    ]

}

```

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

```json

{

    "rules": {

        "polymer-components/sort-comp": "error"

    }

}

```

## Supported Rules

* [polymer-components/sort-comp](docs/rules/sort-comp.md): Enforce component methods order