@ntnyq/eslint-config 5.0.0-beta.2 → 5.0.0-beta.4

package/README.md

@@ -49,9 +49,30 @@ Highly recommended using **`eslint.config.mjs`** as the config file :
 
 import { defineESLintConfig } from '@ntnyq/eslint-config'
 
-export default defineESLintConfig({
+export default defineESLintConfig(
   // Options here
-})
+  {
+    // Enable a config
+    svgo: true,
+    // Disable a config
+    jsdoc: false,
+    vue: {
+      // Overrides built-in rules
+      overrides: {
+        'vue/slot-name-casing': 'off',
+      },
+    },
+  },
+  // Optional user configs here
+  [
+    {
+      files: ['**/utils/*.ts'],
+      rules: {
+        'antfu/top-level-function': 'error',
+      },
+    },
+  ],
+)
 ```
 
 Add scripts `lint` in `package.json`:
@@ -94,11 +115,9 @@ bun add prettier @ntnyq/prettier-config -D
 // prettier.config.mjs
 // @ts-check
 
-import { config, defineConfig } from '@ntnyq/prettier-config'
+import { defineConfig } from '@ntnyq/prettier-config'
 
 export default defineConfig({
-  ...config,
-
   // overrides if needed
   overrides: [
     {
@@ -204,11 +223,8 @@ export interface ConfigOptions {
   command?: ConfigCommandOptions
   eslintComments?: ConfigESLintCommentsOptions
   ignores?: ConfigIgnoresOptions
-  importX?: ConfigImportXOptions
   javascript?: ConfigJavaScriptOptions
-  jsdoc?: ConfigJsdocOptions
   node?: ConfigNodeOptions
-  specials?: ConfigSpecialsOptions
 
   /**
    * Configs bellow can be disabled
@@ -218,6 +234,8 @@ export interface ConfigOptions {
   depend?: boolean | ConfigDependOptions
   githubAction?: boolean | ConfigGitHubActionOptions
   gitignore?: boolean | ConfigGitIgnoreOptions
+  importX?: boolean | ConfigImportXOptions
+  jsdoc?: boolean | ConfigJsdocOptions
   jsonc?: boolean | ConfigJsoncOptions
   markdown?: boolean | ConfigMarkdownOptions
   ntnyq?: boolean | ConfigNtnyqOptions
@@ -226,6 +244,7 @@ export interface ConfigOptions {
   prettier?: boolean | ConfigPrettierOptions
   regexp?: boolean | ConfigRegexpOptions
   sort?: boolean | ConfigSortOptions
+  specials?: boolean | ConfigSpecialsOptions
   test?: boolean | ConfigTestOptions
   toml?: boolean | ConfigTomlOptions
   typescript?: boolean | ConfigTypeScriptOptions
@@ -240,6 +259,7 @@ export interface ConfigOptions {
   astro?: boolean | ConfigAstroOptions
   html?: boolean | ConfigHtmlOptions
   pnpm?: boolean | ConfigPnpmOptions
+  svelte?: boolean | ConfigSvelteOptions
   svgo?: boolean | ConfigSVGOOptions
   eslintPlugin?: boolean | ConfigESLintPluginOptions
 }