@steveworkman/vue-cli-plugin-stylelint

@samhammer/vue-cli-plugin-stylelint

stylelint plugin for vue-cli

Injected commands

• vue-cli-service lint:style

  Usage: vue-cli-service lint:style [options] [...files]
  
  Options:
  
    --no-fix           do not auto-fix errors
    --options          list additional stylelint cli options
  

  Lints and fixes files. If no specific files are given, it lints all vue files, html files, and stylesheets in src.

Configuration (vue.config.js, "vue" in package.json)

Lint on (re)build with stylelint-webpack-plugin can be enabled with the lintStyleOnBuild option. You can also provide additional options to stylelint. See available options on the stylelint website.

module.exports = {
  // ...
  pluginOptions: {
    lintStyleOnBuild: true,
    stylelint: {
      fix: true, // boolean (default: true)
      files: '', // string | [string] (default: ['src/**/*.{vue,htm,html,css,sss,less,scss}'])
      // See https://stylelint.io/developer-guide/formatters/
      formatter: () => {} // function (default: require('stylelint-codeframe-formatter'))
      // etc...
    }
  }
}

Installing via CLI preset

Add the following to your preset.json

"@steveworkman/vue-cli-plugin-stylelint": {
  "version": "^2.1.0",
  "config": {
    ...
  }
}

Installing in an already created project

via vue-cli (recommended)

vue add @steveworkman/vue-cli-plugin-stylelint

via yarn

yarn add -D @steveworkman/vue-cli-plugin-stylelint
vue invoke @steveworkman/vue-cli-plugin-stylelint

via npm

npm install --save-dev @steveworkman/vue-cli-plugin-stylelint
vue invoke @steveworkman/vue-cli-plugin-stylelint

webpack-chain Injections

• config.plugin('stylelint')
• config.plugin('stylelint').use('stylelint-webpack-plugin')
• config.plugin('friendly-errors').tap(/* Adds additional transformer and formatter */)

Changelog

2.2.1 (01-09-2020)

Fixed

• Added missing dependency stylelint-scss for the scss config