npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@nuxtjs/stylelint-module

v5.2.0

Published

Stylelint module for Nuxt.js

Downloads

214,320

Readme

@nuxtjs/stylelint-module

npm version npm downloads Github Actions CI Codecov License

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

pnpm add -D stylelint

Or, with yarn

yarn add -D stylelint

Or, with npm

npm install -D stylelint

Note: Currently, this module is compatible with the latest version 16 of stylelint only when using vite, support for webpack is not yet implemented (see https://github.com/webpack-contrib/stylelint-webpack-plugin/issues/342).

Setup

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

With pnpm

pnpm add -D @nuxtjs/stylelint-module

Or, with yarn

yarn add -D @nuxtjs/stylelint-module

Or, with npm

npm install -D @nuxtjs/stylelint-module
  1. Add @nuxtjs/stylelint-module to the modules section of nuxt.config.js
export default {
  modules: [
    // Simple usage
    '@nuxtjs/stylelint-module',

    // With options
    ['@nuxtjs/stylelint-module', { /* module options */ }]
  ]
}

Using top level options

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.

cache

  • Type: Boolean
  • Default: true

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

include

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

Specify directories, files, or globs.

exclude

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

Specify the files and/or directories to exclude.

stylelintPath

  • Type: String
  • Default: stylelint

Path to stylelint instance that will be used for linting.

formatter

  • Type: Function
  • Default: 'string'

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

lintOnStart

  • Type: Boolean
  • Default: true

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

lintDirtyOnly

  • 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.

emitWarning

  • Type: Boolean
  • Default: true

The warnings found will be printed.

emitError

  • Type: Boolean
  • Default: true

The errors found will be printed.

failOnWarning

  • Type: Boolean
  • Default: false

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

failOnError

  • 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

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