@dxup/nuxt 0.2.1 → 0.3.0

package/README.md

@@ -6,31 +6,40 @@
 
 This is a TypeScript plugin that improves Nuxt DX.
 
+> [!note]
+> It's now an experimental builtin feature of Nuxt. Please refer to the [documentation](https://nuxt.com/docs/4.x/guide/going-further/experimental-features#typescriptplugin) for more details.
+
 ## Installation
 
-```bash
-pnpm i -D @dxup/nuxt
-```
+*No installation is required if you are using Nuxt 4.2 or above.*
 
 ## Usage
 
-Add the following to your `nuxt.config.ts`:
+1. Have `@dxup/unimport` installed as a dependency if you haven't enabled the `shamefullyHoist` option with pnpm workspace.
 
-```ts
-export default defineNuxtConfig({
-  modules: [
-    "@dxup/nuxt",
-  ],
-});
-```
+2. Add the following to your `nuxt.config.ts`:
+
+   ```ts
+   export default defineNuxtConfig({
+     experimental: {
+       typescriptPlugin: true,
+     },
+   });
+   ```
+
+3. Run `nuxt prepare` and restart the tsserver.
 
 ## Features
 
-### components
+### 1. components
 
 Update references when renaming auto imported component files.
 
-### importGlob
+For example, when renaming `components/foo/bar.vue` to `components/foo/baz.vue`, all usages of `<FooBar />` will be updated to `<FooBaz />`.
+
+It only works when the dev server is active.
+
+### 2. importGlob
 
 Go to definition for dynamic imports with glob patterns.
 
@@ -41,7 +50,7 @@ import.meta.glob("~/assets/*.webp");
 //               ^^^^^^^^^^^^^^^^^
 ```
 
-### nitroRoutes
+### 3. nitroRoutes
 
 Go to definition for nitro routes in data fetching methods.
 
@@ -53,7 +62,7 @@ useFetch("/api/foo");
 
 It will fallback to resolve the URL from your `public` directory when no nitro routes match.
 
-### runtimeConfig
+### 4. runtimeConfig
 
 Go to definition for runtime config.
 
@@ -64,6 +73,14 @@ Go to definition for runtime config.
 </template>
 ```
 
-### unimport
+### 5. unimport
+
+Find references for SFC on `<template>`.
+
+```vue
+....<template>
+<!-- ^^^^^^^^ -->
+</template>
+```
 
 Please refer to the [@dxup/unimport](/packages/unimport) package for more details.

package/dist/{module.d.ts → module.d.mts}

@@ -27,9 +27,22 @@ interface ModuleOptions {
      * Whether to enable enhanced navigation for auto imported APIs.
      * @default true
      */
-    unimport?: boolean;
+    unimport?: boolean | {
+      /**
+       * Whether to enable Find References for SFC on `<template>`.
+       */
+      componentReferences: boolean;
+    };
   };
 }
-declare const _default: _nuxt_schema0.NuxtModule<ModuleOptions, ModuleOptions, false>;
+declare const _default: _nuxt_schema0.NuxtModule<ModuleOptions, {
+  features: {
+    components: true;
+    importGlob: true;
+    nitroRoutes: true;
+    runtimeConfig: true;
+    unimport: true;
+  };
+}, true>;
 //#endregion
 export { ModuleOptions, _default as default };

package/dist/{module.js → module.mjs}

