@ntnyq/eslint-config 3.0.0-beta.10 → 3.0.0-beta.12

package/README.md

@@ -14,7 +14,7 @@ pnpm add eslint prettier typescript @ntnyq/eslint-config @ntnyq/prettier-config
 
 ## Usage
 
-Config in `eslint.config.{mjs,mts}`:
+Highly recommended for using `eslint.config.mjs` as the config file :
 
 ```js
 import { ntnyq } from '@ntnyq/eslint-config'
@@ -22,12 +22,15 @@ import { ntnyq } from '@ntnyq/eslint-config'
 export default ntnyq()
 ```
 
-Config in `eslint.config.{cjs,cts}`
+Add scripts `lint` in `package.json`:
 
-```js
-const ntnyq = require('@ntnyq/eslint-config')
-
-module.exports = ntnyq()
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
 ```
 
 ## VSCode Config
@@ -57,6 +60,102 @@ module.exports = ntnyq()
 }
 ```
 
+## Lint changed files only
+
+### 1. Add dependencies
+
+```bash
+pnpm add husky nano-staged -D
+```
+
+### 2. Config `package.json`
+
+```json
+{
+  "scripts": {
+    "prepare": "husky"
+  },
+  "nano-staged": {
+    "*.{js,ts,cjs,mjs,vue,md,yml,yaml,json,html}": "eslint --fix"
+  }
+}
+```
+
+### 3. Add a hook
+
+```bash
+echo "nano-staged" > .husky/pre-commit
+```
+
+## Advanced config
+
+Check for detail in:
+
+- [./src/types/config.ts](https://github.com/ntnyq/eslint-config/blob/main/src/types/config.ts)
+- [./src/core.ts](https://github.com/ntnyq/eslint-config/blob/main/src/core.ts)
+
+### Config interface
+
+```typescript
+export interface ConfigOptions {
+  sortTsConfig?: boolean
+
+  sortI18nLocale?: boolean
+
+  sortPackageJson?: boolean
+
+  ignores?: ConfigIgnoresOptions
+
+  command?: boolean | ConfigCommandOptions
+
+  gitignore?: boolean | ConfigGitIgnoreOptions
+
+  imports?: ConfigImportsOptions
+
+  node?: ConfigNodeOptions
+
+  javascript?: ConfigJavaScriptOptions
+
+  typescript?: boolean | ConfigTypeScriptOptions
+
+  unicorn?: boolean | ConfigUnicornOptions
+
+  prettier?: boolean | ConfigPrettierOptions
+
+  perfectionist?: boolean | ConfigPerfectionistOptions
+
+  /**
+   * @internal
+   */
+  unusedImports?: boolean | ConfigUnusedImportsOptions
+
+  /**
+   * @internal
+   */
+  antfu?: boolean | ConfigAntfuOptions
+
+  comments?: boolean | ConfigCommentsOptions
+
+  jsdoc?: boolean | ConfigJsdocOptions
+
+  unocss?: boolean | ConfigUnoCSSOptions
+
+  regexp?: boolean | ConfigRegexpOptions
+
+  jsonc?: boolean | ConfigJsoncOptions
+
+  yml?: boolean | ConfigYmlOptions
+
+  markdown?: boolean | ConfigMarkdownOptions
+
+  toml?: boolean | ConfigTomlOptions
+
+  vue?: boolean | ConfigVueOptions
+
+  vitest?: boolean | ConfigVitestOptions
+}
+```
+
 ## Credits
 
 - [@sxzz/eslint-config](https://github.com/sxzz/eslint-config)

package/dist/index.cjs

@@ -317,7 +317,7 @@ var typescript = (options = {}) => [
   ...typescriptCore(options),
   {
     name: "ntnyq/ts/dts",
-    files: [GLOB_DTS],
+    files: [GLOB_DTS, "**/types/**/*.ts"],
     rules: {
       "no-use-before-define": "off",
       "no-restricted-syntax": "off",
@@ -1622,8 +1622,8 @@ var perfectionist = (options = {}) => [
              */
             "unknown"
           ],
-          order: "asc",
-          type: "natural",
+          order: options.imports?.order || "asc",
+          type: options.imports?.type || "natural",
           ignoreCase: true,
           internalPattern: ["~/**", "@/**", "#**"],
           newlinesBetween: "ignore"
@@ -1632,15 +1632,15 @@ var perfectionist = (options = {}) => [
       "perfectionist/sort-exports": [
         "error",
         {
-          order: "asc",
-          type: "line-length"
+          order: options.exports?.order || "asc",
+          type: options.exports?.type || "line-length"
         }
       ],
       "perfectionist/sort-named-exports": [
         "error",
         {
-          type: "alphabetical",
-          order: "asc",
+          type: options.namedExports?.type || "alphabetical",
+          order: options.namedExports?.order || "asc",
           ignoreCase: true,
           groupKind: "values-first"
         }
@@ -1648,8 +1648,8 @@ var perfectionist = (options = {}) => [
       "perfectionist/sort-named-imports": [
         "error",
         {
-          type: "alphabetical",
-          order: "asc",
+          type: options.namedImports?.type || "alphabetical",
+          order: options.namedImports?.order || "asc",
           ignoreCase: true,
           ignoreAlias: false,
           groupKind: "values-first"
@@ -1672,12 +1672,16 @@ var unusedImports = (options = {}) => [
       "@typescript-eslint/no-unused-vars": "off",
       "unused-imports/no-unused-imports": "error",
       "unused-imports/no-unused-vars": [
-        "warn",
+        "error",
         {
           vars: "all",
           varsIgnorePattern: "^_",
           args: "after-used",
-          argsIgnorePattern: "^_"
+          argsIgnorePattern: "^_",
+          ignoreRestSiblings: true,
+          destructuredArrayIgnorePattern: "^_",
+          caughtErrors: "all",
+          caughtErrorsIgnorePattern: "^_"
         }
       ],
       // Overrides built-in rules
@@ -1756,6 +1760,7 @@ function ntnyq(options = {}, userConfigs = []) {
   if (options.perfectionist ?? true) {
     configs.push(
       ...perfectionist({
+        ...resolveSubOptions(options, "perfectionist"),
         overrides: getOverrides(options, "perfectionist")
       })
     );