@vkcn/eslint-plugin

@vkcn/eslint-plugin is an ESLint plugin for ensuring a kebab-ish like class naming convention.

This convention was invited and relates only to this plugin. The convention was created to solve styles encapsulation via class naming. The description of the convention can be found in rule documentation.

VKCN stands for vue-kebab-class-naming.

Read more about CSS encapsulation and compare VKCN with other options in this article.

Features

This ESLint plugin provides linting rules related to better class names usage.

• Provides linting rules for Vue template and style blocks.
• Supports plain CSS and SCSS.
• Parses <style> and <template> blocks.
• ~~Mostly copied~~ Highly inspired by eslint-plugin-vue-scoped-css

Installation

Prerequisite: eslint and eslint-plugin-vue are already installed

npm install --save-dev @vkcn/eslint-plugin

yarn add --dev @vkcn/eslint-plugin

pnpm add --dev @vkcn/eslint-plugin

Usage

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

Example .eslintrc.js:

module.exports = {
  plugins: ['@vkcn'],
  settings: { "@vkcn/class-attr-name": /custom-reg-exp/ }, // optional
  rules: {
    '@vkcn/<rule-name>': 'error'
  }
}

By using settings: { "@vkcn/class-attr-name": /custom-reg-exp/ } it is possible to run rules throughout any attribute/directive which matches regexp. By default only class is checked.

Please note! When using a custom regexp - class must be included into it

Recommended usage

Configuration

Please note! Recommended set of rules includes several eslint plugins, which are out of this plugin's scope, so install them separately.

module.exports = {
  parser: "vue-eslint-parser",
  plugins: [
    'vue',
    'vue-scoped-css',
    '@vkcn',
  ],
  rules: {
    "vue/no-useless-v-bind": "error",
    "vue/prefer-separate-static-class": "error",

    "vue-scoped-css/enforce-style-type": ["error", { allows: ["plain"] }],
    "vue-scoped-css/no-unused-selector": ["error", { checkUnscoped: true }],
    "vue-scoped-css/require-selector-used-inside": ["error", { checkUnscoped: true }],

    '@vkcn/no-convention-violation': ["error", { enableFix: true }],
    '@vkcn/no-dynamic-class-names': "error",
    '@vkcn/no-undefined-class-names': "error",
  }
}

Additional tools

• @vkcn/reporter - reports duplicate classes in multiple files

Since Eslint works only with one file and can not lint the whole project - something else is needed for checking. This tool is intended to be used to ensure that no identical classes are defined in multiple files (to prevent style leaks)

Available rules

The --fix option on the command line automatically fixes problems reported by rules which have a wrench :wrench: below.

Rules which have suggestions - marked with :bulb:

| Rule ID | Description | | |:--------|:------------|:---| | @vkcn/no-dynamic-class-names | disallow dynamic class names usage | | | @vkcn/no-undefined-class-names | disallow class names using in <template> that are not defined in <style> | :bulb: | | @vkcn/no-convention-violation | enforce css/scss code style | :wrench: :bulb: |

Contributing

Welcome contributing!

Please use GitHub's Issues/PRs.

Development Tools

• yarn test runs tests and measures coverage.
• yarn t tests/lib/rules/<rule-name>.ts runs all tests for selected rule.
• put debugger statement in lib code and run task "Debug tests" in VS Code "Run and Debug" tab

License

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

Huge thanks to Yosuke Ota for creating eslint-plugin-vue-scoped-css which enabled this eslint plugin creation.