@dxup/nuxt 0.3.0 → 0.3.2

package/README.md

@@ -60,9 +60,22 @@ useFetch("/api/foo");
 // Also `$fetch` and `useLazyFetch`.
 ```
 
+### 4. pageMeta
+
+Go to definition for page metadata.
+
+```ts
+definePageMeta({
+  layout: "admin",
+  //      ^^^^^^^
+  middleware: ["auth"],
+  //           ^^^^^^
+});
+```
+
 It will fallback to resolve the URL from your `public` directory when no nitro routes match.
 
-### 4. runtimeConfig
+### 5. runtimeConfig
 
 Go to definition for runtime config.
 
@@ -73,7 +86,20 @@ Go to definition for runtime config.
 </template>
 ```
 
-### 5. unimport
+### 6. typedPages
+
+Go to definition for typed pages.
+
+```vue
+<template>
+  <nuxt-link :to="{ name: `about` }"/>
+  <!--                    ^^^^^^^ -->
+</template>
+```
+
+It can be triggered on the `name` property of an object literal constrained by the `RouteLocationRaw` type.
+
+### 7. unimport
 
 Find references for SFC on `<template>`.
 

package/dist/module.d.mts

@@ -18,11 +18,21 @@ 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
      */
     runtimeConfig?: boolean;
