eslint-plugin-vue-scoped-css
TypeScript icon, indicating that this package has built-in type declarations

0.0.1 • Public • Published

eslint-plugin-vue-scoped-css

eslint-plugin-vue-scoped-css is ESLint plugin for Scoped CSS in Vue.js.

NPM license NPM version NPM downloads NPM downloads NPM downloads NPM downloads NPM downloads Build Status Coverage Status

Features

This ESLint plugin provides linting rules specific to Scoped CSS in Vue.js.

  • Enforce best practices for Scoped CSS.
  • Supports CSS and SCSS syntax.

You can check on the Online DEMO.

Documentation

See documents.

Installation

npm install --save-dev eslint-plugin-vue-scoped-css

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:vue-scoped-css/recommended'
  ],
  rules: {
    // override/add rules settings here, such as:
    // 'vue-scoped-css/no-unused-selector': 'error'
  }
}

Configs

This plugin provides 3 predefined configs:

  • plugin:vue-scoped-css/base - Settings and rules to enable this plugin
  • plugin:vue-scoped-css/recommended - Above, plus rules for better ways to help you avoid problems
  • plugin:vue-scoped-css/all - All rules of this plugin are included

Rules

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

Base Rules (Enabling Plugin)

Enable this plugin using with:

{
  "extends": "plugin:vue-scoped-css/base"
}

Recommended

Enforce all the rules in this category with:

{
  "extends": "plugin:vue-scoped-css/recommended"
}
Rule ID Description
vue-scoped-css/no-parsing-error Disallow parsing errors in <style>
vue-scoped-css/no-unused-selector Reports selectors defined in Scoped CSS not used in <template>.
vue-scoped-css/require-scoped Enforce the <style> tags to has the scoped attribute.

Uncategorized

Rule ID Description
vue-scoped-css/require-selector-used-inside Reports the defined selectors is not used inside <template>.

Contributing

Welcome contributing!

Please use GitHub's Issues/PRs.

Development Tools

  • npm test runs tests and measures coverage.
  • npm run update runs in order to update readme and recommended configuration.

License

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

Package Sidebar

Install

npm i eslint-plugin-vue-scoped-css@0.0.1

Version

0.0.1

License

MIT

Unpacked Size

137 kB

Total Files

42

Last publish

Collaborators

  • ota-meshi