eslint-plugin-ember-suave

eslint-plugin-ember-suave

Make your Ember App Stylish

THIS PROJECT IS A WORK IN PROGRESS: Ember Suave is being ported to ESLint, and this repo is porting the rules to the new platform. See this Github issue for more information.

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-ember-suave:

$ npm install eslint-plugin-ember-suave --save-dev

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

Usage

There are a few ways to add the rules from ember-suave to your ESLint project. The easiest way is to extend your configuration from the one provided, like so:

{
    "extends": [
        "./node_modules/ember-cli-eslint/coding-standard/ember-application.js",
        "plugin:ember-suave/recommended"
    ]
}

Note that the first extension is placed there by default by ember-cli-eslint; you might not have it if you're not using that plugin, or if you've decided not to take their presets. Once you've extended from the recommended settings, you can turn them off or configure them as you like. If you want more control over your linting, or would prefer adding rules one at a time, you can also include the plugin manually and individually enable rules. Add ember-suave to the plugins section of your .eslintrc configuration file, and then configure individual rules under the rules section. Note that rules will be disabled by default; you'll need to turn on each one that you want to use.

{
    "plugins": [
        "ember-suave"
    ],
    "rules": {
        "ember-suave/no-const-outside-module-scope": ["error"],
        "ember-suave/no-direct-property-access": ["error"],
        "ember-suave/require-access-in-comments": ["error"],
        "ember-suave/require-const-for-ember-properties": ["error"]
    }
}

Details about rules and their configuration options are provided below.

Rules

A list of supported rules and documentation can be found here.

Development

The provided Yeoman generator should be used for creating rules. In doing do, each rule will have a rule, documentation and test file created automatically. All rules should be tested!

Tests can be run using npm test. If you want to debug your rules within Mocha, you can use npm run test:debug to step inside your tests. Additionally, AST Explorer is a great way to look into the structure of a node to determine what to expect.