perf: enable cache by default (#327)

* perf: enable cache by default

* test: update with cache

* chore: add stylelintcache

* fix: update `cacheLocation`

* test: update `cacheLocation`

* docs: update `cacheLocation`

Author: ricardogobbosouza

.cspell.json

@@ -13,7 +13,8 @@
     "badstylelintrc",
     "indentifies",
     "stylelintignore",
-    "notcss"
+    "notcss",
+    "stylelintcache"
   ],
 
   "ignorePaths": [

README.md

@@ -76,6 +76,30 @@ module.exports = {
 
 See [stylelint's options](https://stylelint.io/user-guide/usage/node-api#options) for the complete list of options available. These options are passed through to the `stylelint` directly.
 
+### `cache`
+
+- Type:
+
+```ts
+type cache = boolean;
+```
+
+- Default: `true`
+
+The cache is enabled by default to decrease execution time.
+
+### `cacheLocation`
+
+- Type:
+
+```ts
+type cacheLocation = string;
+```
+
+- Default: `node_modules/.cache/stylelint-webpack-plugin/.stylelintcache`
+
+Specify the path to the cache location. Can be a file or a directory.
+
 ### `configFile`
 
 - Type:

src/options.js

@@ -37,6 +37,8 @@ const schema = require('./options.json');
  */
 function getOptions(pluginOptions) {
   const options = {
+    cache: true,
+    cacheLocation: 'node_modules/.cache/stylelint-webpack-plugin/.stylelintcache',
     extensions: ['css', 'scss', 'sass'],
     emitError: true,
     emitWarning: true,

test/stylelint-lint.test.js

@@ -26,7 +26,12 @@ describe('stylelint lint', () => {
 
     compiler.run((err) => {
       const files = [expect.stringMatching('test.scss')];
-      expect(mockLintFiles).toHaveBeenCalledWith({ configFile: null, files });
+      expect(mockLintFiles).toHaveBeenCalledWith({
+        cache: true,
+        cacheLocation: 'node_modules/.cache/stylelint-webpack-plugin/.stylelintcache',
+        configFile: null,
+        files,
+      });
       expect(err).toBeNull();
       done();
     });
@@ -40,7 +45,12 @@ describe('stylelint lint', () => {
         expect.stringMatching(/test[12]\.scss$/),
         expect.stringMatching(/test[12]\.scss$/),
       ];
-      expect(mockLintFiles).toHaveBeenCalledWith({ configFile: null, files });
+      expect(mockLintFiles).toHaveBeenCalledWith({
+        cache: true,
+        cacheLocation: 'node_modules/.cache/stylelint-webpack-plugin/.stylelintcache',
+        configFile: null,
+        files,
+      });
       expect(err).toBeNull();
       done();
     });