+    /**
+     * Whether to enable Go to Definition for typed pages.
+     * @default true
+     */
+    typedPages?: boolean;
     /**
      * Whether to enable enhanced navigation for auto imported APIs.
      * @default true
@@ -40,7 +50,9 @@ declare const _default: _nuxt_schema0.NuxtModule<ModuleOptions, {
     components: true;
     importGlob: true;
     nitroRoutes: true;
+    pageMeta: true;
     runtimeConfig: true;
+    typedPages: true;
     unimport: true;
   };
 }, true>;

package/dist/module.mjs

@@ -73,7 +73,9 @@ var module_default = defineNuxtModule().with({
 		components: true,
 		importGlob: true,
 		nitroRoutes: true,
+		pageMeta: true,
 		runtimeConfig: true,
+		typedPages: true,
 		unimport: true
 	} },
 	async setup(options, nuxt) {
@@ -86,16 +88,29 @@ var module_default = defineNuxtModule().with({
 		addTemplate({
 			filename: "dxup/data.json",
 			write: true,
-			getContents({ nuxt: nuxt$1 }) {
+			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,
 					features: {
 						...options.features,
 						unimport: { componentReferences: typeof options.features.unimport === "object" ? options.features.unimport.componentReferences : options.features.unimport }

package/dist/typescript.cjs

@@ -36,12 +36,17 @@ 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 }
 	}
 };
@@ -66,21 +71,22 @@ function createData(ts, info) {
 
 //#endregion
 //#region src/typescript/utils.ts
+function createModuleDefinition(ts, path) {
+	return {
+		fileName: path,
+		textSpan: {
+			start: 0,
+			length: 0
+		},
+		kind: ts.ScriptElementKind.moduleElement,
+		name: `"${path}"`,
+		containerKind: ts.ScriptElementKind.unknown,
+		containerName: ""
+	};
+}
 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;
@@ -183,6 +189,7 @@ const fetchFunctions = new Set([
 	"useFetch",
 	"useLazyFetch"
 ]);
+const pageMetaKeys = new Set(["layout", "middleware"]);
 function postprocess(context, language, getDefinitionAndBoundSpan) {
 	const { ts } = context;
 	return (...args) => {
@@ -199,10 +206,10 @@ function postprocess(context, language, getDefinitionAndBoundSpan) {
 				definitions: [{
 					fileName: args[0],
 					textSpan,
-					kind: ts.ScriptElementKind.scriptElement,
-					name: args[0],
+					kind: ts.ScriptElementKind.memberVariableElement,
+					name: "default",
 					containerKind: ts.ScriptElementKind.unknown,
-					containerName: ""
+					containerName: args[0]
 				}]
 			};
 			return result;
@@ -219,12 +226,14 @@ function preprocess$1(context, getDefinitionAndBoundSpan) {
 			const sourceFile = program$1.getSourceFile(args[0]);
 			if (!sourceFile) return;
 			const checker = program$1.getTypeChecker();
-			let res;
+			let result$1;
 			for (const node of forEachTouchingNode(ts, sourceFile, args[1])) {
-				if (data.features.importGlob) res ??= visitImportGlob(ts, info, sourceFile, node, args[1]);
-				if (data.features.nitroRoutes) res ??= visitNitroRoutes(ts, data, checker, sourceFile, node, 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 (res) return res;
+			if (result$1) return result$1;
 		}
 		if (!result?.definitions?.length) return result;
 		const program = info.languageService.getProgram();
@@ -232,7 +241,7 @@ function preprocess$1(context, getDefinitionAndBoundSpan) {
 		for (const definition of result.definitions) {
 			const sourceFile = program.getSourceFile(definition.fileName);
 			if (!sourceFile) continue;
-			let result$1 = [];
+			let result$1;
 			if (data.features.runtimeConfig && definition.fileName.endsWith("runtime-config.d.ts")) result$1 = visitRuntimeConfig(context, sourceFile, definition);
 			if (result$1?.length) {
 				for (const definition$1 of result$1) definitions.add(definition$1);
@@ -271,17 +280,7 @@ function visitImportGlob(ts, info, sourceFile, node, position) {
 			start,
 			length: end - start
 		},
-		definitions: fileNames.map((fileName) => ({
-			fileName,
-			textSpan: {
-				start: 0,
-				length: 0
-			},
-			kind: ts.ScriptElementKind.unknown,
-			name: fileName,
-			containerKind: ts.ScriptElementKind.unknown,
-			containerName: ""
-		}))
+		definitions: fileNames.map((fileName) => createModuleDefinition(ts, fileName))
 	};
 }
 function visitNitroRoutes(ts, data, checker, sourceFile, node, position) {
@@ -322,17 +321,62 @@ function visitNitroRoutes(ts, data, checker, sourceFile, node, position) {
 			start,
 			length: end - start
 		},
-		definitions: paths.map((path) => ({
-			fileName: path,
-			textSpan: {
-				start: 0,
-				length: 0
-			},
-			kind: ts.ScriptElementKind.scriptElement,
-			name: path,
-			containerKind: ts.ScriptElementKind.unknown,
-			containerName: ""
-		}))
+		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;
+	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 {
+		textSpan: {
+			start,
+			length: end - start
+		},
+		definitions: [createModuleDefinition(ts, path)]
 	};
 }
 function visitRuntimeConfig(context, sourceFile, definition) {
@@ -418,7 +462,8 @@ function preprocess(context, getEditsForFileRename) {
 	return (...args) => {
 		const result = getEditsForFileRename(...args);
 		if (!result?.length) return result;
-		const program = info.languageService.getProgram();
+		const languageService = info.project.getLanguageService();
+		const program = languageService.getProgram();
 		const references = {};
 		for (const change of result) {
 			const { fileName, textChanges } = change;
@@ -428,10 +473,10 @@ function preprocess(context, getEditsForFileRename) {
 				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;
@@ -460,7 +505,7 @@ const plugin = (module$1) => {
 			data,
 			server: createEventServer(info)
 		};
-		setTimeout(() => {
+		queueMicrotask(() => {
 			context.language = info.project.__vue__?.language;
 			if (!context.language || !data.features.unimport.componentReferences) return;
 			const languageService = info.project.getLanguageService();
@@ -477,7 +522,7 @@ const plugin = (module$1) => {
 					return Reflect.set(...args);
 				}
 			});
-		}, 0);
+		});
 		for (const [key, method] of [
 			["findRenameLocations", findRenameLocations_exports],
 			["getDefinitionAndBoundSpan", getDefinitionAndBoundSpan_exports],

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dxup/nuxt",
   "type": "module",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "TypeScript plugin for Nuxt",
   "author": "KazariEX",
   "license": "MIT",