@@ -64,7 +64,7 @@ async function onComponentsRename(nuxt, { fileName, references }) {
 
 //#endregion
 //#region src/module/index.ts
-var module_default = defineNuxtModule({
+var module_default = defineNuxtModule().with({
 	meta: {
 		name,
 		configKey: "dxup"
@@ -87,18 +87,24 @@ var module_default = defineNuxtModule({
 			filename: "dxup/data.json",
 			write: true,
 			getContents({ nuxt: nuxt$1 }) {
-				const nitro = useNitro();
+				const nitroRoutes = useNitro().scannedHandlers.reduce((acc, item) => {
+					if (item.route && item.method) (acc[item.route] ??= {})[item.method] = item.handler;
+					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)],
-					nitroRoutes: Object.fromEntries(nitro.scannedHandlers.filter((item) => item.route).map((item) => [`${item.route}+${item.method ?? "get"}`, item.handler])),
-					features: options.features
+					nitroRoutes,
+					features: {
+						...options.features,
+						unimport: { componentReferences: typeof options.features.unimport === "object" ? options.features.unimport.componentReferences : options.features.unimport }
+					}
 				};
 				return JSON.stringify(data, null, 2);
 			}
 		});
-		(await createEventClient(nuxt)).on("components:rename", (data) => onComponentsRename(nuxt, data));
+		if (nuxt.options.dev) (await createEventClient(nuxt)).on("components:rename", (data) => onComponentsRename(nuxt, data));
 	}
 });
 function append(plugins, target, ...keys) {

package/dist/typescript.cjs

@@ -1,32 +1,23 @@
 //#region rolldown:runtime
-var __create = Object.create;
 var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
-		key = keys[i];
-		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
-			get: ((k) => from[k]).bind(null, key),
-			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+var __export = (all, symbols) => {
+	let target = {};
+	for (var name in all) {
+		__defProp(target, name, {
+			get: all[name],
+			enumerable: true
 		});
 	}
-	return to;
+	if (symbols) {
+		__defProp(target, Symbol.toStringTag, { value: "Module" });
+	}
+	return target;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
-	value: mod,
-	enumerable: true
-}) : target, mod));
 
 //#endregion
-let pathe = require("pathe");
-pathe = __toESM(pathe);
 let node_fs_promises = require("node:fs/promises");
-node_fs_promises = __toESM(node_fs_promises);
+let pathe = require("pathe");
 let tinyglobby = require("tinyglobby");
-tinyglobby = __toESM(tinyglobby);
 
 //#region src/event/server.ts
 function createEventServer(info) {
@@ -39,12 +30,115 @@ function createEventServer(info) {
 	return { write };
 }
 
+//#endregion
+//#region src/typescript/data.ts
+const initialValue = {
+	buildDir: "",
+	publicDir: "",
+	configFiles: [],
+	nitroRoutes: {},
+	features: {
+		components: true,
+		importGlob: true,
+		nitroRoutes: true,
+		runtimeConfig: true,
+		unimport: { componentReferences: true }
+	}
+};
+const callbacks = {};
+function createData(ts, info) {
+	const path = (0, pathe.join)(info.languageServiceHost.getCurrentDirectory(), "dxup/data.json");
+	const data = {};
+	const updates = callbacks[path] ??= (ts.sys.watchFile?.(path, () => {
+		const text$1 = ts.sys.readFile(path);
+		for (const update of updates) update(text$1);
+	}), []);
+	updates.push((text$1) => {
+		Object.assign(data, {
+			...initialValue,
+			...text$1 ? JSON.parse(text$1) : {}
+		});
+	});
+	const text = ts.sys.readFile(path);
+	updates.at(-1)(text);
+	return data;
+}
+
+//#endregion
+//#region src/typescript/utils.ts
+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;
+	const map = language.maps.get(serviceScript.code, sourceScript);
+	const leadingOffset = sourceScript.snapshot.getLength();
+	const offset = 1145141919810;
+	const mapping = {
+		sourceOffsets: [offset],
+		generatedOffsets: [position - leadingOffset],
+		lengths: [0],
+		data: {
+			completion: true,
+			navigation: true,
+			semantic: true,
+			verification: true
+		}
+	};
+	const original = map.toGeneratedLocation;
+	map.toGeneratedLocation = function* (sourceOffset, ...args) {
+		if (sourceOffset === offset) yield [mapping.generatedOffsets[0], mapping];
+		yield* original.call(this, sourceOffset, ...args);
+	};
+	try {
+		return method(offset);
+	} finally {
+		map.toGeneratedLocation = original;
+	}
+}
+
+//#endregion
+//#region src/typescript/features/findReferences.ts
+var findReferences_exports = /* @__PURE__ */ __export({ postprocess: () => postprocess$1 });
+function postprocess$1(context, language, findReferences) {
+	const { ts, info } = context;
+	return (...args) => {
+		const result = findReferences(...args);
+		if (!result?.length) {
+			const sourceScript = language.scripts.get(args[0]);
+			const root = sourceScript?.generated?.root;
+			if (!isVueVirtualCode(root)) return;
+			const start = (root.sfc.template?.start ?? Infinity) + 1;
+			if (args[1] < start || args[1] > start + 8) return;
+			const sourceFile = info.languageService.getProgram().getSourceFile(args[0]);
+			if (!sourceFile) return;
+			for (const statement of sourceFile.statements) if (ts.isExportAssignment(statement)) return withVirtualOffset(language, sourceScript, statement.getChildAt(1).getStart(sourceFile), (position) => findReferences(args[0], position));
+			return;
+		}
+		return result;
+	};
+}
+
 //#endregion
 //#region src/typescript/features/findRenameLocations.ts
