test: refactor type tests into a separate fixture (#21007)

package.json

@@ -21,7 +21,9 @@
     "test:fixtures:payload": "TEST_PAYLOAD=js pnpm test:fixtures",
     "test:fixtures:dev": "TEST_ENV=dev pnpm test:fixtures",
     "test:fixtures:webpack": "TEST_BUILDER=webpack pnpm test:fixtures",
-    "test:types": "nuxi prepare test/fixtures/basic && cd test/fixtures/basic && npx vue-tsc --noEmit",
+    "test:types": "pnpm test:types:basic && pnpm test:types:minimal",
+    "test:types:basic": "nuxi prepare test/fixtures/basic-types && cd test/fixtures/basic-types && npx vue-tsc --noEmit",
+    "test:types:minimal": "nuxi prepare test/fixtures/minimal-types && cd test/fixtures/minimal-types && npx vue-tsc --noEmit",
     "test:unit": "vitest run --dir packages",
     "typecheck": "tsc --noEmit"
   },

test/fixtures/basic-types/.gitignore

@@ -0,0 +1 @@
+!extends/node_modules

test/fixtures/basic-types/app.config.ts

@@ -0,0 +1,6 @@
+export default defineAppConfig({
+  userConfig: 123,
+  nested: {
+    val: 2
+  }
+})

test/fixtures/basic-types/components/WithTypes.vue

@@ -0,0 +1,28 @@
+<script setup lang="ts">
+defineProps({
+  aProp: Number
+})
+defineSlots<{
+  fallback: { id: string }
+}>()
+defineExpose<{
+  _exposedValue: boolean
+}>()
+
+const _exposedValue = 42
+
+const emit = defineEmits<{
+  'some-event': [id: string]
+}>()
+emit('some-event', '42')
+// @ts-expect-error an invalid argument
+emit('some-event', 42)
+// @ts-expect-error an unknown event
+emit('unknown-event', 42)
+</script>
+
+<template>
+  <div>
+    <!--  -->
+  </div>
+</template>

test/fixtures/basic-types/extends/bar/app.config.ts

@@ -0,0 +1,3 @@
+export default {
+  fromLayer: true
+}

test/fixtures/basic-types/extends/bar/index.d.ts

@@ -0,0 +1,5 @@
+declare module 'bing' {
+  interface BingInterface {
+    foo: 'bar'
+  }
+}

test/fixtures/basic-types/extends/bar/layouts/override.vue

@@ -0,0 +1,6 @@
+<template>
+  <div>
+    <div>Extended layout from bar</div>
+    <NuxtPage />
+  </div>
+</template>

test/fixtures/basic-types/extends/bar/middleware/override.ts

@@ -0,0 +1,3 @@
+export default defineNuxtRouteMiddleware((to) => {
+  to.meta.override = 'Injected by extended middleware from bar'
+})

test/fixtures/basic-types/extends/bar/nuxt.config.ts

@@ -0,0 +1 @@
+export default defineNuxtConfig({})

test/fixtures/basic-types/extends/bar/pages/override.vue

@@ -0,0 +1,14 @@
+<script setup>
+definePageMeta({
+  layout: 'override',
+  middleware: 'override'
+})
+</script>
+
+<template>
+  <div>
+    <div>Extended page from bar</div>
+    <div>Middleware | override: {{ $route.meta.override }}</div>
+    <ExtendsOverride />
+  </div>
+</template>

test/fixtures/basic-types/layouts/custom.vue

@@ -0,0 +1,6 @@
+<template>
+  <div>
+    Custom Layout:
+    <slot />
+  </div>
+</template>

test/fixtures/basic-types/middleware/global.global.ts

@@ -0,0 +1,7 @@
+export default defineNuxtRouteMiddleware((to) => {
+  if ('abort' in to.query) {
+    return abortNavigation({
+      statusCode: 401
+    })
+  }
+})

test/fixtures/basic-types/middleware/named.ts

@@ -0,0 +1,3 @@
+export default defineNuxtRouteMiddleware((to) => {
+  to.meta.auth = 'Injected by injectAuth middleware'
+})

test/fixtures/basic-types/modules/auto-registered/index.ts

@@ -0,0 +1,15 @@
+import { addServerHandler, createResolver, defineNuxtModule } from 'nuxt/kit'
+
+export default defineNuxtModule({
+  meta: {
+    name: 'auto-registered-module'
+  },
+  setup () {
+    const resolver = createResolver(import.meta.url)
+
+    addServerHandler({
+      handler: resolver.resolve('./runtime/handler'),
+      route: '/auto-registered-module'
+    })
+  }
+})

test/fixtures/basic-types/modules/auto-registered/runtime/handler.ts

@@ -0,0 +1 @@
+export default defineEventHandler(() => 'handler added by auto-registered module')

test/fixtures/basic-types/modules/example.ts

