docs: do not add --fix to lint command

fi3ework · Jan 3, 2023 · 990a088 · 990a088
1 parent 034a7ad
commit 990a088
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/docs/checkers/eslint.md b/docs/checkers/eslint.md
@@ -11,13 +11,16 @@
 
 2. Add `eslint` field to plugin config and `options.eslint.lintCommand` is required. The `lintCommand` is the same as the lint command of your project. The default root of the command uses Vite's [root](https://vitejs.dev/config/#root).
 
+   Do not add `--fix` to the lint command since the plugin is only aiming at check issues.
+
    ```js
    // e.g.
    export default {
      plugins: [
        checker({
          eslint: {
-           lintCommand: 'eslint "./src/**/*.{ts,tsx}"', // for example, lint .ts & .tsx
+           // for example, lint .ts and .tsx
+           lintCommand: 'eslint "./src/**/*.{ts,tsx}"',
          },
        }),
      ],

diff --git a/docs/checkers/stylelint.md b/docs/checkers/stylelint.md
@@ -11,13 +11,16 @@
 
 2. Add `stylelint` field to plugin config and `options.stylelint.lintCommand` is required. The `lintCommand` is the same as the lint command of your project. The default root of the command uses Vite's [root](https://vitejs.dev/config/#root).
 
+   Do not add `--fix` to the lint command since the plugin is only aiming at check issues.
+
    ```js
    // e.g.
    export default {
      plugins: [
        checker({
          stylelint: {
-           lintCommand: 'stylelint ./src/**/*.{css,vue}', // for example, lint .css & .vue
+           // for example, lint .css and .vue
+           lintCommand: 'stylelint ./src/**/*.{css,vue}',
          },
        }),
      ],