feat: add nuxt/no-nuxt-config-test-key (#633)

danielroe · autofix-ci[bot] · web-flow · commit 3be8ab845e95 · 2025-12-10T12:37:23.000+09:00
Co-authored-by: autofix-ci[bot] &lt;114827586+autofix-ci[bot]@users.noreply.github.com&gt;
diff --git a/packages/eslint-config/src/configs/nuxt.ts b/packages/eslint-config/src/configs/nuxt.ts
@@ -50,6 +50,17 @@ export default function nuxt(options: NuxtESLintConfigOptions): Linter.Config[]
     },
   })
 
+  configs.push({
+    name: 'nuxt/nuxt-config',
+    files: [
+      '**/.config/nuxt.?([cm])[jt]s?(x)',
+      '**/nuxt.config.?([cm])[jt]s?(x)',
+    ],
+    rules: {
+      'nuxt/no-nuxt-config-test-key': 'error',
+    },
+  })
+
   if (sortConfigKeys) {
     configs.push({
       name: 'nuxt/sort-config',
diff --git a/packages/eslint-config/test/__snapshots__/flat-compose.test.ts.snap b/packages/eslint-config/test/__snapshots__/flat-compose.test.ts.snap
@@ -73,6 +73,13 @@ exports[`flat config composition > custom src dirs 1`] = `
   {
     "name": "nuxt/rules",
   },
+  {
+    "files": [
+      "**/.config/nuxt.?([cm])[jt]s?(x)",
+      "**/nuxt.config.?([cm])[jt]s?(x)",
+    ],
+    "name": "nuxt/nuxt-config",
+  },
   {
     "files": [
       "src1/app.{js,ts,jsx,tsx,vue}",
@@ -164,6 +171,13 @@ exports[`flat config composition > empty 1`] = `
   {
     "name": "nuxt/rules",
   },
+  {
+    "files": [
+      "**/.config/nuxt.?([cm])[jt]s?(x)",
+      "**/nuxt.config.?([cm])[jt]s?(x)",
+    ],
+    "name": "nuxt/nuxt-config",
+  },
   {
     "files": [
       "app.{js,ts,jsx,tsx,vue}",
@@ -201,6 +215,13 @@ exports[`flat config composition > non-standalone 1`] = `
   {
     "name": "nuxt/rules",
   },
+  {
+    "files": [
+      "**/.config/nuxt.?([cm])[jt]s?(x)",
+      "**/nuxt.config.?([cm])[jt]s?(x)",
+    ],
+    "name": "nuxt/nuxt-config",
+  },
   {
     "files": [
       "app.{js,ts,jsx,tsx,vue}",
@@ -292,6 +313,13 @@ exports[`flat config composition > with stylistic 1`] = `
   {
     "name": "nuxt/rules",
   },
+  {
+    "files": [
+      "**/.config/nuxt.?([cm])[jt]s?(x)",
+      "**/nuxt.config.?([cm])[jt]s?(x)",
+    ],
+    "name": "nuxt/nuxt-config",
+  },
   {
     "files": [
       "**/.config/nuxt.?([cm])[jt]s?(x)",
diff --git a/packages/eslint-plugin/src/rules/index.ts b/packages/eslint-plugin/src/rules/index.ts
@@ -1,7 +1,9 @@
 import { rule as preferImportMetaRule } from './prefer-import-meta'
 import { rule as nuxtConfigOrderKeysRule } from './nuxt-config-keys-order'
+import { rule as noNuxtConfigTestKeyRule } from './no-nuxt-config-test-key'
 
 export default {
   'prefer-import-meta': preferImportMetaRule,
   'nuxt-config-keys-order': nuxtConfigOrderKeysRule,
+  'no-nuxt-config-test-key': noNuxtConfigTestKeyRule,
 }
diff --git a/packages/eslint-plugin/src/rules/no-nuxt-config-test-key/index.ts b/packages/eslint-plugin/src/rules/no-nuxt-config-test-key/index.ts
@@ -0,0 +1,54 @@
+import type { TSESTree as Tree } from '@typescript-eslint/utils'
+import { createRule } from '../utils'
+
+type MessageIds = 'default'
+
+type Options = []
+
+export const rule = createRule<MessageIds, Options>({
+  name: 'no-nuxt-config-test-key',
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Disallow setting `test` key in Nuxt config',
+    },
+    schema: [],
+    messages: {
+      default: 'Do not set `test` key in Nuxt config. The test environment is automatically detected.',
+    },
+  },
+  defaultOptions: [],
+  create(context) {
+    return {
+      ExportDefaultDeclaration(node) {
+        let object: Tree.ObjectExpression | undefined
+        if (node.declaration.type === 'ObjectExpression') {
+          object = node.declaration
+        }
+        else if (node.declaration.type === 'CallExpression' && node.declaration.arguments[0]?.type === 'ObjectExpression') {
+          object = node.declaration.arguments[0]
+        }
+        if (!object) {
+          return
+        }
+
+        for (const prop of object.properties) {
+          if (
+            prop.type === 'Property'
+            && prop.key.type === 'Identifier'
+            && prop.key.name === 'test'
+            && (
+              (prop.value.type === 'Literal' && typeof prop.value.value === 'boolean')
+              || (prop.value.type === 'Identifier' && (prop.value.name === 'true' || prop.value.name === 'false'))
+            )
+          ) {
+            context.report({
+              node: prop,
+              messageId: 'default',
+            })
+          }
+        }
+      },
+    }
+  },
+})

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
`1`	`1`	`import { rule as preferImportMetaRule } from './prefer-import-meta'`
`2`	`2`	`import { rule as nuxtConfigOrderKeysRule } from './nuxt-config-keys-order'`
	`3`	`+import { rule as noNuxtConfigTestKeyRule } from './no-nuxt-config-test-key'`
`3`	`4`
`4`	`5`	`export default {`
`5`	`6`	`'prefer-import-meta': preferImportMetaRule,`
`6`	`7`	`'nuxt-config-keys-order': nuxtConfigOrderKeysRule,`
	`8`	`+ 'no-nuxt-config-test-key': noNuxtConfigTestKeyRule,`
`7`	`9`	`}`