@shayanthenerd/eslint-config 0.1.0 → 0.4.0

package/README.md

@@ -1,4 +1,4 @@
-# @shayanthenerd/eslint-config    [![NPM Version](https://img.shields.io/npm/v/@shayanthenerd/eslint-config?label=&logo=npm&logoColor=DDDDDD&labelColor=212121&color=212121&registry_uri=https://registry.npmjs.com/@shayanthenerd/eslint-config&link=https://github.com/ShayanTheNerd/eslint-config)](https://www.npmjs.com/package/@shayanthenerd/eslint-config) [![JSR Registry](https://jsr.io/badges/@shayanthenerd?logoColor=DDDDDD&labelColor=212121&color=212121)](https://jsr.io/@shayanthenerd/eslint-config) [![License MIT](https://img.shields.io/badge/License-MIT-blue.svg?labelColor=212121&color=212121)](https://github.com/ShayanTheNerd/eslint-config/blob/main/LICENSE)
+# @shayanthenerd/eslint-config    [![NPM Version](https://img.shields.io/npm/v/@shayanthenerd/eslint-config?label=&logo=npm&logoColor=EEEEEE&labelColor=545A61&color=545A61&registry_uri=https://registry.npmjs.com/@shayanthenerd/eslint-config&link=https://github.com/ShayanTheNerd/eslint-config)](https://www.npmjs.com/package/@shayanthenerd/eslint-config) [![License MIT](https://img.shields.io/badge/License-MIT-blue.svg?labelColor=545A61&color=545A61)](https://github.com/ShayanTheNerd/eslint-config/blob/main/LICENSE) [![Netlify Status](https://api.netlify.com/api/v1/badges/8ed76fdd-5aa7-446a-89fa-c916f8cce0de/deploy-status)](https://eslint-config.shayan-zamani.me)
 
 A modern, flexible ESLint configuration for enforcing best practices and maintaining a consistent coding style.
 
