chore: add comments to explain the default format script

haoqunjiang · haoqunjiang · commit 1f3e74757550 · 2024-11-04T23:54:37.000+08:00
diff --git a/index.js b/index.js
@@ -84,6 +84,11 @@ export default function createConfig({
         },
       ],
     })
+
+    // Default to only format the `src/` directory to avoid too much noise, and
+    // the need for a `.prettierignore` file.
+    // Users can still append any paths they'd like to format to the command,
+    // e.g. `npm run format cypress/`.
     pkg.scripts.format = 'prettier --write src/'
   }
 
