npm

Need private packages and team management tools?Check out npm Orgs. »

@nuxtjs/stylelint-module

3.1.0 • Public • Published

@nuxtjs/stylelint-module

npm version npm downloads Circle CI Codecov License

Stylelint module for Nuxt.js

📖 Release Notes

Requirements

You need to ensure that you have stylelint installed:

yarn add --dev stylelint # or npm install --save-dev stylelint 

Setup

  1. Add @nuxtjs/stylelint-module dependency to your project
yarn add --dev @nuxtjs/stylelint-module # or npm install --save-dev @nuxtjs/stylelint-module 
  1. Add @nuxtjs/stylelint-module to the buildModules section of nuxt.config.js

⚠️ If you are using Nuxt older than v2.9 you have to install module as a dependency (No --dev or --save-dev flags) and also use modules section in nuxt.config.js instead of buildModules.

export default {
  buildModules: [
    // Simple usage
    '@nuxtjs/stylelint-module',
 
    // With options
    ['@nuxtjs/stylelint-module', { /* module options */ }]
  ]
}

Using top level options

export default {
  buildModules: [
    '@nuxtjs/stylelint-module'
  ],
  stylelint: {
    /* module options */
  }
}

Options

You can pass stylelint options.

context

  • Type: String
  • Default: srcDir

A string indicating the root of your files.

files

  • Type: String|Array[String]
  • Default: ['assets/**/*.{s?(a|c)ss,less,stylus}', '{components,layouts,pages}/**/*.vue']

Specify the glob pattern for finding files. Must be relative to options.context.

formatter

  • Type: Function
  • Default: require('stylelint').formatters.string

Specify the formatter that you would like to use to format your results.

lintDirtyModulesOnly

  • Type: Boolean
  • Default: false

Lint only changed files, skip lint on start.

stylelintPath

  • Type: String
  • Default: stylelint

Path to stylelint instance that will be used for linting.

Errors and Warning

By default the plugin will auto adjust error reporting depending on stylelint errors/warnings counts. You can still force this behavior by using emitError or emitWarning options:

emitError

  • Type: Boolean
  • Default: false

Will always return errors, if set to true.

emitWarning

  • Type: Boolean
  • Default: false

Will always return warnings, if set to true.

failOnError

  • Type: Boolean
  • Default: false

Will cause the module build to fail if there are any errors, if set to true.

failOnWarning

  • Type: Boolean
  • Default: false

Will cause the module build to fail if there are any warnings, if set to true.

quiet

  • Type: Boolean
  • Default: false

Will process and report errors only and ignore warnings, if set to true.

Development

  1. Clone this repository
  2. Install dependencies using yarn install or npm install
  3. Start development server using npm run dev

License

MIT License

Copyright (c) Nuxt Community

Keywords

none

install

npm i @nuxtjs/stylelint-module

Downloadsweekly downloads

1,644

version

3.1.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability