@nuxtjs/stylelint-module

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![Codecov][codecov-src]][codecov-href]
[![License][license-src]][license-href]

> Stylelint module for Nuxt.js

📖 Release Notes

---

Note: This branch is for Nuxt 3 or Nuxt Bridge compatible module.
Checkout the nuxt2 branch for Nuxt 2 support.

---

Requirements

You need to ensure that you have stylelint installed:

With pnpm

``bash
pnpm add -D stylelint
`

Or, with yarn

`bash
yarn add -D stylelint
`

Or, with npm

`bash
npm install -D stylelint
`

Setup

1. Add @nuxtjs/stylelint-module dependency to your project

`bash
npx nuxi@latest module add stylelint
`

2. Add @nuxtjs/stylelint-module to the modules section of nuxt.config.js

`js
export default {
modules: [
// Simple usage
"@nuxtjs/stylelint-module",

// With options
[
"@nuxtjs/stylelint-module",
{
/ module options /
},
],
],
};
`

$3

`js
export default {
modules: ["@nuxtjs/stylelint-module"],
stylelint: {
/ module options /
},
};
`

Options

See stylelint's options for the complete list of options available.
These options are passed through to the stylelint directly.

$3

- Type: Boolean
- Default: true

Note: The cache is enabled by default to decrease execution time.

$3

- Type: String|Array[String]
- Default: [nuxt.options.srcDir.'/*/.{css,scss,sass,less,styl,vue}']

Specify directories, files, or globs.

$3

- Type: Array[String]
- Default: ['/node_modules/', 'virtual:', nuxt.options.buildDir]

Specify the files and/or directories to exclude.

$3

- Type: String
- Default: stylelint

Path to stylelint instance that will be used for linting.

$3

- Type: Function
- Default: 'string'

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

$3

- Type: Boolean
- Default: true

Check all matching files on project startup, too slow, turn on discreetly.

$3

- Type: Boolean
- Default: true

Lint changed files only when running Stylelint except from buildStart hook, all specified files from include option will be linted when disabled.

$3

- Type: Boolean
- Default: true

The warnings found will be printed.

$3

- Type: Boolean
- Default: true

The errors found will be printed.

$3

- Builder: webpack // Only works with webpack builder
- Type: Boolean
- Default: false

Will cause the module build to fail if there are any warnings, based on emitWarning.

$3

- Builder: webpack // Only works with webpack builder
- Type: Boolean
- Default: true

Will cause the module build to fail if there are any errors, based on emitError.

Contributing

You can contribute to this module online with CodeSandBox:

![Edit @nuxtjs/robots](https://codesandbox.io/s/github/nuxt-modules/stylelint/?fontsize=14&hidenavigation=1&theme=dark)

Or locally:

1. Clone this repository
2. Install dependencies using pnpm install
3. Prepare development server using pnpm dev:prepare
4. Build module using pnpm build
5. Launch playground using pnpm dev`

License

MIT License

Copyright (c) Nuxt Modules

[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/stylelint-module/latest.svg
[npm-version-href]: https://npmjs.com/package/@nuxtjs/stylelint-module
[npm-downloads-src]: https://img.shields.io/npm/dt/@nuxtjs/stylelint-module.svg
[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/stylelint-module
[github-actions-ci-src]: https://github.com/nuxt-modules/stylelint/workflows/ci/badge.svg
[github-actions-ci-href]: https://github.com/nuxt-modules/stylelint/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-modules/stylelint.svg
[codecov-href]: https://codecov.io/gh/nuxt-modules/stylelint
[license-src]: https://img.shields.io/npm/l/@nuxtjs/stylelint-module.svg
[license-href]: https://npmjs.com/package/@nuxtjs/stylelint-module