Skip to content
An ESlint plugin that provides set of rules for Glimmer.js Applications
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs/rules
lib
tests/lib/rules
README.md
package.json

README.md

eslint-plugin-glimmer

Eslint plugin for Glimmer.js apps

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-glimmer:

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

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

Usage

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

{
    "plugins": [
        "glimmer"
    ]
}

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

{
    "rules": {
        "glimmer/no-side-effects-in-tracking-getters": 2,
        "glimmer/require-init-in-constructor": 2
    }
}

Supported Rules

Contribution guide

In order to add a new rule, you should:

  • Create issue on GH with description of proposed rule
  • Generate a new rule using the official yeoman generator
  • Write test scenarios & implement logic
  • Describe the rule in the generated docs file
  • Make sure all tests are passing
  • Create PR and link created issue in description

If you have any suggestions, ideas or problems feel free to add new issue, but first please make sure your question does not repeat previous ones.

You can’t perform that action at this time.