eslint-plugin-kdu

Official ESLint plugin for Kdu

❕ Requirements

• ESLint >=3.18.0.
  • >=4.7.0 to use eslint --fix.
  • >=4.14.0 to use with babel-eslint.
• Node.js >=4.0.0

💿 Installation

npm install --save-dev eslint eslint-plugin-kdu

🚀 Usage

Create .eslintrc.* file to configure rules. See also: http://eslint.org/docs/user-guide/configuring.

Example .eslintrc.js:

module.exports = {
  extends: [
    // add more generic rulesets here, such as:
    // 'eslint:recommended',
    'plugin:kdu/essential'
  ],
  rules: {
    // override/add rules settings here, such as:
    // 'kdu/no-unused-vars': 'error'
  }
}

Attention

All component-related rules are being applied to code that passes any of the following checks:

• Kdu.component() expression
• Kdu.extend() expression
• Kdu.mixin() expression
• export default {} in .kdu or .jsx file

If you however want to take advantage of our rules in any of your custom objects that are Kdu components, you might need to use special comment // @kdu/component that marks object in the next line as a Kdu component in any file, e.g.:

// @kdu/component
const CustomComponent = {
  name: 'custom-component',
  template: '<div></div>'
}

Kdu.component('AsyncComponent', (resolve, reject) => {
  setTimeout(() => {
    // @kdu/component
    resolve({
      name: 'async-component',
      template: '<div></div>'
    })
  }, 500)
})

eslint-disable functionality in <template>

You can use <!-- eslint-disable -->-like HTML comments in <template> of .kdu files. For example:

<template>
  <!-- eslint-disable-next-line kdu/max-attributes-per-line -->
  <div a="1" b="2" c="3" d="4">
  </div>
</template>

If you want to disallow eslint-disable functionality, please disable kdu/comment-directive rule.

⚙️ Configs

This plugin provides four predefined configs:

• plugin:kdu/base - Settings and rules to enable correct ESLint parsing
• plugin:kdu/essential - Above, plus rules to prevent errors or unintended behavior
• plugin:kdu/strongly-recommended - Above, plus rules to considerably improve code readability and/or dev experience
• plugin:kdu/recommended - Above, plus rules to enforce subjective community defaults to ensure consistency

💡 Rules

Rules are grouped by priority to help you understand their purpose. The --fix option on the command line automatically fixes problems reported by rules which have a wrench 🔧 below.

Base Rules (Enabling Correct ESLint Parsing)

Enforce all the rules in this category, as well as all higher priority rules, with:

{
  "extends": "plugin:kdu/base"
}

Priority A: Essential (Error Prevention)

Enforce all the rules in this category, as well as all higher priority rules, with:

{
  "extends": "plugin:kdu/essential"
}

Priority B: Strongly Recommended (Improving Readability)

Enforce all the rules in this category, as well as all higher priority rules, with:

{
  "extends": "plugin:kdu/strongly-recommended"
}

Priority C: Recommended (Minimizing Arbitrary Choices and Cognitive Overhead)

Enforce all the rules in this category, as well as all higher priority rules, with:

{
  "extends": "plugin:kdu/recommended"
}

Uncategorized

👫 FAQ

What is the "Use the latest kdu-eslint-parser" error?

The most rules of eslint-plugin-kdu require kdu-eslint-parser to check <template> ASTs.

Make sure you have one of the following settings in your .eslintrc:

• "extends": ["plugin:kdu/recommended"]
• "extends": ["plugin:kdu/base"]

If you already use other parser (e.g. "parser": "babel-eslint"), please move it into parserOptions, so it doesn't collide with the kdu-eslint-parser used by this plugin's configuration:

- "parser": "babel-eslint",
  "parserOptions": {
+     "parser": "babel-eslint",
      "ecmaVersion": 2017,
      "sourceType": "module"
  }

The kdu-eslint-parser uses the parser which is set by parserOptions.parser to parse scripts.

Why doesn't it work on .kdu file?

1. Make sure you don't have eslint-plugin-html in your config. The eslint-plugin-html extracts the content from <script> tags, but eslint-kdu-plugin requires <script> tags and <template> tags in order to distinguish template and script in single file components.

  "plugins": [
    "kdu",
-   "html"
  ]

2. Make sure your tool is set to lint .kdu files.

• CLI targets only .js files by default. You have to specify additional extensions by --ext option or glob patterns. E.g. eslint "src/**/*.{js,kdu}" or eslint src --ext .kdu.
• VSCode targets only JavaScript or HTML files by default. You have to add {"autoFix": true, "language": "kdu"} into eslint.validate entry.

⚓ Semantic Versioning Policy

This plugin follows semantic versioning and ESLint's Semantic Versioning Policy.

📰 Changelog

We're using GitHub Releases.

🍻 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
• Run npm start
• Write test scenarios & implement logic
• Describe the rule in the generated docs file
• Make sure all tests are passing
• Run npm run update in order to update readme and recommended configuration
• Create PR and link created issue in description

We're more than happy to see potential contributions, so don't hesitate. 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.

🔒 License

See the LICENSE file for license rights and limitations (MIT).