@SamhammerAG/vue-cli-plugin-stylelint

forked from @ascendancyy/vue-cli-plugin-stylelint

merged fork of @zysce/vue-cli-plugin-stylelint

merged fork of @raul338/vue-cli-plugin-stylelint

stylelint plugin for vue-cli

This allows you to use stylelint-config-recommended-vue with SCSS (recommended) and/or prettier

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 in an already created project

via vue-cli (recommended)

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

via yarn

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

via npm

npm install --save-dev @SamhammerAG/vue-cli-plugin-stylelint
vue invoke @SamhammerAG/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 */)

How to publish

• Increase version by running Version workflow on github or 'yarn version' command on local machine. This updates package.json and creates tag

• Check github action to validated, that package was released to npm registry.