@dxup/nuxt 0.3.1 → 0.4.0

package/README.md

@@ -62,7 +62,20 @@ useFetch("/api/foo");
 
 It will fallback to resolve the URL from your `public` directory when no nitro routes match.
 
-### 4. runtimeConfig
+### 4. pageMeta
+
+Go to definition for page metadata.
+
+```ts
+definePageMeta({
+  layout: "admin",
+  //      ^^^^^^^
+  middleware: ["auth"],
+  //           ^^^^^^
+});
+```
+
+### 5. runtimeConfig
 
 Go to definition for runtime config.
 
@@ -73,7 +86,7 @@ Go to definition for runtime config.
 </template>
 ```
 
-### 5. typedPages
+### 6. typedPages
 
 Go to definition for typed pages.
 
@@ -86,7 +99,11 @@ Go to definition for typed pages.
 
 It can be triggered on the `name` property of an object literal constrained by the `RouteLocationRaw` type.
 
-### 6. unimport
+### 7. unimport
+
+Please refer to the [@dxup/unimport](/packages/unimport) package for more details.
+
+### 8. unofficial
 
 Find references for SFC on `<template>`.
 
@@ -95,5 +112,3 @@ Find references for SFC on `<template>`.
 <!-- ^^^^^^^^ -->
 </template>
 ```
-
-Please refer to the [@dxup/unimport](/packages/unimport) package for more details.

package/dist/module.d.mts

@@ -18,6 +18,11 @@ interface ModuleOptions {
      * @default true
      */
     nitroRoutes?: boolean;
+    /**
+     * Whether to enable Go to Definition for page metadata.
+     * @default true
+     */
+    pageMeta?: boolean;
     /**
      * Whether to enable Go to Definition for runtime config.
      * @default true
@@ -32,12 +37,13 @@ interface ModuleOptions {
      * Whether to enable enhanced navigation for auto imported APIs.
      * @default true
      */
-    unimport?: boolean | {
-      /**
-       * Whether to enable Find References for SFC on `<template>`.
-       */
-      componentReferences: boolean;
-    };
+    unimport?: boolean;
+    /**
+     * Whether to enable unofficial features for Vue itself.
+     * - find references for SFC on `<template>`
+     * @default true
+     */
+    unofficial?: boolean;
   };
 }
 declare const _default: _nuxt_schema0.NuxtModule<ModuleOptions, {
@@ -45,9 +51,11 @@ declare const _default: _nuxt_schema0.NuxtModule<ModuleOptions, {
     components: true;
     importGlob: true;
     nitroRoutes: true;
+    pageMeta: true;
     runtimeConfig: true;
     typedPages: true;
     unimport: true;
+    unofficial: true;
   };
 }, true>;
 //#endregion

package/dist/module.mjs

