@coderwyd/eslint-config 1.1.0-beta.2 → 1.1.0-beta.3

package/README.md

@@ -26,6 +26,8 @@ pnpm i -D eslint @coderwyd/eslint-config
 
 ### Create config file
 
+With [`"type": "module"`](https://nodejs.org/api/packages.html#type) in `package.json` (recommended):
+
 ```js
 // eslint.config.js
 import coderwyd from '@coderwyd/eslint-config'
@@ -33,6 +35,15 @@ import coderwyd from '@coderwyd/eslint-config'
 export default coderwyd()
 ```
 
+With CJS:
+
+```js
+// eslint.config.js
+const coderwyd = require('@coderwyd/eslint-config').default
+
+module.exports = coderwyd()
+```
+
 > Note that `.eslintignore` no longer works in Flat config, see [customization](#customization) for more details.
 
 ### Add script for package.json
@@ -100,7 +111,7 @@ Add the following settings to your `.vscode/settings.json`:
 
 ## Customization
 
-Since v1.0, we migrated to [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), provides a much better organization and composition.
+Since v1.0, we migrated to [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new). It provides a much better organization and composition.
 
 Normally you only need to import the `coderwyd` preset:
 
@@ -132,7 +143,7 @@ export default coderwyd({
 })
 ```
 
-The `coderwyd` factory functions also accepts arbitrary numbers of constom configs overrides:
+The `coderwyd` factory function also accepts any number of arbitrary custom config overrides:
 
 ```js
 // eslint.config.js
@@ -155,7 +166,7 @@ export default coderwyd(
 )
 ```
 
-Going more advanced, you can also import the very fine-grained configs and compose them as you wish:
+Going more advanced, you can also import fine-grained configs and compose them as you wish:
 
 ```js
 // eslint.config.js
@@ -211,8 +222,10 @@ Since flat config requires us to explicitly provide the plugin names (instead of
 | `yaml/*` | `yml/*` | [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml) |
 | `ts/*` | `@typescript-eslint/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) |
 | `style/*` | `@stylistic/*` | [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic) |
+| `test/*` | `vitest/*` | [eslint-plugin-vitest](https://github.com/veritem/eslint-plugin-vitest) |
+| `test/*` | `no-only-tests/*` | [eslint-plugin-no-only-tests](https://github.com/levibuzolic/eslint-plugin-no-only-tests) |
 
-When you want to overrides rules, or disable them inline, you need to update to the new prefix:
+When you want to override rules, or disable them inline, you need to update to the new prefix:
 
 ```diff
 -// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
@@ -229,7 +242,24 @@ Certain rules would only be enabled in specific files, for example, `ts/*` rules
 import coderwyd from '@coderwyd/eslint-config'
 
 export default coderwyd(
-  { vue: true, typescript: true },
+  {
+    // Enable stylistic formatting rules
+    // stylistic: true,
+
+    // Or customize the stylistic rules
+    stylistic: {
+      indent: 2, // 4, or 'tab'
+      quotes: 'single', // or 'double'
+    },
+
+    // TypeScript and Vue are auto-detected, you can also explicitly enable them:
+    typescript: true,
+    vue: true,
+
+    // Disable jsonc and yaml support
+    jsonc: false,
+    yaml: false,
+  },
   {
     // Remember to specify the file glob here, otherwise it might cause the vue plugin to handle non-vue files
     files: ['**/*.vue'],