@@ -8,7 +8,7 @@ A modern, flexible ESLint configuration for enforcing best practices and maintai
 - **Automatic Formatting**: Fine-grained control over formatting with [ESLint Stylistic](https://eslint.style), eliminating the need for Prettier
 - **Smart Defaults**: Respects your _.gitignore_ file and provides reasonable, opinionated, yet [highly customizable](#customization) defaults
 - **Developer-friendly**: Easy to use and well-documented with JSDoc
-- **Modern**: Requires Node.js v20.12.0+ and ESLint v9.28.0+
+- **Modern**: Requires Node.js v20.12.0+ and ESLint v9.28.0+ (ESM-only)
 
 > [!NOTE]
 > This configuration is designed with a flexible API for easy customization. However, it remains a **personal config**. While its primary goal is to enforce best practices and maintain code consistency, some rules—particularly stylistic ones—are rather opinionated. <br /> If the available customization and override options still don't meet your requirements, feel free to fork the project and tailor it to your needs.
@@ -34,9 +34,7 @@ A modern, flexible ESLint configuration for enforcing best practices and maintai
 npm i -D @shayanthenerd/eslint-config
 ```
 
-OXLint and all necessary ESLint plugins and parsers will be installed automatically, so you don't need to install them separately.
-
-If you're using TypeScript and see [eslint-plugin-import-x](https://github.com/un-ts/eslint-plugin-import-x) fail to resolve imports, you should also install [eslint-import-resolver-typescript](https://github.com/import-js/eslint-import-resolver-typescript) as a dev dependency.
+OXLint and all necessary ESLint plugins and parsers will be installed automatically.
 
 2. Create an ESLint config file (_eslint.config.js_) at the root of your project:
 ```js
@@ -45,7 +43,23 @@ import { defineConfig } from '@shayanthenerd/eslint-config';
 export default defineConfig();
 ```
 
-You can also use a TypeScript file (_eslint.config.ts_) for your ESLint configuration. Depending on your Node.js version, [additional setup](https://eslint.org/docs/latest/use/configure/configuration-files#typescript-configuration-files) may be required.
+You can also use a TypeScript file (_eslint.config.ts_). Depending on your Node.js version, [additional setup](https://eslint.org/docs/latest/use/configure/configuration-files#typescript-configuration-files) may be required.
+
+If you're using Nuxt, install [@nuxt/eslint](https://eslint.nuxt.com) as a dev dependency:
+```shell
+npm i -D @nuxt/eslint
+```
+
+Then, update your ESLint config file:
+```js
+import { defineConfig } from '@shayanthenerd/eslint-config';
+
+import eslintConfigNuxt from './.nuxt/eslint.config.mjs';
+
+const eslintConfig = defineConfig();
+
+export default eslintConfigNuxt(eslintConfig);
+```
 
 3. Create an OXLint config file (_.oxlintrc.json_) in the root of your project:
 ```jsonc
@@ -123,7 +137,7 @@ npm i -D prettier
 
 2. Create a Prettier config file (_prettier.config.js_) in the root of your project:
 ```js
-import prettierConfig from '@shayanthenerd/eslint-config/prettier.config.js';
+import prettierConfig from '@shayanthenerd/eslint-config/prettier';
 
 /** @type {import('prettier').Config} */
 export default {
@@ -159,6 +173,7 @@ Install VS Code extensions for [ESLint](https://marketplace.visualstudio.com/ite
     /* Imports are sorted and organized with eslint-plugin-perfectionist. */
     "source.sortImports": "never",
     "source.organizeImports": "never",
+    "source.removeUnusedImports": "never",
 
     /* Apply OXLint and ESLint automatic fixes on file save. */
     "source.fixAll.oxc": "explicit",
@@ -232,7 +247,7 @@ Since OXLint and ESLint use separate config files, customizations made in your E
   ],
 
   /* OXLint respects the ignore patterns defined in `.gitignore` and `.eslintignore` files by default. */
-  "ignorePatterns": ["**/*.min.*", "**/oxlint-schema.d.ts"]
+  "ignorePatterns": ["**/*.min.*"]
 }
 ```
 
@@ -384,7 +399,8 @@ interface options {
       overrides?: {},
     },
     importX?: boolean | {
-      requireFileExtension?: 'always' | 'never',
+			removeUnusedImports?: boolean,
+      requireFileExtension?: boolean,
       overrides?: {},
     },
     perfectionist?: boolean | {

package/dist/configs/base.js

@@ -13,8 +13,8 @@ function getBaseConfig(options) {
 		files: [globs.src, vue ? globs.vue : ""],
 		extends: [javascriptESLint.configs.recommended],
 		languageOptions: {
+			parser: typescriptESLint.parser,
 			parserOptions: {
-				parser: typescriptESLint.parser,
 				ecmaVersion: "latest",
 				ecmaFeatures: {
 					jsx: true,

package/dist/configs/commons.js

@@ -3,14 +3,15 @@ import typescriptESLint from "typescript-eslint";
 
 //#region src/configs/commons.ts
 function getCommonsConfig(options) {
+	const { typescript, base: { preferNamedExports } } = options.configs;
 	const commonsConfig = {
 		name: "shayanthenerd/commons",
 		files: [globs.commons],
 		ignores: [globs.commonsIgnore],
 		plugins: { "@typescript-eslint": typescriptESLint.plugin },
 		rules: {
-			"@typescript-eslint/explicit-function-return-type": "error",
-			"no-restricted-exports": [options.configs.base.preferNamedExports ? "error" : "off", { restrictDefaultExports: {
+			"@typescript-eslint/explicit-function-return-type": typescript ? "error" : "off",
+			"no-restricted-exports": [preferNamedExports ? "error" : "off", { restrictDefaultExports: {
 				named: true,
 				direct: true,
 				namedFrom: true,

package/dist/configs/importX.js

@@ -3,19 +3,39 @@ import { isEnabled } from "../utils/isEnabled.js";
 import { defaultOptions } from "../utils/options/defaultOptions.js";
 import { getImportXRules } from "../rules/importX.js";
 import { mergeConfigs } from "eslint-flat-config-utils";
+import eslintPluginImport from "eslint-plugin-import";
 import eslintPluginImportX from "eslint-plugin-import-x";
 import eslintPluginUnusedImports from "eslint-plugin-unused-imports";
 
 //#region src/configs/importX.ts
+eslintPluginImport.flatConfigs.recommended.rules = {};
 function getImportXConfig(options) {
 	const { vue, importX, typescript } = options.configs;
 	const { overrides } = isEnabled(importX) ? importX : defaultOptions.configs.importX;
 	const importXConfig = {
 		name: "shayanthenerd/import-x",
 		files: [globs.src, vue ? globs.vue : ""],
-		extends: [eslintPluginImportX.flatConfigs.recommended, typescript ? eslintPluginImportX.flatConfigs.typescript : {}],
+		extends: [
+			eslintPluginImport.flatConfigs.recommended,
+			eslintPluginImportX.flatConfigs.recommended,
+			typescript ? eslintPluginImport.flatConfigs.typescript : {},
+			typescript ? eslintPluginImportX.flatConfigs.typescript : {}
+		],
 		plugins: { "unused-imports": eslintPluginUnusedImports },
-		settings: { "import-x/extensions": vue ? [".vue"] : void 0 },
+		settings: {
+			"import/resolver": { typescript: true },
+			"import/extensions": [
+				".js",
+				".cjs",
+				".mjs",
+				".jsx",
+				".ts",
+				".cts",
+				".mts",
+				".tsx",
+				".vue"
+			]
+		},
 		rules: getImportXRules(options)
 	};
 	return mergeConfigs(importXConfig, overrides);

package/dist/configs/oxlintOverrides.js

@@ -5,6 +5,7 @@ import { getVitestRules } from "../rules/vitest.js";
 import { getImportXRules } from "../rules/importX.js";
 import { getPlaywrightRules } from "../rules/playwright.js";
 import { getTypeScriptRules } from "../rules/typescript.js";
+import typescriptESLint from "typescript-eslint";
 import eslintPluginVitest from "@vitest/eslint-plugin";
 import eslintPluginImportX from "eslint-plugin-import-x";
 import eslintPluginPlaywright from "eslint-plugin-playwright";
@@ -28,7 +29,8 @@ function getOXLintOverridesConfig(options) {
 		plugins: {
 			"vitest": eslintPluginVitest,
 			"import-x": eslintPluginImportX,
-			"playwright": eslintPluginPlaywright
+			"playwright": eslintPluginPlaywright,
+			"@typescript-eslint": typescriptESLint.plugin
 		},
 		rules: {
 			"max-depth": javascriptRules["max-depth"],

package/dist/configs/tailwind.js

@@ -13,7 +13,7 @@ const eslintParserHTML = eslintPluginHTML.configs["flat/recommended"].languageOp
 const eslintParserVue = eslintPluginVue.configs["flat/recommended"].find((config) => config.name === "vue/base/setup-for-vue")?.languageOptions?.parser;
 function getTailwindConfig(options) {
 	const { tsConfig, configs: { vue, html, tailwind } } = options;
-	const { entryPoint, config, overrides } = isEnabled(tailwind) ? tailwind : defaultOptions.configs.tailwind;
+	const { config, entryPoint, overrides } = isEnabled(tailwind) ? tailwind : defaultOptions.configs.tailwind;
 	const tailwindConfig = {
 		name: "shayanthenerd/tailwind",
 		files: [
@@ -24,8 +24,8 @@ function getTailwindConfig(options) {
 		plugins: { "better-tailwindcss": eslintPluginTailwind },
 		languageOptions: { parserOptions: { parser: html ? eslintParserHTML : eslintParserVue } },
 		settings: { "better-tailwindcss": {
-			entryPoint: path.resolve(entryPoint),
-			tailwindConfig: path.resolve(config),
+			entryPoint,
+			tailwindConfig: config,
 			tsconfig: tsConfig ? path.resolve(tsConfig.rootDir, tsConfig.filename) : void 0,
 			attributes: [["^v-bind:ui$", [{ match: "objectValues" }]], ["^(?:v-bind:)?(class|activeClass|inactiveClass)$", [
 				{ match: "strings" },

package/dist/configs/typescript.js

@@ -12,7 +12,7 @@ function getTypeScriptConfig(options) {
 	const { overrides } = isEnabled(typescript) ? typescript : defaultOptions.configs.typescript;
 	const typescriptConfig = {
 		name: "shayanthenerd/typescript",
-		files: [globs.src, vue ? globs.vue : ""],
+		files: [globs.ts, vue ? globs.vue : ""],
 		extends: [typescriptESLint.configs.strictTypeChecked, typescriptESLint.configs.stylisticTypeChecked],
 		languageOptions: { parserOptions: {
 			tsconfigRootDir: tsConfig ? tsConfig.rootDir : void 0,

package/dist/prettier.config.d.ts

@@ -0,0 +1,6 @@
+import { Config } from "prettier";
+
+//#region src/prettier.config.d.ts
+declare const prettierConfig: Config;
+//#endregion
+export { prettierConfig as default };

package/dist/prettier.config.js

@@ -1,5 +1,5 @@
-/** @type {import('prettier').Config} */
-export default {
+//#region src/prettier.config.ts
+const prettierConfig = {
 	semi: true,
 	useTabs: true,
 	tabWidth: 2,
@@ -7,36 +7,32 @@ export default {
 	printWidth: 120,
 	singleQuote: true,
 	jsxSingleQuote: false,
-	quoteProps: 'consistent',
+	quoteProps: "consistent",
 	insertPragma: false,
 	requirePragma: false,
 	bracketSpacing: true,
 	bracketSameLine: false,
-	endOfLine: 'lf',
-	trailingComma: 'all',
-	arrowParens: 'always',
-	proseWrap: 'preserve',
-	objectWrap: 'preserve',
+	endOfLine: "lf",
+	trailingComma: "all",
+	arrowParens: "always",
+	proseWrap: "preserve",
+	objectWrap: "preserve",
 	singleAttributePerLine: false,
-	htmlWhitespaceSensitivity: 'css',
-	embeddedLanguageFormatting: 'auto',
+	htmlWhitespaceSensitivity: "css",
+	embeddedLanguageFormatting: "auto",
 	rangeStart: 0,
 	rangeEnd: Number.POSITIVE_INFINITY,
 	experimentalTernaries: false,
-	experimentalOperatorPosition: 'end',
-
-	overrides: [
-		{
-			files: ['*.jsonc', 'bun.lock'],
-			options: {
-				parser: 'json',
-			},
-		},
-		{
-			files: '*.svg',
-			options: {
-				parser: 'html',
-			},
-		},
-	],
+	experimentalOperatorPosition: "end",
+	overrides: [{
+		files: ["*.jsonc", "bun.lock"],
+		options: { parser: "json" }
+	}, {
+		files: "*.svg",
+		options: { parser: "html" }
+	}]
 };
+var prettier_config_default = prettierConfig;
+
+//#endregion
+export { prettier_config_default as default };

package/dist/rules/importX.js

@@ -5,9 +5,18 @@ import path from "node:path";
 //#region src/rules/importX.ts
 function getImportXRules(options) {
 	const { packageDir, configs: { importX } } = options;
-	const { requireFileExtension } = isEnabled(importX) ? importX : defaultOptions.configs.importX;
+	const { removeUnusedImports, requireFileExtension } = isEnabled(importX) ? importX : defaultOptions.configs.importX;
 	const importXRules = {
-		"unused-imports/no-unused-imports": "warn",
+		"unused-imports/no-unused-imports": removeUnusedImports ? "warn" : "off",
+		"import-x/extensions": "off",
+		"import/extensions": [
+			requireFileExtension ? "warn" : "off",
+			"always",
+			{
+				ignorePackages: true,
+				checkTypeImports: true
+			}
+		],
 		"import-x/no-amd": "error",
 		"import-x/exports-last": "warn",
 		"import-x/no-commonjs": "error",
@@ -32,16 +41,7 @@ function getImportXRules(options) {
 		"import-x/no-extraneous-dependencies": ["error", {
 			includeTypes: true,
 			packageDir: path.resolve(packageDir)
-		}],
-		"import-x/extensions": [
-			"error",
-			requireFileExtension,
-			{
-				fix: true,
-				ignorePackages: true,
-				checkTypeImports: true
-			}
-		]
+		}]
 	};
 	return importXRules;
 }

package/dist/rules/vue.js

@@ -12,9 +12,11 @@ function getVueRules(options) {
 	const nuxtUI = isEnabled(nuxt) ? nuxt.ui : void 0;
 	const nuxtUIPrefix = isEnabled(nuxt) && isEnabled(nuxt.ui) ? nuxt.ui.prefix : void 0;
 	const isScriptLangTS = blockLang.script === "ts";
+	const isStyleLangImplicit = blockLang.style === "implicit";
 	const vueRules = {
 		"no-undef": "off",
 		"no-useless-assignment": "off",
+		"import-x/default": "off",
 		"vue/comment-directive": ["error", { reportUnusedDisableDirectives: true }],
 		"vue/html-closing-bracket-newline": "warn",
 		"vue/singleline-html-element-content-newline": "off",
@@ -100,8 +102,8 @@ function getVueRules(options) {
 		"vue/block-lang": ["error", {
 			script: { lang: blockLang.script },
 			style: {
-				lang: blockLang.style,
-				allowNoLang: blockLang.style === "implicit"
+				lang: isStyleLangImplicit ? void 0 : blockLang.style,
+				allowNoLang: isStyleLangImplicit
 			}
 		}],
 		"vue/block-tag-newline": ["warn", {

package/dist/types/configOptions/importX.d.ts

@@ -1,20 +1,29 @@
-import { RuleOptions } from "../eslintRules.js";
 import { ConfigWithOverrides } from "../index.js";
 
 //#region src/types/configOptions/importX.d.ts
-type RequireFileExtensionOptions = RuleOptions<'import-x/extensions'>;
-type RequireFileExtension = Exclude<RequireFileExtensionOptions, 'ignorePackages' | Record<string, unknown>>;
+
 interface ImportXOptions extends ConfigWithOverrides {
   /**
-   * Enforce consistent use of file extensions within the import path.
+   * Automatically remove unused imports.
+   *
+   * @default true
+   *
+   * @see [unused-imports/no-unused-imports](https://github.com/sweepline/eslint-plugin-unused-imports/blob/master/docs/rules/no-unused-imports.md)
+   */
+  removeUnusedImports?: boolean;
+
+  /**
+   * Require file extensions within the import path.
    *
    * Imports from third-party packages are ignored.
    *
-   * @default 'always'
+   * `import-x/extensions` rule is currently broken, so `import/extensions` is used as a temporary replacement.
+   *
+   * @default true
    *
-   * @see [import-x/extensions](https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/extensions.md)
+   * @see [import/extensions](https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/extensions.md)
    */
-  requireFileExtension?: RequireFileExtension;
+  requireFileExtension?: boolean;
 }
 //#endregion
 export { type ImportXOptions };