@shayanthenerd/eslint-config 0.13.1 → 0.15.0

package/dist/types/index.d.mts

@@ -81,12 +81,15 @@ interface Options {
    * Specify the runtime environment to correctly resolve its built-in modules
   *
   * This is used by
-  * [perfectionist/sort-imports: `env` option](https://perfectionist.dev/rules/sort-imports#environment)
-  * to recognize the environment’s built-in modules when sorting the imports.
+  *
+  * - [ESLint: Specifying Globals](https://eslint.org/docs/latest/use/configure/language-options#using-configuration-files)
+  * - [perfectionist/sort-imports: `env` option](https://perfectionist.dev/rules/sort-imports#environment)
+  *
+  * to recognize the environment’s built-in modules.
   *
   * @default 'node'
   */
-  env?: 'bun' | 'node';
+  env?: 'bun' | 'deno' | 'node' | 'browser';
 
   /**
    * The path and the name of the root TypeScript config file.
@@ -97,16 +100,16 @@ interface Options {
    * - [better-tailwindcss: `tsconfig` option](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/settings/settings.md#tsconfig)
    * - [perfectionist/sort-imports: `tsconfig` option](https://perfectionist.dev/rules/sort-imports#tsconfig)
    *
-   * @default undefined // `{ rootDir: '.', filename: 'tsconfig.json' }` if "typescript" is detected in the package.json file when `autoDetectDeps` is enabled
+   * @default undefined // `{ rootDir: '.', filename: 'tsconfig.json' }` if "typescript" is detected in the dependencies when `autoDetectDeps` is enabled
    */
   tsConfig?: false | {
     /**
      * The directory of the root TypeScript config file.
      *
-    	 * If you don't use TypeScript, provide the directory of the root JavaScript config file.
+      * If you don't use TypeScript, provide the directory of the root JavaScript config file.
      *
      * It will fall back to the default value if set to an empty string (`''`).
-      *
+     *
      * @default '.'
      */
     rootDir: string;
@@ -180,24 +183,38 @@ interface Options {
      *
      * @default
      * {
-     *   node: true,
-     *   commonjs: false,
-     *   browser: true,
      *   worker: true,
-     *   serviceworker: false,
-     *   webextension: false,
+     *   commonjs: false,
+     *   bun: false, // `true` if `env` is set to `bun`
+     *   deno: false, // `true` if `env` is set to `deno`
+     *   node: true,
+     *   nodeBuiltin: false, // `true` if `env` is set to `node`
+     *   browser: true, // `true` if `env` is set to `browser`
+     *   serviceworker: false, // `true` if `env` is set to `browser`
+     *   sharedWorker: false, // `true` if `env` is set to `browser`
+     *   webextension: false, // `true` if `env` is set to `browser`
+     *   audioWorklet: false, // `true` if `env` is set to `browser`
+     *   vitest: false,
+     *   vue: false, // `true` if `configs.vue` is enabled
      *   custom: {},
      * }
      *
      * @see [Language Options: Specifying Globals: Using Configuration Files](https://eslint.org/docs/latest/use/configure/language-options#using-configuration-files)
      */
     globals?: {
-      node?: boolean;
+      worker?: boolean;
       commonjs?: boolean;
+      bun?: boolean;
+      deno?: boolean;
+      node?: boolean;
+      nodeBuiltin?: boolean;
       browser?: boolean;
-      worker?: boolean;
       serviceworker?: boolean;
+      sharedWorker?: boolean;
       webextension?: boolean;
+      audioWorklet?: boolean;
+      vitest?: boolean;
+      vue?: boolean;
       custom?: Linter.LanguageOptions['globals'];
     };
 
@@ -262,11 +279,11 @@ interface Options {
      *
      * Provide the path to your OXLint configuration file (relative to the current working directory) or set to `false` to disable it.
      *
-     * Enabling this improves performance and feedback loops when using OXLint.
+     * Enabling OXLint improves performance and feedback loops.
      *
      * It will fall back to the default value if set to an empty string (`''`).
      *
-     * @default false // `'.oxlintrc.json'` if "oxlint" is detected in the package.json file when `autoDetectDeps` is enabled
+     * @default '.oxlintrc.json'
      */
     oxlint?: false | string;
 
@@ -314,12 +331,12 @@ interface Options {
      * - [eslint-plugin-import-x](https://github.com/un-ts/eslint-plugin-import-x) to better understand imports from TypeScript files such as ".ts", ".tsx", etc.
      * - [eslint-plugin-vue](https://eslint.vuejs.org) to enforce TypeScript-specific rules in the `<script setup lang="ts">` of Vue SFCs.
      *
-     * @default false // `true` if "typescript" is detected in the package.json file when `autoDetectDeps` is enabled
+     * @default false // `true` if "typescript" is detected in the dependencies when `autoDetectDeps` is enabled
      */
     typescript?: boolean | TypeScriptOptions;
 
     /**
-     * Use [eslint-plugin-import-x](https://github.com/un-ts/eslint-plugin-import-x) to organize imports and exports, and detect related issues.
+     * Use [eslint-plugin-import-x](https://github.com/un-ts/eslint-plugin-import-x) and [eslint-plugin-unused-imports](https://github.com/sweepline/eslint-plugin-unused-imports) to organize imports and exports, and detect related issues.
      *
      * @default true
      */
@@ -332,10 +349,17 @@ interface Options {
      */
     perfectionist?: boolean | PerfectionistOptions;
 
+    /**
+     * Use [eslint-plugin-zod-x](https://github.com/marcalexiei/eslint-plugin-zod-x) to enforce Zod best practices.
+     *
+     * @default false // `true` if "zod" is detected in the dependencies when `autoDetectDeps` is enabled
+     */
+    zod?: boolean | ConfigWithOverrides;
+
     /**
      * Use [eslint-plugin-vue](https://eslint.vuejs.org) to enforce Vue best practices, accessibility guidelines, stylistic rules, and identify mistakes.
      *
-     * @default false // `true` if "vue" is detected in the package.json file when `autoDetectDeps` is enabled
+     * @default false // `true` if "vue" is detected in the dependencies when `autoDetectDeps` is enabled
      */
     vue?: boolean | VueOptions;
 
@@ -346,7 +370,7 @@ interface Options {
      *
      * **This configuration requires `configs.vue` to be enabled.**
      *
-     * @default false // `true` if "nuxt" is detected in the package.json file when `autoDetectDeps` is enabled
+     * @default false // `true` if "nuxt" is detected in the dependencies when `autoDetectDeps` is enabled
      */
     nuxt?: boolean | NuxtOptions;
 

package/package.json

@@ -1,125 +1,141 @@
 {
-	"name": "@shayanthenerd/eslint-config",
-	"version": "0.13.1",
-	"license": "MIT",
-	"description": "A modern, flexible ESLint configuration for enforcing best practices and maintaining a consistent coding style",
-	"keywords": [
-		"eslint",
-		"eslint-config",
-		"eslint-flat-config",
-		"eslint-config-vue",
-		"eslint-config-typescript",
-		"oxlint",
-		"oxlint-config"
-	],
-	"homepage": "https://eslint-config.shayan-zamani.me",
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/ShayanTheNerd/eslint-config.git"
-	},
-	"bugs": {
-		"url": "https://github.com/ShayanTheNerd/eslint-config/issues/new?template=bug_report.md"
-	},
-	"author": {
-		"name": "Shayan Zamani",
-		"email": "dev.shayan.zamani@gmail.com",
-		"url": "https://github.com/ShayanTheNerd"
-	},
-	"funding": "https://buymeacoffee.com/shayanthenerd",
-	"files": [
-		"./dist"
-	],
-	"main": "./dist/index.mjs",
-	"module": "./dist/index.mjs",
-	"types": "./dist/index.d.mts",
-	"exports": {
-		".": "./dist/index.mjs",
-		"./package.json": "./package.json",
-		"./types/*": "./dist/types/*",
-		"./oxlint": "./dist/oxlint.config.jsonc",
-		"./prettier": "./dist/prettier.config.mjs"
-	},
-	"publishConfig": {
-		"access": "public"
-	},
-	"imports": {
-		"#utils/*": "./src/utils/*",
-		"#types/*": "./src/types/*",
-		"#rules/*": "./src/rules/*",
-		"#configs/*": "./src/configs/*"
-	},
-	"type": "module",
-	"engines": {
-		"name": "node",
-		"version": "^22.12.0",
-		"onfail": "download"
-	},
-	"packageManager": "pnpm@10.25.0",
-	"scripts": {
-		"prepare": "pnpm git:gitmessage && simple-git-hooks && pnpm generate:types",
-		"prepublishOnly": "pnpm build:package",
-		"git:gitmessage": "git config --local commit.template \".gitmessage\"",
-		"inspect": "eslint-config-inspector",
-		"build:package": "tsdown --no-report",
-		"build:inspector": "eslint-config-inspector build --config=./scripts/defaultESLintConfigReference.ts",
-		"preview:inspector": "serve .eslint-config-inspector",
-		"generate:types": "node ./scripts/generateESLintTypes.ts",
-		"update:actions": "actions-up --yes",
-		"format": "prettier --write '**/*.{json,jsonc,yaml,yml,lock}' --cache",
-		"lint:oxlint": "oxlint --fix",
-		"lint:eslint": "eslint --fix --cache --cache-location=./node_modules/.cache/.eslintcache",
-		"lint": "pnpm lint:oxlint && pnpm lint:eslint",
-		"check:types": "tsc",
-		"check:exports": "attw --pack --profile=esm-only --exclude-entrypoints=./oxlint",
-		"check:spell": "pnpx cspell . --gitignore --exclude='pnpm-lock.yaml' --cache --cache-location='./node_modules/.cache/.cspellcache'",
-		"ci:validate": "pnpm generate:types && pnpm format && pnpm lint && pnpm check:types && pnpm build:inspector && pnpm build:package && pnpm check:exports"
-	},
-	"simple-git-hooks": {
-		"pre-commit": "./node_modules/.bin/nano-staged"
-	},
-	"nano-staged": {
-		"**/*.{js,ts}": "pnpm lint",
-		"**/*.{json,jsonc,yaml,yml,lock}": "pnpm format"
-	},
-	"dependencies": {
-		"@eslint/compat": "2.0.0",
-		"@eslint/css": "0.14.1",
-		"@html-eslint/eslint-plugin": "0.51.0",
-		"@stylistic/eslint-plugin": "5.6.1",
-		"@vitest/eslint-plugin": "1.5.2",
-		"defu": "6.1.4",
-		"eslint": "9.39.2",
-		"eslint-flat-config-utils": "2.1.4",
-		"eslint-import-resolver-typescript": "4.4.4",
-		"eslint-plugin-better-tailwindcss": "3.8.0",
-		"eslint-plugin-cypress": "5.2.0",
-		"eslint-plugin-import-x": "4.16.1",
-		"eslint-plugin-oxlint": "1.33.0",
-		"eslint-plugin-perfectionist": "5.0.0",
-		"eslint-plugin-playwright": "2.4.0",
-		"eslint-plugin-storybook": "10.1.10",
-		"eslint-plugin-unused-imports": "4.3.0",
-		"eslint-plugin-vue": "10.6.2",
-		"eslint-plugin-vuejs-accessibility": "2.4.1",
-		"globals": "16.5.0",
-		"local-pkg": "1.1.2",
-		"oxlint": "1.33.0",
-		"tailwind-csstree": "0.1.4",
-		"typescript-eslint": "8.50.0"
-	},
-	"devDependencies": {
-		"@arethetypeswrong/cli": "0.18.2",
-		"@eslint/config-inspector": "1.4.2",
-		"@types/node": "25.0.3",
-		"actions-up": "1.7.0",
-		"eslint-typegen": "2.3.0",
-		"nano-staged": "0.9.0",
-		"prettier": "3.7.4",
-		"publint": "0.3.16",
-		"serve": "14.2.5",
-		"simple-git-hooks": "2.13.1",
-		"tsdown": "0.18.1",
-		"typescript": "5.9.3",
-		"unplugin-unused": "0.5.6"
-	}
+  "name": "@shayanthenerd/eslint-config",
+  "version": "0.15.0",
+  "license": "MIT",
+  "description": "A modern, flexible ESLint configuration for enforcing best practices and maintaining a consistent coding style",
+  "keywords": [
+    "eslint",
+    "eslint-config",
+    "eslint-flat-config",
+    "eslint-config-vue",
+    "eslint-config-typescript",
+    "oxlint",
+    "oxlint-config"
+  ],
+  "homepage": "https://eslint-config.shayan-zamani.me",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ShayanTheNerd/eslint-config.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ShayanTheNerd/eslint-config/issues/new?template=bug_report.md"
+  },
+  "author": {
+    "name": "Shayan Zamani",
+    "email": "dev.shayan.zamani@gmail.com",
+    "url": "https://github.com/ShayanTheNerd"
+  },
+  "funding": "https://buymeacoffee.com/shayanthenerd",
+  "files": [
+    "./dist"
+  ],
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json",
+    "./types/*": "./dist/types/*",
+    "./oxlint": "./dist/oxlint.config.jsonc",
+    "./prettier": "./dist/prettier.config.mjs"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "imports": {
+    "#configs/*": "./src/configs/*",
+    "#helpers/*": "./src/helpers/*",
+    "#rules/*": "./src/rules/*",
+    "#types/*": "./src/types/*",
+    "#utils/*": "./src/utils/*"
+  },
+  "type": "module",
+  "engines": {
+    "name": "node",
+    "version": "^22.18.0",
+    "onfail": "download"
+  },
+  "packageManager": "pnpm@10.27.0",
+  "scripts": {
+    "prepare": "pnpm git:gitmessage && simple-git-hooks && pnpm generate:types",
+    "prepublishOnly": "pnpm build:package",
+    "git:gitmessage": "git config --local commit.template \".gitmessage\"",
+    "inspect": "eslint-config-inspector",
+    "build:package": "tsdown --no-report",
+    "build:inspector": "eslint-config-inspector build --config=./scripts/defaultESLintConfigReference.ts",
+    "preview:inspector": "serve .eslint-config-inspector",
+    "generate:types": "node ./scripts/generateESLintTypes.ts",
+    "update:actions": "actions-up --yes",
+    "format": "prettier --write '**/*.{json,jsonc,yaml,yml,lock}' --cache",
+    "lint:oxlint": "oxlint --fix",
+    "lint:eslint": "eslint --fix --cache --cache-location=./node_modules/.cache/.eslintcache",
+    "lint": "pnpm lint:oxlint && pnpm lint:eslint",
+    "check:types": "tsc",
+    "check:exports": "attw --pack --profile=esm-only --exclude-entrypoints=./oxlint",
+    "check:spell": "pnpx cspell . --gitignore --exclude='pnpm-lock.yaml' --cache --cache-location='./node_modules/.cache/.cspellcache'",
+    "ci:validate": "pnpm generate:types && pnpm format && pnpm lint && pnpm check:types && pnpm build:inspector && pnpm build:package && pnpm check:exports"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "./node_modules/.bin/nano-staged"
+  },
+  "nano-staged": {
+    "eslint.config.ts": "pnpm lint",
+    "prettier.config.ts": "pnpm format",
+    "**/*.{js,ts}": "pnpm lint",
+    "**/*.{json,jsonc,yaml,yml,lock}": "pnpm format"
+  },
+  "dependencies": {
+    "@eslint/compat": "2.0.0",
+    "@eslint/css": "0.14.1",
+    "@html-eslint/eslint-plugin": "0.52.1",
+    "@stylistic/eslint-plugin": "5.6.1",
+    "@vitest/eslint-plugin": "1.6.5",
+    "defu": "6.1.4",
+    "eslint": "9.39.2",
+    "eslint-flat-config-utils": "2.1.4",
+    "eslint-import-resolver-typescript": "4.4.4",
+    "eslint-plugin-better-tailwindcss": "3.8.0",
+    "eslint-plugin-cypress": "5.2.1",
+    "eslint-plugin-import-x": "4.16.1",
+    "eslint-plugin-oxlint": "1.38.0",
+    "eslint-plugin-perfectionist": "5.3.0",
+    "eslint-plugin-playwright": "2.4.0",
+    "eslint-plugin-storybook": "10.1.11",
+    "eslint-plugin-unused-imports": "4.3.0",
+    "eslint-plugin-vue": "10.6.2",
+    "eslint-plugin-vuejs-accessibility": "2.4.1",
+    "eslint-plugin-zod-x": "2.0.0",
+    "globals": "17.0.0",
+    "local-pkg": "1.1.2",
+    "oxlint": "1.38.0",
+    "tailwind-csstree": "0.1.4",
+    "typescript-eslint": "8.52.0"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "0.18.2",
+    "@eslint/config-inspector": "1.4.2",
+    "@types/node": "25.0.3",
+    "actions-up": "1.8.0",
+    "eslint-typegen": "2.3.0",
+    "nano-staged": "0.9.0",
+    "prettier": "3.7.4",
+    "publint": "0.3.16",
+    "serve": "14.2.5",
+    "simple-git-hooks": "2.13.1",
+    "tsdown": "0.18.3",
+    "typescript": "5.9.3",
+    "unplugin-unused": "0.5.6"
+  },
+  "peerDependencies": {
+    "eslint": "^9.28.0",
+    "oxlint": "^1.37.0"
+  },
+  "peerDependenciesMeta": {
+    "eslint": {
+      "optional": true
+    },
+    "oxlint": {
+      "optional": true
+    }
+  }
 }