refactor!: add support for nuxt 3/nuxt bridge (#74)

* feat: support nuxt 3

* docs: update readme

* fix: use include option

* chore: reorder options

Author: ricardogobbosouza

.editorconfig

@@ -1,4 +1,3 @@
-# editorconfig.org
 root = true
 
 [*]

.eslintrc

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "@nuxtjs/eslint-config-typescript"
+  ]
+}

.eslintrc.js

@@ -14,33 +14,28 @@ jobs:
 
     strategy:
       matrix:
-        # os: [ubuntu-latest, macos-latest, windows-latest]
         os: [ubuntu-latest]
-        node: [14]
+        node: [16]
 
     steps:
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - run: corepack enable
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
+          cache: "pnpm"
 
-      - name: checkout
-        uses: actions/checkout@v2
+      - name: 📦 Install dependencies
+        run: pnpm install --frozen-lockfile
 
-      - name: cache node_modules
-        uses: actions/cache@v2
-        with:
-          path: node_modules
-          key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/yarn.lock')) }}
-
-      - name: Install dependencies
-        if: steps.cache.outputs.cache-hit != 'true'
-        run: yarn
+      - name: 🚧 Set up project
+        run: pnpm dev:prepare
 
-      - name: Lint
-        run: yarn lint
+      - name: 🛠 Build project
+        run: pnpm build
 
-      - name: Test
-        run: yarn test
+      - name: 🧪 Test project
+        run: pnpm test
 
-      - name: Coverage
-        uses: codecov/codecov-action@v2
+      - name: 🟩 Coverage
+        uses: codecov/codecov-action@v3

.github/workflows/ci.yml

@@ -7,3 +7,6 @@ node_modules
 .DS_Store
 coverage
 dist
+sw.*
+.env
+.output

.gitignore

@@ -0,0 +1 @@
+shamefully-hoist=true

.npmrc

@@ -0,0 +1 @@
+[{"/Users/ricardogobbosouza/code/stylelint-module/playground/app.vue":"1"},{"size":41,"mtime":1678286733960,"hashOfConfig":"2"},"13zl9hh"]

.stylelintcache

@@ -14,23 +14,51 @@
 
 You need to ensure that you have `stylelint` installed:
 
+With `pnpm`
+
 ```bash
-yarn add --dev stylelint # or npm install --save-dev stylelint
+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
 
+With `pnpm`
+
 ```bash
-yarn add --dev @nuxtjs/stylelint-module # or npm install --save-dev @nuxtjs/stylelint-module
+pnpm add -D @nuxtjs/stylelint-module
 ```
 
-2. Add `@nuxtjs/stylelint-module` to the `buildModules` section of `nuxt.config.js`
+Or, with `yarn`
+
+```bash
+yarn add -D @nuxtjs/stylelint-module
+```
+
+Or, with `npm`
+
+```bash
+npm install -D @nuxtjs/stylelint-module
+```
+
+2. Add `@nuxtjs/stylelint-module` to the `modules` section of `nuxt.config.js`
 
 ```js
 export default {
-  buildModules: [
+  modules: [
     // Simple usage
     '@nuxtjs/stylelint-module',
 
@@ -40,13 +68,11 @@ export default {
 }
 ```
 
-:warning: If you are using Nuxt **< v2.9** you have to install the module as a `dependency` (No `--dev` or `--save-dev` flags) and use `modules` section in `nuxt.config.js` instead of `buildModules`.
-
 ### Using top level options
 
 ```js
 export default {
-  buildModules: [
+  modules: [
     '@nuxtjs/stylelint-module'
   ],
   stylelint: {
@@ -57,51 +83,29 @@ export default {
 
 ## Options
 
-See [stylelint's options](http://stylelint.io/user-guide/node-api/#options) for the complete list of options available. These options are passed through to the `stylelint` directly.
+See [stylelint's options](http://stylelint.io/user-guide/node-api/#options) for the complete list of options available.
+These options are passed through to the `stylelint` directly.
 
-### `configFile`
-
-- Type: `String`
-- Default: `undefined`
-
-Specify the config file location to be used by `stylelint`.
-
-**Note:** By default this is [handled by `stylelint`](http://stylelint.io/user-guide/configuration/).
-
-### `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`.
-
-### `fix`
+### `cache`
 
 - Type: `Boolean`
-- Default: `false`
+- Default: `true`
 
-If `true`, `stylelint` will fix as many errors as possible. The fixes are made to the actual source files. All unfixed errors will be reported. See [Autofixing errors](https://stylelint.io/user-guide/cli#autofixing-errors) docs.
+**Note**: The cache is enabled by default to decrease execution time.
 
-### `formatter`
+### `include`
 
-- Type: `Function`
-- Default: `require('stylelint').formatters.string`
+- Type: `String|Array[String]`
+- Default: `[nuxt.options.srcDir.'/**/*.{css,scss,sass,less,styl,vue}']`
 
-Specify the formatter that you would like to use to format your results.
+Specify directories, files, or globs.
 
-### `lintDirtyModulesOnly`
+### `exclude`
 
-- Type: `Boolean`
-- Default: `false`
+- Type: `Array[String]`
+- Default: `['**/node_modules/**', 'virtual:', nuxt.options.buildDir]`
 
-Lint only changed files, skip lint on start.
+Specify the files and/or directories to exclude.
 
 ### `stylelintPath`
 
@@ -110,51 +114,61 @@ Lint only changed files, skip lint on start.
 
 Path to `stylelint` instance that will be used for linting.
 
-### Errors and Warning
+### `formatter`
+
+- Type: `Function`
+- Default: `'string'`
 
-**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:
+Specify the formatter that you would like to use to format your results.
 
-#### `emitError`
+### `lintOnStart`
 
 - Type: `Boolean`
 - Default: `true`
 
-Will always return errors, if set to `true`.
+Check all matching files on project startup, too slow, turn on discreetly.
 
-#### `emitWarning`
+### `emitWarning`
 
 - Type: `Boolean`
 - Default: `true`
 
-Will always return warnings, if set to `true`.
+The warnings found will be printed.
 
-#### `failOnError`
+### `emitError`
 
 - Type: `Boolean`
 - Default: `true`
 
-Will cause the module build to fail if there are any errors, if set to `true`.
+The errors found will be printed.
 
-#### `failOnWarning`
+### `failOnWarning`
 
 - Type: `Boolean`
 - Default: `false`
 
-Will cause the module build to fail if there are any warnings, if set to `true`.
+Will cause the module build to fail if there are any warnings, based on `emitWarning`.
 
-#### `quiet`
+### `failOnError`
 
 - Type: `Boolean`
-- Default: `false`
+- 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:
 
-Will process and report errors only and ignore warnings, if set to `true`.
+[![Edit @nuxtjs/robots](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/nuxt-community/stylelint-module/?fontsize=14&hidenavigation=1&theme=dark)
 
-## Development
+Or locally:
 
 1. Clone this repository
-2. Install dependencies using `yarn install` or `npm install`
-3. Start development server using `npm run dev`
+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