-function findRenameLocations(context, findRenameLocations$1) {
+var findRenameLocations_exports = /* @__PURE__ */ __export({ preprocess: () => preprocess$2 });
+function preprocess$2(context, findRenameLocations) {
 	const { data } = context;
 	return (...args) => {
-		return findRenameLocations$1(...args)?.filter((edit) => {
+		return findRenameLocations(...args)?.filter((edit) => {
 			return !edit.fileName.startsWith(data.buildDir);
 		});
 	};
@@ -80,15 +174,46 @@ function isTextSpanWithin(node, textSpan, sourceFile) {
 
 //#endregion
 //#region src/typescript/features/getDefinitionAndBoundSpan.ts
+var getDefinitionAndBoundSpan_exports = /* @__PURE__ */ __export({
+	postprocess: () => postprocess,
+	preprocess: () => preprocess$1
+});
 const fetchFunctions = new Set([
 	"$fetch",
 	"useFetch",
 	"useLazyFetch"
 ]);
-function getDefinitionAndBoundSpan(context, getDefinitionAndBoundSpan$1) {
+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;
+			if (!isVueVirtualCode(root)) return result;
+			const textSpan = {
+				start: (root.sfc.template?.start ?? Infinity) + 1,
+				length: 8
+			};
+			if (args[1] >= textSpan.start && args[1] <= textSpan.start + textSpan.length) return {
+				textSpan,
+				definitions: [{
+					fileName: args[0],
+					textSpan,
+					kind: ts.ScriptElementKind.scriptElement,
+					name: args[0],
+					containerKind: ts.ScriptElementKind.unknown,
+					containerName: ""
+				}]
+			};
+			return result;
+		}
+		return result;
+	};
+}
+function preprocess$1(context, getDefinitionAndBoundSpan) {
 	const { ts, info, data } = context;
 	return (...args) => {
-		const result = getDefinitionAndBoundSpan$1(...args);
+		const result = getDefinitionAndBoundSpan(...args);
 		if (!result) {
 			const program$1 = info.languageService.getProgram();
 			const sourceFile = program$1.getSourceFile(args[0]);
@@ -180,8 +305,11 @@ function visitNitroRoutes(ts, data, checker, sourceFile, node, position) {
 	}
 	const paths = [];
 	if (routeType?.isStringLiteral()) {
-		for (const type of methodType?.isUnion() ? methodType.types : [methodType]) if (type?.isStringLiteral()) {
-			const path = data.nitroRoutes[`${routeType.value}+${type.value}`];
+		const alternatives = data.nitroRoutes[routeType.value] ?? {};
+		const methods = [];
+		for (const type of methodType?.isUnion() ? methodType.types : [methodType]) if (type?.isStringLiteral()) methods.push(type.value);
+		for (const method of methods.length ? methods : Object.keys(alternatives)) {
+			const path = alternatives[method];
 			if (path !== void 0) paths.push(path);
 		}
 	}
@@ -282,27 +410,13 @@ function* forwardRuntimeConfig(context, definition, path) {
 	}
 }
 
-//#endregion
-//#region src/typescript/utils.ts
-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
-	};
-}
-
 //#endregion
 //#region src/typescript/features/getEditsForFileRename.ts
-function getEditsForFileRename(context, getEditsForFileRename$1) {
+var getEditsForFileRename_exports = /* @__PURE__ */ __export({ preprocess: () => preprocess });
+function preprocess(context, getEditsForFileRename) {
 	const { ts, info, data, server } = context;
 	return (...args) => {
-		const result = getEditsForFileRename$1(...args);
+		const result = getEditsForFileRename(...args);
 		if (!result?.length) return result;
 		const program = info.languageService.getProgram();
 		const references = {};
@@ -339,53 +453,43 @@ function getEditsForFileRename(context, getEditsForFileRename$1) {
 const plugin = (module$1) => {
 	const { typescript: ts } = module$1;
 	return { create(info) {
+		const data = createData(ts, info);
 		const context = {
 			ts,
 			info,
-			data: createData(ts, info),
+			data,
 			server: createEventServer(info)
 		};
 		setTimeout(() => {
-			context.language = (info.project.__vue__ ?? info.project["program"]?.__vue__)?.language;
-		}, 500);
+			context.language = info.project.__vue__?.language;
+			if (!context.language || !data.features.unimport.componentReferences) return;
+			const languageService = info.project.getLanguageService();
+			const methods = {};
+			for (const [key, method] of [["findReferences", findReferences_exports], ["getDefinitionAndBoundSpan", getDefinitionAndBoundSpan_exports]]) {
+				const original = languageService[key];
+				methods[key] = method.postprocess(context, context.language, original);
+			}
+			info.project["languageService"] = new Proxy(languageService, {
+				get(target, p, receiver) {
+					return methods[p] ?? Reflect.get(target, p, receiver);
+				},
+				set(...args) {
+					return Reflect.set(...args);
+				}
+			});
+		}, 0);
 		for (const [key, method] of [
-			["findRenameLocations", findRenameLocations],
-			["getDefinitionAndBoundSpan", getDefinitionAndBoundSpan],
-			["getEditsForFileRename", getEditsForFileRename]
+			["findRenameLocations", findRenameLocations_exports],
+			["getDefinitionAndBoundSpan", getDefinitionAndBoundSpan_exports],
+			["getEditsForFileRename", getEditsForFileRename_exports]
 		]) {
 			const original = info.languageService[key];
-			info.languageService[key] = method(context, original);
+			info.languageService[key] = method.preprocess(context, original);
 		}
 		return info.languageService;
 	} };
 };
 var typescript_default = plugin;
-function createData(ts, info) {
-	const initialValue = {
-		buildDir: "",
-		publicDir: "",
-		configFiles: [],
-		nitroRoutes: {},
-		features: {
-			components: true,
-			importGlob: true,
-			nitroRoutes: true,
-			runtimeConfig: true
-		}
-	};
-	const path = (0, pathe.join)(info.languageServiceHost.getCurrentDirectory(), "dxup/data.json");
-	const data = {};
-	update();
-	ts.sys.watchFile?.(path, update);
-	return data;
-	function update() {
-		const text = ts.sys.readFile(path);
-		Object.assign(data, {
-			...initialValue,
-			...text ? JSON.parse(text) : {}
-		});
-	}
-}
 
 //#endregion
 module.exports = typescript_default;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@dxup/nuxt",
   "type": "module",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "TypeScript plugin for Nuxt",
   "author": "KazariEX",
   "license": "MIT",
   "repository": "KazariEX/dxup",
   "exports": {
-    ".": "./dist/module.js",
+    ".": "./dist/module.mjs",
     "./package.json": "./package.json"
   },
   "main": "./dist/typescript.cjs",
@@ -16,18 +16,18 @@
     "dist"
   ],
   "dependencies": {
-    "@nuxt/kit": "^4.2.0",
-    "chokidar": "^4.0.3",
+    "@nuxt/kit": "^4.2.2",
+    "chokidar": "^5.0.0",
     "pathe": "^2.0.3",
     "tinyglobby": "^0.2.15",
-    "@dxup/unimport": "^0.1.1"
+    "@dxup/unimport": "^0.1.2"
   },
   "devDependencies": {
     "@dxup/shared": "",
-    "@volar/language-core": "^2.4.23",
-    "@volar/typescript": "^2.4.23",
-    "@vue/language-core": "^3.1.3",
-    "nuxt": "^4.2.0",
+    "@volar/language-core": "^2.4.26",
+    "@volar/typescript": "^2.4.26",
+    "@vue/language-core": "^3.1.8",
+    "nuxt": "^4.2.2",
     "typescript": "^5.9.3"
   },
   "scripts": {