@@ -73,9 +73,11 @@ var module_default = defineNuxtModule().with({
 		components: true,
 		importGlob: true,
 		nitroRoutes: true,
+		pageMeta: true,
 		runtimeConfig: true,
 		typedPages: true,
-		unimport: true
+		unimport: true,
+		unofficial: true
 	} },
 	async setup(options, nuxt) {
 		const pluginsTs = [{ name: "@dxup/nuxt" }];
@@ -88,20 +90,29 @@ var module_default = defineNuxtModule().with({
 			filename: "dxup/data.json",
 			write: true,
 			getContents({ nuxt: nuxt$1, app }) {
+				const layouts = Object.fromEntries(Object.values(app.layouts).map((item) => [item.name, item.file]));
+				const middleware = app.middleware.reduce((acc, item) => {
+					if (!item.global) acc[item.name] = item.path;
+					return acc;
+				}, {});
 				const nitroRoutes = useNitro().scannedHandlers.reduce((acc, item) => {
 					if (item.route && item.method) (acc[item.route] ??= {})[item.method] = item.handler;
 					return acc;
 				}, {});
+				const typedPages = app.pages?.reduce(function reducer(acc, page) {
+					if (page.name && page.file) acc[page.name] = page.file;
+					if (page.children) for (const child of page.children) reducer(acc, child);
+					return acc;
+				}, {});
 				const data = {
 					buildDir: nuxt$1.options.buildDir,
 					publicDir: nuxt$1.options.dir.public,
 					configFiles: [...nuxt$1.options._nuxtConfigFiles, ...nuxt$1.options._layers.map((layer) => layer._configFile).filter(Boolean)],
+					layouts,
+					middleware,
 					nitroRoutes,
-					typedPages: Object.fromEntries(app.pages?.map((page) => [page.name, page.file]) ?? []),
-					features: {
-						...options.features,
-						unimport: { componentReferences: typeof options.features.unimport === "object" ? options.features.unimport.componentReferences : options.features.unimport }
-					}
+					typedPages,
+					features: options.features
 				};
 				return JSON.stringify(data, null, 2);
 			}

package/dist/typescript.cjs

@@ -36,15 +36,18 @@ const initialValue = {
 	buildDir: "",
 	publicDir: "",
 	configFiles: [],
+	layouts: {},
+	middleware: {},
 	nitroRoutes: {},
 	typedPages: {},
 	features: {
 		components: true,
 		importGlob: true,
 		nitroRoutes: true,
+		pageMeta: true,
 		runtimeConfig: true,
 		typedPages: true,
-		unimport: { componentReferences: true }
+		unofficial: true
 	}
 };
 const callbacks = {};
@@ -84,18 +87,6 @@ function createModuleDefinition(ts, path) {
 function isVueVirtualCode(code) {
 	return code?.languageId === "vue";
 }
-function toSourceSpan(language, fileName, textSpan) {
-	const sourceScript = language?.scripts.get(fileName);
-	if (!sourceScript?.generated) return;
-	const serviceScript = sourceScript.generated.languagePlugin.typescript?.getServiceScript(sourceScript.generated.root);
-	if (!serviceScript) return;
-	const map = language.maps.get(serviceScript.code, sourceScript);
-	const leadingOffset = sourceScript.snapshot.getLength();
-	for (const [start, end] of map.toSourceRange(textSpan.start - leadingOffset, textSpan.start + textSpan.length - leadingOffset, false)) return {
-		start,
-		length: end - start
-	};
-}
 function withVirtualOffset(language, sourceScript, position, method) {
 	const serviceScript = sourceScript.generated.languagePlugin.typescript?.getServiceScript(sourceScript.generated.root);
 	if (!serviceScript) return;
@@ -133,7 +124,7 @@ function postprocess$1(context, language, findReferences) {
 	return (...args) => {
 		const result = findReferences(...args);
 		if (!result?.length) {
-			const sourceScript = language.scripts.get(args[0]);
+			const sourceScript = language.scripts.get(args[0].replaceAll("\\", "/"));
 			const root = sourceScript?.generated?.root;
 			if (!isVueVirtualCode(root)) return;
 			const start = (root.sfc.template?.start ?? Infinity) + 1;
@@ -198,12 +189,13 @@ const fetchFunctions = new Set([
 	"useFetch",
 	"useLazyFetch"
 ]);
+const pageMetaKeys = new Set(["layout", "middleware"]);
 function postprocess(context, language, getDefinitionAndBoundSpan) {
 	const { ts } = context;
 	return (...args) => {
 		const result = getDefinitionAndBoundSpan(...args);
 		if (!result?.definitions?.length) {
-			const root = language.scripts.get(args[0])?.generated?.root;
+			const root = language.scripts.get(args[0].replaceAll("\\", "/"))?.generated?.root;
 			if (!isVueVirtualCode(root)) return result;
 			const textSpan = {
 				start: (root.sfc.template?.start ?? Infinity) + 1,
@@ -238,6 +230,7 @@ function preprocess$1(context, getDefinitionAndBoundSpan) {
 			for (const node of forEachTouchingNode(ts, sourceFile, args[1])) {
 				if (data.features.importGlob) result$1 ??= visitImportGlob(ts, info, sourceFile, node, args[1]);
 				if (data.features.nitroRoutes) result$1 ??= visitNitroRoutes(ts, data, checker, sourceFile, node, args[1]);
+				if (data.features.pageMeta) result$1 ??= visitPageMeta(ts, data, sourceFile, node, args[1]);
 				if (data.features.typedPages) result$1 ??= visitTypedPages(ts, data, checker, sourceFile, node, args[1]);
 			}
 			if (result$1) return result$1;
@@ -331,12 +324,51 @@ function visitNitroRoutes(ts, data, checker, sourceFile, node, position) {
 		definitions: paths.map((path) => createModuleDefinition(ts, path))
 	};
 }
+function visitPageMeta(ts, data, sourceFile, node, position) {
+	if (!ts.isPropertyAssignment(node) || !ts.isIdentifier(node.name) || !pageMetaKeys.has(node.name.text) || !ts.isCallExpression(node.parent.parent) || !ts.isIdentifier(node.parent.parent.expression) || node.parent.parent.expression.text !== "definePageMeta") return;
+	switch (node.name.text) {
+		case "layout": {
+			if (!ts.isStringLiteralLike(node.initializer)) return;
+			const start = node.initializer.getStart(sourceFile);
+			const end = node.initializer.getEnd();
+			if (position < start || position > end) return;
+			const path = data.layouts[node.initializer.text];
+			if (path === void 0) return;
+			return {
+				textSpan: {
+					start,
+					length: end - start
+				},
+				definitions: [createModuleDefinition(ts, path)]
+			};
+		}
+		case "middleware": {
+			const literals = ts.isStringLiteralLike(node.initializer) ? [node.initializer] : ts.isArrayLiteralExpression(node.initializer) ? node.initializer.elements.filter(ts.isStringLiteralLike) : [];
+			for (const literal of literals) {
+				const start = literal.getStart(sourceFile);
+				const end = literal.getEnd();
+				if (position < start || position > end) continue;
+				const path = data.middleware[literal.text];
+				if (path === void 0) continue;
+				return {
+					textSpan: {
+						start,
+						length: end - start
+					},
+					definitions: [createModuleDefinition(ts, path)]
+				};
+			}
+			break;
+		}
+	}
+}
 function visitTypedPages(ts, data, checker, sourceFile, node, position) {
 	if (!ts.isPropertyAssignment(node) || !ts.isIdentifier(node.name) || node.name.text !== "name" || !ts.isStringLiteralLike(node.initializer)) return;
 	const start = node.initializer.getStart(sourceFile);
 	const end = node.initializer.getEnd();
 	if (position < start || position > end) return;
-	if (checker.getContextualType(node.parent)?.getNonNullableType().aliasSymbol?.name !== "RouteLocationRaw") return;
+	const contextualType = checker.getContextualType(node.parent)?.getNonNullableType();
+	if (contextualType?.aliasSymbol?.name !== "RouteLocationRaw" && (!contextualType?.isUnion() || contextualType.types.every((type) => type.symbol?.name !== "RouteLocationAsPathTyped"))) return;
 	const path = data.typedPages[node.initializer.text];
 	if (path === void 0) return;
 	return {
@@ -430,30 +462,31 @@ function preprocess(context, getEditsForFileRename) {
 	return (...args) => {
 		const result = getEditsForFileRename(...args);
 		if (!result?.length) return result;
-		const program = info.languageService.getProgram();
-		const references = {};
-		for (const change of result) {
-			const { fileName, textChanges } = change;
-			if (data.features.components && fileName.endsWith("components.d.ts")) {
+		if (data.features.components) {
+			const languageService = info.project.getLanguageService();
+			const program = languageService.getProgram();
+			const references = {};
+			for (const { fileName, textChanges } of result) {
+				if (!fileName.endsWith("components.d.ts")) continue;
 				const sourceFile = program.getSourceFile(fileName);
 				if (!sourceFile) continue;
 				for (const { span } of textChanges) for (const node of forEachTouchingNode(ts, sourceFile, span.start)) {
 					if (!ts.isPropertySignature(node) && !ts.isVariableDeclaration(node)) continue;
 					const position = node.name.getStart(sourceFile);
-					const res = info.languageService.getReferencesAtPosition(fileName, position)?.filter((entry) => !entry.fileName.startsWith(data.buildDir));
+					const res = languageService.getReferencesAtPosition(fileName, position)?.filter((entry) => !entry.fileName.startsWith(data.buildDir))?.sort((a, b) => a.textSpan.start - b.textSpan.start);
 					const lazy = node.type && ts.isTypeReferenceNode(node.type) && ts.isIdentifier(node.type.typeName) && node.type.typeName.text === "LazyComponent";
 					for (const { fileName: fileName$1, textSpan } of res ?? []) (references[fileName$1] ??= []).push({
-						textSpan: toSourceSpan(context.language, fileName$1, textSpan) ?? textSpan,
+						textSpan,
 						lazy: lazy || void 0
 					});
 					break;
 				}
 			}
+			if (Object.keys(references).length) server.write("components:rename", {
+				fileName: args[1],
+				references
+			});
 		}
-		if (Object.keys(references).length) server.write("components:rename", {
-			fileName: args[1],
-			references
-		});
 		return result.filter((change) => {
 			return !change.fileName.startsWith(data.buildDir);
 		});
@@ -474,7 +507,7 @@ const plugin = (module$1) => {
 		};
 		queueMicrotask(() => {
 			context.language = info.project.__vue__?.language;
-			if (!context.language || !data.features.unimport.componentReferences) return;
+			if (!context.language || !data.features.unofficial) return;
 			const languageService = info.project.getLanguageService();
 			const methods = {};
 			for (const [key, method] of [["findReferences", findReferences_exports], ["getDefinitionAndBoundSpan", getDefinitionAndBoundSpan_exports]]) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dxup/nuxt",
   "type": "module",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "TypeScript plugin for Nuxt",
   "author": "KazariEX",
   "license": "MIT",
@@ -15,6 +15,9 @@
   "files": [
     "dist"
   ],
+  "peerDependencies": {
+    "typescript": "*"
+  },
   "dependencies": {
     "@nuxt/kit": "^4.2.2",
     "chokidar": "^5.0.0",
@@ -24,9 +27,9 @@
   },
   "devDependencies": {
     "@dxup/shared": "",
-    "@volar/language-core": "^2.4.26",
-    "@volar/typescript": "^2.4.26",
-    "@vue/language-core": "^3.1.8",
+    "@volar/language-core": "^2.4.27",
+    "@volar/typescript": "^2.4.27",
+    "@vue/language-core": "^3.2.1",
     "nuxt": "^4.2.2",
     "typescript": "^5.9.3"
   },