{"id":20635737,"url":"https://github.com/nuxt-modules/stylelint","last_synced_at":"2025-04-09T14:15:23.797Z","repository":{"id":34995055,"uuid":"193427343","full_name":"nuxt-modules/stylelint","owner":"nuxt-modules","description":"Stylelint module for Nuxt.js","archived":false,"fork":false,"pushed_at":"2024-04-30T01:19:12.000Z","size":1467,"stargazers_count":57,"open_issues_count":10,"forks_count":9,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-05-02T05:54:59.087Z","etag":null,"topics":["nuxt","nuxt-module","nuxtjs","stylelint"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nuxt-modules.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-06-24T03:26:22.000Z","updated_at":"2024-05-06T12:36:11.641Z","dependencies_parsed_at":"2023-12-04T23:36:38.889Z","dependency_job_id":"0ffa3c7f-76b4-483a-bfcd-b7db393203cc","html_url":"https://github.com/nuxt-modules/stylelint","commit_stats":{"total_commits":142,"total_committers":9,"mean_commits":"15.777777777777779","dds":0.4859154929577465,"last_synced_commit":"7322031f03874385491157be5aa47c7141b9c4a1"},"previous_names":["nuxt-community/stylelint-module"],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt-modules%2Fstylelint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt-modules%2Fstylelint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt-modules%2Fstylelint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt-modules%2Fstylelint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nuxt-modules","download_url":"https://codeload.github.com/nuxt-modules/stylelint/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248054194,"owners_count":21039952,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nuxt","nuxt-module","nuxtjs","stylelint"],"created_at":"2024-11-16T15:07:00.242Z","updated_at":"2025-04-09T14:15:23.779Z","avatar_url":"https://github.com/nuxt-modules.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @nuxtjs/stylelint-module\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]\n[![Codecov][codecov-src]][codecov-href]\n[![License][license-src]][license-href]\n\n\u003e Stylelint module for Nuxt.js\n\n[📖 **Release Notes**](./CHANGELOG.md)\n\n---\n\n**Note:** This branch is for **Nuxt 3** or **Nuxt Bridge** compatible module.\nCheckout the [`nuxt2` branch](https://github.com/nuxt-modules/stylelint/tree/nuxt2) for **Nuxt 2** support.\n\n---\n\n## Requirements\n\nYou need to ensure that you have `stylelint` installed:\n\nWith `pnpm`\n\n```bash\npnpm add -D stylelint\n```\n\nOr, with `yarn`\n\n```bash\nyarn add -D stylelint\n```\n\nOr, with `npm`\n\n```bash\nnpm install -D stylelint\n```\n\n## Setup\n\n1. Add `@nuxtjs/stylelint-module` dependency to your project\n\n```bash\nnpx nuxi@latest module add stylelint\n```\n\n2. Add `@nuxtjs/stylelint-module` to the `modules` section of `nuxt.config.js`\n\n```js\nexport default {\n  modules: [\n    // Simple usage\n    \"@nuxtjs/stylelint-module\",\n\n    // With options\n    [\n      \"@nuxtjs/stylelint-module\",\n      {\n        /* module options */\n      },\n    ],\n  ],\n};\n```\n\n### Using top level options\n\n```js\nexport default {\n  modules: [\"@nuxtjs/stylelint-module\"],\n  stylelint: {\n    /* module options */\n  },\n};\n```\n\n## Options\n\nSee [stylelint's options](http://stylelint.io/user-guide/node-api/#options) for the complete list of options available.\nThese options are passed through to the `stylelint` directly.\n\n### `cache`\n\n- Type: `Boolean`\n- Default: `true`\n\n**Note**: The cache is enabled by default to decrease execution time.\n\n### `include`\n\n- Type: `String|Array[String]`\n- Default: `[nuxt.options.srcDir.'/**/*.{css,scss,sass,less,styl,vue}']`\n\nSpecify directories, files, or globs.\n\n### `exclude`\n\n- Type: `Array[String]`\n- Default: `['**/node_modules/**', 'virtual:', nuxt.options.buildDir]`\n\nSpecify the files and/or directories to exclude.\n\n### `stylelintPath`\n\n- Type: `String`\n- Default: `stylelint`\n\nPath to `stylelint` instance that will be used for linting.\n\n### `formatter`\n\n- Type: `Function`\n- Default: `'string'`\n\nSpecify the formatter that you would like to use to format your results.\n\n### `lintOnStart`\n\n- Type: `Boolean`\n- Default: `true`\n\nCheck all matching files on project startup, too slow, turn on discreetly.\n\n### `lintDirtyOnly`\n\n- Type: `Boolean`\n- Default: `true`\n\nLint changed files only when running Stylelint except from buildStart hook, all specified files from `include` option will be linted when disabled.\n\n### `emitWarning`\n\n- Type: `Boolean`\n- Default: `true`\n\nThe warnings found will be printed.\n\n### `emitError`\n\n- Type: `Boolean`\n- Default: `true`\n\nThe errors found will be printed.\n\n### `failOnWarning`\n\n- Builder: `webpack` // Only works with webpack builder\n- Type: `Boolean`\n- Default: `false`\n\nWill cause the module build to fail if there are any warnings, based on `emitWarning`.\n\n### `failOnError`\n\n- Builder: `webpack` // Only works with webpack builder\n- Type: `Boolean`\n- Default: `true`\n\nWill cause the module build to fail if there are any errors, based on `emitError`.\n\n## Contributing\n\nYou can contribute to this module online with CodeSandBox:\n\n[![Edit @nuxtjs/robots](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/nuxt-modules/stylelint/?fontsize=14\u0026hidenavigation=1\u0026theme=dark)\n\nOr locally:\n\n1. Clone this repository\n2. Install dependencies using `pnpm install`\n3. Prepare development server using `pnpm dev:prepare`\n4. Build module using `pnpm build`\n5. Launch playground using `pnpm dev`\n\n## License\n\n[MIT License](./LICENSE)\n\nCopyright (c) Nuxt Modules\n\n\u003c!-- Badges --\u003e\n\n[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/stylelint-module/latest.svg\n[npm-version-href]: https://npmjs.com/package/@nuxtjs/stylelint-module\n[npm-downloads-src]: https://img.shields.io/npm/dt/@nuxtjs/stylelint-module.svg\n[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/stylelint-module\n[github-actions-ci-src]: https://github.com/nuxt-modules/stylelint/workflows/ci/badge.svg\n[github-actions-ci-href]: https://github.com/nuxt-modules/stylelint/actions?query=workflow%3Aci\n[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-modules/stylelint.svg\n[codecov-href]: https://codecov.io/gh/nuxt-modules/stylelint\n[license-src]: https://img.shields.io/npm/l/@nuxtjs/stylelint-module.svg\n[license-href]: https://npmjs.com/package/@nuxtjs/stylelint-module\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuxt-modules%2Fstylelint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnuxt-modules%2Fstylelint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuxt-modules%2Fstylelint/lists"}