@shayanthenerd/eslint-config 0.28.3 → 0.28.4

package/README.md

@@ -213,10 +213,7 @@ For editor integration, to avoid inconsistent diagnostics from the [Tailwind CS
 ```
 
 ### Nuxt
-Nuxt support is already included through the Vue integration, so you don’t need to install or configure [@nuxt/eslint][eslint-nuxt] manually. If you need additional rules tailored to Nuxt, refer to the plugin’s documentation for setup instructions.
-
-> [!TIP]
-> `configs.nuxt` only includes options for Nuxt Image, Nuxt UI, and the `<Icon>` component. Vue's rules and `overrides` can be configured via `configs.vue`.
+The required Nuxt configurations and rules are already included, so there's no need to install or configure the [@nuxt/eslint][eslint-nuxt] module.
 
 ### Markdown
 Markdown linting is powered by [@eslint/markdown][plugin-md].
@@ -500,6 +497,7 @@ _.vscode/settings.json_:
         ui?: boolean | {
           prefix?: string,
         },
+        overrides?: Overrides,
       },
       packageJson?: boolean | {
         overrides?: Overrides,

package/dist/configs/base.mjs

@@ -12,7 +12,7 @@ function getBaseConfig(options) {
 		name: "shayanthenerd/base",
 		files: [
 			globs.src,
-			globs.jsxLike,
+			globs.jsxTsx,
 			isEnabled(vue) ? globs.vue : "",
 			isEnabled(astro) ? globs.astro : ""
 		].filter(isTruthy),

package/dist/configs/baseline.mjs

@@ -10,7 +10,7 @@ function getBaselineConfig(options) {
 		name: "shayanthenerd/baseline",
 		files: [
 			globs.src,
-			globs.jsxLike,
+			globs.jsxTsx,
 			isEnabled(vue) ? globs.vue : "",
 			isEnabled(astro) ? globs.astro : ""
 		].filter(isTruthy),

package/dist/configs/importX.mjs

@@ -13,7 +13,7 @@ function getImportXConfig(options) {
 		name: "shayanthenerd/import-x",
 		files: [
 			globs.src,
-			globs.jsxLike,
+			globs.jsxTsx,
 			isEnabled(vue) ? globs.vue : "",
 			isEnabled(astro) ? globs.astro : ""
 		].filter(isTruthy),

package/dist/configs/next.mjs

@@ -10,7 +10,7 @@ function getNextConfig(options) {
 	const { overrides } = isEnabled(next) ? next : defaultOptions.configs.next;
 	return mergeConfigs({
 		name: "shayanthenerd/next",
-		files: [globs.src, globs.jsxLike],
+		files: [globs.src, globs.jsxTsx],
 		plugins: { next: eslintPluginNext },
 		settings: { next: { rootDir: packageDir } },
 		rules: getNextRules()

package/dist/configs/node.mjs

@@ -15,7 +15,7 @@ function getNodeConfig(options) {
 		name: "shayanthenerd/node",
 		files: [
 			globs.src,
-			globs.jsxLike,
+			globs.jsxTsx,
 			isEnabled(vue) ? globs.vue : "",
 			isEnabled(astro) ? globs.astro : ""
 		].filter(isTruthy),

package/dist/configs/nuxt.mjs

@@ -0,0 +1,64 @@
+import { globs } from "../helpers/globs.mjs";
+import { isEnabled } from "../utils/isEnabled.mjs";
+import { defaultOptions } from "../helpers/options/defaultOptions.mjs";
+import { getNuxtRules } from "../rules/nuxt.mjs";
+import { mergeConfigs } from "eslint-flat-config-utils";
+import eslintPluginVue from "eslint-plugin-vue";
+import { parser } from "typescript-eslint";
+import eslintPluginNuxt from "@nuxt/eslint-plugin";
+import eslintPluginNuxtLinkChecker from "nuxt-link-checker/eslint";
+//#region src/configs/nuxt.ts
+const baseVueConfig = eslintPluginVue.configs["flat/base"].find((config) => config.languageOptions?.parser);
+const middlewaresConfig = {
+	name: "shayanthenerd/nuxt/middlewares",
+	files: [globs.nuxtMiddlewares],
+	rules: {
+		"consistent-return": "off",
+		"@typescript-eslint/consistent-return": "off"
+	}
+};
+const componentNamesConfig = {
+	name: "shayanthenerd/nuxt/component-names",
+	files: [globs.nuxtAppErrorLayoutsPages],
+	rules: {
+		"vue/match-component-file-name": "off",
+		"vue/multi-word-component-names": "off",
+		"vue/component-definition-name-casing": "off"
+	}
+};
+const serverComponentsConfig = {
+	name: "shayanthenerd/nuxt/server-components",
+	files: [globs.nuxtServerComponents],
+	plugins: { vue: eslintPluginVue },
+	rules: { "vue/no-multiple-template-root": "error" }
+};
+function getNuxtConfigs(options) {
+	const { nuxt } = options.configs;
+	const { overrides } = isEnabled(nuxt) ? nuxt : defaultOptions.configs.nuxt;
+	return [
+		mergeConfigs({
+			name: "shayanthenerd/nuxt",
+			files: [globs.vue],
+			plugins: {
+				"vue": eslintPluginVue,
+				"nuxt": eslintPluginNuxt,
+				"link-checker": eslintPluginNuxtLinkChecker
+			},
+			processor: "vue/vue",
+			languageOptions: {
+				parser: baseVueConfig?.languageOptions?.parser,
+				parserOptions: {
+					parser,
+					extraFileExtensions: [".vue"],
+					vueFeatures: { filter: false }
+				}
+			},
+			rules: getNuxtRules()
+		}, overrides),
+		middlewaresConfig,
+		componentNamesConfig,
+		serverComponentsConfig
+	];
+}
+//#endregion
+export { getNuxtConfigs };

package/dist/configs/perfectionist.mjs

@@ -13,7 +13,7 @@ function getPerfectionistConfig(options) {
 		name: "shayanthenerd/perfectionist",
 		files: [
 			globs.src,
-			globs.jsxLike,
+			globs.jsxTsx,
 			isEnabled(vue) ? globs.vue : "",
 			isEnabled(astro) ? globs.astro : ""
 		].filter(isTruthy),

package/dist/configs/promise.mjs

@@ -13,7 +13,7 @@ function getPromiseConfig(options) {
 		name: "shayanthenerd/promise",
 		files: [
 			globs.src,
-			globs.jsxLike,
+			globs.jsxTsx,
 			isEnabled(vue) ? globs.vue : "",
 			isEnabled(astro) ? globs.astro : ""
 		].filter(isTruthy),

package/dist/configs/react.mjs

@@ -13,7 +13,7 @@ function getReactConfig(options) {
 	const { overrides, accessibility } = isEnabled(react) ? react : defaultOptions.configs.react;
 	return mergeConfigs({
 		name: "shayanthenerd/react",
-		files: [globs.src, globs.jsxLike],
+		files: [globs.src, globs.jsxTsx],
 		plugins: {
 			"@eslint-react": eslintPluginReact,
 			"@html-eslint/react": eslintPluginHtmlReact,

package/dist/configs/stylistic.mjs

@@ -13,7 +13,7 @@ function getStylisticConfig(options) {
 		name: "shayanthenerd/stylistic",
 		files: [
 			globs.src,
-			globs.jsxLike,
+			globs.jsxTsx,
 			isEnabled(vue) ? globs.vue : "",
 			isEnabled(astro) ? globs.astro : ""
 		].filter(isTruthy),

package/dist/configs/tailwind.mjs

@@ -58,7 +58,7 @@ function getTailwindConfig(options) {
 		name: "shayanthenerd/tailwind",
 		files: [
 			globs.src,
-			globs.jsxLike,
+			globs.jsxTsx,
 			isEnabled(vue) ? globs.vue : "",
 			isEnabled(html) ? globs.html : "",
 			isEnabled(astro) ? globs.astro : ""

package/dist/configs/typescript.mjs

@@ -15,7 +15,7 @@ function getTypeScriptConfig(options) {
 		name: "shayanthenerd/typescript",
 		files: [
 			globs.src,
-			globs.jsxLike,
+			globs.jsxTsx,
 			isEnabled(vue) ? globs.vue : "",
 			isEnabled(astro) ? globs.astro : ""
 		].filter(isTruthy),

package/dist/configs/unicorn.mjs

@@ -13,7 +13,7 @@ function getUnicornConfig(options) {
 		name: "shayanthenerd/unicorn",
 		files: [
 			globs.src,
-			globs.jsxLike,
+			globs.jsxTsx,
 			isEnabled(vue) ? globs.vue : "",
 			isEnabled(astro) ? globs.astro : ""
 		].filter(isTruthy),

package/dist/configs/vue.mjs

@@ -10,8 +10,8 @@ import eslintPluginVueAccessibility from "eslint-plugin-vuejs-accessibility";
 const baseVueConfig = eslintPluginVue.configs["flat/base"].find((config) => config.languageOptions?.parser);
 function getVueConfig(options) {
 	const { vue } = options.configs;
-	const isVueAccessibilityEnabled = isEnabled(vue) && isEnabled(vue.accessibility);
 	const { overrides } = isEnabled(vue) ? vue : defaultOptions.configs.vue;
+	const isVueAccessibilityEnabled = isEnabled(vue) && isEnabled(vue.accessibility);
 	return mergeConfigs({
 		name: "shayanthenerd/vue",
 		files: [globs.vue],

package/dist/configs/zod.mjs

@@ -14,7 +14,7 @@ function getZodConfig(options) {
 		name: `shayanthenerd/${mini ? "zod-mini" : "zod"}`,
 		files: [
 			globs.src,
-			globs.jsxLike,
+			globs.jsxTsx,
 			isEnabled(vue) ? globs.vue : "",
 			isEnabled(astro) ? globs.astro : ""
 		].filter(isTruthy),

package/dist/helpers/globs.mjs

@@ -1,20 +1,20 @@
 //#region src/helpers/globs.ts
 const srcExtensions = "?([mc])[jt]s";
-const jsxLikeExtensions = "[jt]sx";
-const vueExtensions = `{vue,${srcExtensions},${jsxLikeExtensions}}`;
+const jsxTsxExtensions = "[jt]sx";
+const vueExtensions = `{vue,${srcExtensions},${jsxTsxExtensions}}`;
 const globs = {
 	src: `**/*.${srcExtensions}`,
-	jsxLike: `**/*.${jsxLikeExtensions}`,
+	jsxTsx: `**/*.${jsxTsxExtensions}`,
 	packageJson: "**/package.json",
 	markdown: "**/*.md",
 	html: "**/*.html",
 	css: "**/*.css",
 	astro: "**/*.astro",
 	vue: `**/*.${vueExtensions}`,
-	vueMiddlewares: `**/middleware?(s)/**/*.${srcExtensions}`,
-	vueServerComponents: `**/*.server.${vueExtensions}`,
-	vueAppErrorLayoutsPages: `**/{{app,error},{layouts,pages}/**/*}.${vueExtensions}`,
-	storybook: `**/*.(story|stories).{${srcExtensions},${jsxLikeExtensions}}`,
+	nuxtAppErrorLayoutsPages: `**/{{app,error},{layouts,pages}/**/*}.${vueExtensions}`,
+	nuxtServerComponents: `**/*.server.${vueExtensions}`,
+	nuxtMiddlewares: `**/middleware?(s)/**/*.${srcExtensions}`,
+	storybook: `**/*.(story|stories).{${srcExtensions},${jsxTsxExtensions}}`,
 	test: `**/{__tests__/*,*.{test,spec,cy,bench?(mark)}.${srcExtensions}`,
 	coverage: "**/coverage/**"
 };