@@ -0,0 +1,23 @@
+import { addPlugin, createResolver, defineNuxtModule, useNuxt } from 'nuxt/kit'
+
+export default defineNuxtModule({
+  defaults: {
+    enabled: true,
+    typeTest: (value: boolean) => typeof value === 'boolean'
+  },
+  meta: {
+    name: 'my-module',
+    configKey: 'sampleModule'
+  },
+  setup () {
+    const resolver = createResolver(import.meta.url)
+
+    addPlugin(resolver.resolve('./runtime/plugin'))
+    useNuxt().hook('app:resolve', (app) => {
+      app.middleware.push({
+        name: 'unctx-test',
+        path: resolver.resolve('./runtime/middleware')
+      })
+    })
+  }
+})

test/fixtures/basic-types/modules/page-extend.ts

@@ -0,0 +1,19 @@
+import { createResolver, defineNuxtModule, useNuxt } from 'nuxt/kit'
+
+export default defineNuxtModule({
+  meta: {
+    name: 'page-extend'
+  },
+  setup () {
+    const nuxt = useNuxt()
+    const resolver = createResolver(import.meta.url)
+
+    nuxt.hook('pages:extend', (pages) => {
+      pages.push({
+        name: 'page-extend',
+        path: '/page-extend',
+        file: resolver.resolve('./runtime/page.vue')
+      })
+    })
+  }
+})

test/fixtures/basic-types/modules/runtime/middleware.ts

@@ -0,0 +1,4 @@
+export default defineNuxtRouteMiddleware(async () => {
+  await new Promise(resolve => setTimeout(resolve, 1))
+  useNuxtApp()
+})

test/fixtures/basic-types/modules/runtime/page.vue

@@ -0,0 +1,17 @@
+<script setup lang="ts">
+import { setResponseHeader } from 'h3'
+
+definePageMeta({
+  value: 'added in pages:extend'
+})
+
+if (process.server) {
+  setResponseHeader(useRequestEvent(), 'x-extend', useRoute().meta.value as string)
+}
+</script>
+
+<template>
+  <div>
+    added in pages:extend
+  </div>
+</template>

test/fixtures/basic-types/modules/runtime/plugin.ts

@@ -0,0 +1,4 @@
+export default defineNuxtPlugin(async () => {
+  await new Promise(resolve => setTimeout(resolve, 1))
+  useNuxtApp()
+})

test/fixtures/basic-types/modules/test/index.ts

@@ -0,0 +1,7 @@
+import { defineNuxtModule } from 'nuxt/kit'
+
+export default defineNuxtModule({
+  meta: {
+    name: 'test'
+  }
+})

test/fixtures/basic-types/nuxt.config.ts

@@ -0,0 +1,76 @@
+export default defineNuxtConfig({
+  experimental: {
+    typedPages: true
+  },
+  typescript: {
+    strict: true,
+    tsConfig: {
+      compilerOptions: {
+        moduleResolution: process.env.MODULE_RESOLUTION
+      }
+    }
+  },
+  buildDir: process.env.NITRO_BUILD_DIR,
+  builder: process.env.TEST_BUILDER as 'webpack' | 'vite' ?? 'vite',
+  theme: './extends/bar',
+  extends: [
+    './extends/node_modules/foo'
+  ],
+  runtimeConfig: {
+    baseURL: '',
+    baseAPIToken: '',
+    privateConfig: 'secret_key',
+    public: {
+      ids: [1, 2, 3],
+      needsFallback: undefined,
+      testConfig: 123
+    }
+  },
+  appConfig: {
+    fromNuxtConfig: true,
+    nested: {
+      val: 1
+    }
+  },
+  modules: [
+    './modules/test',
+    [
+      '~/modules/example',
+      {
+        typeTest (val) {
+          // @ts-expect-error module type defines val as boolean
+          const b: string = val
+          return !!b
+        }
+      }
+    ],
+    function (_options, nuxt) {
+      nuxt.hook('pages:extend', (pages) => {
+        pages.push({
+          name: 'internal-async-parent',
+          path: '/internal-async-parent'
+        })
+      })
+    }
+  ],
+  telemetry: false, // for testing telemetry types - it is auto-disabled in tests
+  hooks: {
+    'schema:extend' (schemas) {
+      schemas.push({
+        appConfig: {
+          someThing: {
+            value: {
+              $default: 'default',
+              $schema: {
+                tsType: 'string | false'
+              }
+            }
+          }
+        }
+      })
+    },
+    'prepare:types' ({ tsConfig }) {
+      tsConfig.include = tsConfig.include!.filter(i => i !== '../../../../**/*')
+    }
+  }
+})

test/fixtures/basic-types/package.json

@@ -0,0 +1,16 @@
+{
+  "private": true,
+  "name": "fixture-basic-types",
+  "scripts": {
+    "build": "nuxi build"
+  },
+  "dependencies": {
+    "nuxt": "workspace:*"
+  },
+  "devDependencies": {
+    "ofetch": "latest",
+    "unplugin": "latest",
+    "vitest": "latest",
+    "vue-router": "latest"
+  }
+}