This repository has moved!

January 9, 2019 · View on GitHub

It is now part of the Calypso repository.

The published npm package will continue to be available as before, no changes necessary!

eslint-plugin-wpcalypso

You'll first need to install ESLint:

$ npm install eslint --save-dev

Next, install eslint-plugin-wpcalypso:

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

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

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

{
    "plugins": [
        "wpcalypso"
    ]
}

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

{
    "rules": {
        "wpcalypso/rule-name": 2
    }
}

i18n-ellipsis: Disallow using three dots in translate strings
i18n-mismatched-placeholders: Ensure placeholder counts match between singular and plural strings
i18n-named-placeholders: Disallow multiple unnamed placeholders
i18n-no-collapsible-whitespace: Disallow collapsible whitespace in translatable strings
i18n-no-placeholders-only: Disallow strings which include only placeholders
i18n-no-this-translate: Disallow this.translate()
i18n-no-variables: Disallow variables as translate strings
jsx-classname-namespace: Ensure JSX className adheres to CSS namespace guidelines
jsx-gridicon-size: Enforce recommended Gridicon size attributes
import-docblock: Enforce external, internal dependencies docblocks
post-message-no-wildcard-targets: Disallow using the wildcard '*' in postMessage
import-no-redux-combine-reducers: Disallow combineReducers import from redux
redux-no-bound-selectors: Disallow creation of selectors bound to Redux state