package/dist/helpers/ignores/defaultIgnorePatterns.mjs

@@ -14,11 +14,10 @@ const defaultIgnorePatterns = [
 	"**/dist",
 	"**/build",
 	"**/.data",
+	"**/public",
 	"**/output",
 	"**/.output",
 	"**/.serverless",
-	"**/public/build",
-	"**/public/static",
 	"**/.eslint-config-inspector",
 	"**/tmp",
 	"**/.tmp",

package/dist/helpers/options/defaultOptions.mjs

@@ -58,7 +58,8 @@ const defaultOptions = {
 		nuxt: {
 			icon: { component: "Icon" },
 			image: false,
-			ui: { prefix: "U" }
+			ui: { prefix: "U" },
+			overrides: {}
 		},
 		packageJson: { overrides: {} },
 		perfectionist: {

package/dist/index.mjs

@@ -7,6 +7,7 @@ import { getBaseConfig } from "./configs/base.mjs";
 import { getHtmlConfig } from "./configs/html.mjs";
 import { getNextConfig } from "./configs/next.mjs";
 import { getNodeConfig } from "./configs/node.mjs";
+import { getNuxtConfigs } from "./configs/nuxt.mjs";
 import { getAstroConfig } from "./configs/astro.mjs";
 import { getReactConfig } from "./configs/react.mjs";
 import { getVitestConfig } from "./configs/vitest.mjs";
@@ -23,11 +24,8 @@ import { getPlaywrightConfig } from "./configs/playwright.mjs";
 import { getTypeScriptConfig } from "./configs/typescript.mjs";
 import { getPackageJsonConfig } from "./configs/packageJson.mjs";
 import { getPerfectionistConfig } from "./configs/perfectionist.mjs";
-import { getVueMiddlewaresConfig } from "./configs/vueMiddlewares.mjs";
 import { getIgnorePatterns } from "./helpers/ignores/getIgnorePatterns.mjs";
 import { mergeWithDefaults } from "./helpers/options/mergeWithDefaults.mjs";
-import { getVueComponentNamesConfig } from "./configs/vueComponentNames.mjs";
-import { getVueServerComponentsConfig } from "./configs/vueServerComponents.mjs";
 import { defineConfig as defineConfig$1, globalIgnores } from "eslint/config";
 //#region src/index.ts
 /**
@@ -106,9 +104,7 @@ function defineConfig(...args) {
 		isEnabled(react) && getReactConfig(mergedOptions),
 		isEnabled(next) && getNextConfig(mergedOptions),
 		isEnabled(vue) && getVueConfig(mergedOptions),
-		isEnabled(vue) && getVueMiddlewaresConfig(),
-		isEnabled(vue) && getVueComponentNamesConfig(),
-		isEnabled(vue) && isEnabled(nuxt) && getVueServerComponentsConfig(),
+		...isEnabled(nuxt) ? getNuxtConfigs(mergedOptions) : [],
 		isEnabled(storybook) && getStorybookConfig(mergedOptions),
 		isEnabled(vitest) && getVitestConfig(mergedOptions),
 		isEnabled(cypress) && getCypressConfig(mergedOptions),

package/dist/rules/nuxt.mjs

@@ -0,0 +1,12 @@
+//#region src/rules/nuxt.ts
+const nuxtRules = {
+	"link-checker/valid-route": "error",
+	"link-checker/valid-sitemap-link": "warn",
+	"nuxt/no-page-meta-runtime-values": "error",
+	"nuxt/prefer-import-meta": "warn"
+};
+function getNuxtRules() {
+	return nuxtRules;
+}
+//#endregion
+export { getNuxtRules };

package/dist/rules/perfectionist.mjs

@@ -59,7 +59,15 @@ const typeConstituentSortOptions = {
 };
 const sortArrayIncludesOptions = {
 	customGroups: literalCustomGroups,
-	groups: sharedTypeLikeGroups
+	groups: [
+		"boolean-literal",
+		"number-literal",
+		"bigint-literal",
+		"string-literal",
+		"template-literal",
+		"literal",
+		"unknown"
+	]
 };
 const sortImportsCustomGroups = [{
 	groupName: "component",

package/dist/rules/vue.mjs

@@ -55,7 +55,7 @@ function getVueRules(options) {
 		"vuejs-accessibility/role-has-required-aria-props": "error",
 		"vuejs-accessibility/tabindex-no-positive": "error"
 	};
-	const vueAndNuxtRules = {
+	const vueRules = {
 		"@typescript-eslint/no-useless-default-assignment": "off",
 		"vue/jsx-uses-vars": "error",
 		"vue/comment-directive": ["error", { reportUnusedDisableDirectives: true }],
@@ -400,10 +400,10 @@ function getVueRules(options) {
 		"vue/slot-name-casing": "warn",
 		"vue/v-for-delimiter-style": ["warn", vForDelimiterStyle]
 	};
-	if (isEnabled(stylistic)) vueAndNuxtRules["@stylistic/max-len"] = "off";
+	if (isEnabled(stylistic)) vueRules["@stylistic/max-len"] = "off";
 	const isVueAccessibilityEnabled = isEnabled(vue) && isEnabled(vue.accessibility);
 	return {
-		...vueAndNuxtRules,
+		...vueRules,
 		...isVueAccessibilityEnabled && vueAccessibilityRules
 	};
 }

package/dist/types/eslint-schema.d.mts

@@ -3524,6 +3524,14 @@ interface ESLintSchema {
    * @deprecated
    */
   'lines-between-class-members'?: Linter.RuleEntry<LinesBetweenClassMembers>;
+  /**
+   * Validate that relative URLs match a known vue-router route pattern
+   */
+  'link-checker/valid-route'?: Linter.RuleEntry<LinkCheckerValidRoute>;
+  /**
+   * Validate that relative URLs exist in the sitemap
+   */
+  'link-checker/valid-sitemap-link'?: Linter.RuleEntry<LinkCheckerValidSitemapLink>;
   /**
    * Require or disallow logical assignment operator shorthand
    * @see https://eslint.org/docs/latest/rules/logical-assignment-operators
@@ -4855,6 +4863,26 @@ interface ESLintSchema {
    * @deprecated
    */
   'nonblock-statement-body-position'?: Linter.RuleEntry<NonblockStatementBodyPosition>;
+  /**
+   * Disallow setting `test` key in Nuxt config
+   * @see https://eslint.nuxt.com/packages/plugin#nuxtno-nuxt-config-test-key
+   */
+  'nuxt/no-nuxt-config-test-key'?: Linter.RuleEntry<[]>;
+  /**
+   * Disallow runtime context values inside `definePageMeta` at the eager level, which is extracted into a separate chunk at build time and runs before component setup
+   * @see https://eslint.nuxt.com/packages/plugin#nuxtno-page-meta-runtime-values
+   */
+  'nuxt/no-page-meta-runtime-values'?: Linter.RuleEntry<[]>;
+  /**
+   * Prefer recommended order of Nuxt config properties
+   * @see https://eslint.nuxt.com/packages/plugin#nuxtnuxt-config-keys-order
+   */
+  'nuxt/nuxt-config-keys-order'?: Linter.RuleEntry<[]>;
+  /**
+   * Prefer using `import.meta.*` over `process.*`
+   * @see https://eslint.nuxt.com/packages/plugin#nuxtprefer-import-meta
+   */
+  'nuxt/prefer-import-meta'?: Linter.RuleEntry<[]>;
   /**
    * Enforce consistent line breaks after opening and before closing braces
    * @see https://eslint.org/docs/latest/rules/object-curly-newline
@@ -17196,6 +17224,16 @@ type LinesBetweenClassMembers = [] | [({
 } | ("always" | "never")), {
   exceptAfterSingleLine?: boolean;
 }];
+// ----- link-checker/valid-route -----
+type LinkCheckerValidRoute = [] | [{
+  routesFile?: string;
+  rootDir?: string;
+}];
+// ----- link-checker/valid-sitemap-link -----
+type LinkCheckerValidSitemapLink = [] | [{
+  routesFile?: string;
+  rootDir?: string;
+}];
 // ----- logical-assignment-operators -----
 type LogicalAssignmentOperators = (([] | ["always"] | ["always", {
   enforceForIfStatements?: boolean;

package/dist/types/index.d.mts

@@ -302,11 +302,9 @@ interface Options {
      */
     node?: boolean | ConfigWithOverrides<PluginRules<'n'>>;
     /**
-     * Whether [Nuxt](https://nuxt.com) is used in the project.
+     * Use [@nuxt/eslint-plugin](https://eslint.nuxt.com/packages/plugin) and [nuxt-link-checker (ESLint plugin)](https://nuxtseo.com/docs/link-checker/guides/eslint) to enforce Nuxt best practices and catch broken links.
      *
-     * Enforce best practices and the use of Nuxt-specific components over their standard counterparts. For example, `<NuxtLink>` must be used instead of `<a>`, and `<NuxtTime>` instead of `<time>`.
-     *
-     * **This configuration requires `configs.vue` to be enabled.**
+     * Enforce best practices and the use of Nuxt-specific components over their counterparts. For example, `<NuxtLink>` must be used instead of `<a>`, and `<NuxtTime>` instead of `<time>`.
      *
      * @default false // `true` if "nuxt" is detected in the dependencies when `autoDetectDeps` is enabled
      */

package/dist/types/options/nuxt.d.mts

@@ -1,5 +1,8 @@
+import { PluginRules } from "../eslintRules.mjs";
+import { ConfigWithOverrides } from "../index.mjs";
 //#region src/types/options/nuxt.d.ts
-interface NuxtOptions {
+type ConfigRules = PluginRules<'nuxt'> | PluginRules<'link-checker'>;
+interface NuxtOptions extends ConfigWithOverrides<ConfigRules> {
   /**
    * Whether [@nuxt/icon](https://nuxt.com/modules/icon) is used in the project.
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shayanthenerd/eslint-config",
-  "version": "0.28.3",
+  "version": "0.28.4",
   "description": "A modern, flexible ESLint configuration for enforcing best practices and maintaining a consistent coding style",
   "keywords": [
     "eslint",
@@ -55,6 +55,7 @@
     "@html-eslint/eslint-plugin": "0.64.0",
     "@html-eslint/eslint-plugin-react": "0.64.0",
     "@next/eslint-plugin-next": "16.2.10",
+    "@nuxt/eslint-plugin": "1.16.0",
     "@stylistic/eslint-plugin": "5.10.0",
     "@vitest/eslint-plugin": "1.6.23",
     "astro-eslint-parser": "3.0.0",
@@ -80,6 +81,7 @@
     "eslint-plugin-zod-mini": "1.5.0",
     "globals": "17.7.0",
     "local-pkg": "1.2.1",
+    "nuxt-link-checker": "5.1.3",
     "tailwind-csstree": "0.3.3",
     "typescript-eslint": "8.65.0"
   },

package/dist/configs/vueComponentNames.mjs

@@ -1,15 +0,0 @@
-import { globs } from "../helpers/globs.mjs";
-//#region src/configs/vueComponentNames.ts
-function getVueComponentNamesConfig() {
-	return {
-		name: "shayanthenerd/vue/multi-word-component-names",
-		files: [globs.vueAppErrorLayoutsPages],
-		rules: {
-			"vue/match-component-file-name": "off",
-			"vue/multi-word-component-names": "off",
-			"vue/component-definition-name-casing": "off"
-		}
-	};
-}
-//#endregion
-export { getVueComponentNamesConfig };

package/dist/configs/vueMiddlewares.mjs

@@ -1,14 +0,0 @@
-import { globs } from "../helpers/globs.mjs";
-//#region src/configs/vueMiddlewares.ts
-function getVueMiddlewaresConfig() {
-	return {
-		name: "shayanthenerd/vue/middlewares",
-		files: [globs.vueMiddlewares],
-		rules: {
-			"consistent-return": "off",
-			"@typescript-eslint/consistent-return": "off"
-		}
-	};
-}
-//#endregion
-export { getVueMiddlewaresConfig };

package/dist/configs/vueServerComponents.mjs

@@ -1,11 +0,0 @@
-import { globs } from "../helpers/globs.mjs";
-//#region src/configs/vueServerComponents.ts
-function getVueServerComponentsConfig() {
-	return {
-		name: "shayanthenerd/vue/server-components",
-		files: [globs.vueServerComponents],
-		rules: { "vue/no-multiple-template-root": "error" }
-	};
-}
-//#endregion
-export { getVueServerComponentsConfig };