@dxup/nuxt 0.3.0 → 0.3.1

package/README.md

@@ -73,7 +73,20 @@ Go to definition for runtime config.
 </template>
 ```
 
-### 5. unimport
+### 5. 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.
+
+### 6. unimport
 
 Find references for SFC on `<template>`.
 

package/dist/module.d.mts

@@ -23,6 +23,11 @@ interface ModuleOptions {
      * @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
@@ -41,6 +46,7 @@ declare const _default: _nuxt_schema0.NuxtModule<ModuleOptions, {
     importGlob: true;
     nitroRoutes: true;
     runtimeConfig: true;
+    typedPages: true;
     unimport: true;
   };
 }, true>;

package/dist/module.mjs

@@ -74,6 +74,7 @@ var module_default = defineNuxtModule().with({
 		importGlob: true,
 		nitroRoutes: true,
 		runtimeConfig: true,
+		typedPages: true,
 		unimport: true
 	} },
 	async setup(options, nuxt) {
@@ -86,7 +87,7 @@ var module_default = defineNuxtModule().with({
 		addTemplate({
 			filename: "dxup/data.json",
 			write: true,
-			getContents({ nuxt: nuxt$1 }) {
+			getContents({ nuxt: nuxt$1, app }) {
 				const nitroRoutes = useNitro().scannedHandlers.reduce((acc, item) => {
 					if (item.route && item.method) (acc[item.route] ??= {})[item.method] = item.handler;
 					return acc;
@@ -96,6 +97,7 @@ var module_default = defineNuxtModule().with({
 					publicDir: nuxt$1.options.dir.public,
 					configFiles: [...nuxt$1.options._nuxtConfigFiles, ...nuxt$1.options._layers.map((layer) => layer._configFile).filter(Boolean)],
 					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 }

package/dist/typescript.cjs

@@ -37,11 +37,13 @@ const initialValue = {
 	publicDir: "",
 	configFiles: [],
 	nitroRoutes: {},
+	typedPages: {},
 	features: {
 		components: true,
 		importGlob: true,
 		nitroRoutes: true,
 		runtimeConfig: true,
+		typedPages: true,
 		unimport: { componentReferences: true }
 	}
 };
@@ -66,6 +68,19 @@ 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";
 }
@@ -199,10 +214,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 +234,13 @@ 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.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 +248,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 +287,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 +328,23 @@ 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 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 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) {
@@ -460,7 +472,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 +489,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.1",
   "description": "TypeScript plugin for Nuxt",
   "author": "KazariEX",
   "license": "MIT",