@dxup/nuxt 0.2.0 → 0.2.2

package/README.md

@@ -6,13 +6,8 @@
 
 This is a TypeScript plugin that improves Nuxt DX.
 
-## Features
-
-- Update references when renaming auto imported component files
-- Go to definition for dynamic imports with glob patterns
-- Go to definition for nitro routes in data fetching methods
-- Go to definition for runtime config
-- [@dxup/unimport](/packages/unimport)
+> [!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
 
@@ -31,3 +26,51 @@ export default defineNuxtConfig({
   ],
 });
 ```
+
+## Features
+
+### 1. components
+
+Update references when renaming auto imported component files.
+
+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.
+
+```ts
+import(`~/assets/${name}.webp`);
+//     ^^^^^^^^^^^^^^^^^^^^^^^
+import.meta.glob("~/assets/*.webp");
+//               ^^^^^^^^^^^^^^^^^
+```
+
+### 3. nitroRoutes
+
+Go to definition for nitro routes in data fetching methods.
+
+```ts
+useFetch("/api/foo");
+//       ^^^^^^^^^^
+// Also `$fetch` and `useLazyFetch`.
+```
+
+It will fallback to resolve the URL from your `public` directory when no nitro routes match.
+
+### 4. runtimeConfig
+
+Go to definition for runtime config.
+
+```vue
+<template>
+  {{ $config.public.domain }}
+  <!--              ^^^^^^ -->
+</template>
+```
+
+### 5. unimport
+
+Please refer to the [@dxup/unimport](/packages/unimport) package for more details.

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

@@ -88,19 +88,17 @@ var module_default = defineNuxtModule({
 			write: true,
 			getContents({ nuxt: nuxt$1 }) {
 				const nitro = useNitro();
-				const nitroRoutes = options.features?.nitroRoutes && Object.fromEntries(nitro.scannedHandlers.filter((item) => item.route).map((item) => [`${item.route}+${item.method ?? "get"}`, item.handler]));
 				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)],
-					components: options.features?.components,
-					importGlob: options.features?.importGlob,
-					nitroRoutes,
-					runtimeConfig: options.features?.runtimeConfig
+					nitroRoutes: Object.fromEntries(nitro.scannedHandlers.filter((item) => item.route).map((item) => [`${item.route}+${item.method ?? "get"}`, item.handler])),
+					features: options.features
 				};
 				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,6 @@
-//#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
-		});
-	}
-	return to;
-};
-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,6 +13,39 @@ 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
+	}
+};
+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/features/findRenameLocations.ts
 function findRenameLocations(context, findRenameLocations$1) {
@@ -74,8 +81,8 @@ function* binaryVisit(ts, sourceFile, node, position) {
 		}
 	}
 }
-function isTextSpanEqual(node, textSpan, sourceFile) {
-	return textSpan.start + textSpan.length === node.getEnd() && textSpan.start === node.getStart(sourceFile);
+function isTextSpanWithin(node, textSpan, sourceFile) {
+	return textSpan.start + textSpan.length <= node.getEnd() && textSpan.start >= node.getStart(sourceFile);
 }
 
 //#endregion
@@ -96,8 +103,8 @@ function getDefinitionAndBoundSpan(context, getDefinitionAndBoundSpan$1) {
 			const checker = program$1.getTypeChecker();
 			let res;
 			for (const node of forEachTouchingNode(ts, sourceFile, args[1])) {
-				if (data.importGlob) res ??= visitImportGlob(ts, info, sourceFile, node, args[1]);
-				if (data.nitroRoutes) res ??= visitNitroRoutes(ts, checker, sourceFile, node, args[1], data.nitroRoutes);
+				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 (res) return res;
 		}
@@ -108,7 +115,7 @@ function getDefinitionAndBoundSpan(context, getDefinitionAndBoundSpan$1) {
 			const sourceFile = program.getSourceFile(definition.fileName);
 			if (!sourceFile) continue;
 			let result$1 = [];
-			if (data.runtimeConfig && definition.fileName.endsWith("runtime-config.d.ts")) result$1 = visitRuntimeConfig(context, sourceFile, definition);
+			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);
 				definitions.delete(definition);
@@ -159,8 +166,8 @@ function visitImportGlob(ts, info, sourceFile, node, position) {
 		}))
 	};
 }
-function visitNitroRoutes(ts, checker, sourceFile, node, position, nitroRoutes) {
-	if (!ts.isCallExpression(node) || !ts.isIdentifier(node.expression) || !fetchFunctions.has(node.expression.text) || !node.arguments.length) return;
+function visitNitroRoutes(ts, data, checker, sourceFile, node, position) {
+	if (!ts.isCallExpression(node) || !ts.isIdentifier(node.expression) || !fetchFunctions.has(node.expression.text) || !node.arguments.length || !ts.isStringLiteralLike(node.arguments[0])) return;
 	const firstArg = node.arguments[0];
 	const start = firstArg.getStart(sourceFile);
 	const end = firstArg.getEnd();
@@ -178,11 +185,16 @@ function visitNitroRoutes(ts, checker, sourceFile, node, position, nitroRoutes)
 		routeType = typeArguments?.[2];
 		methodType = typeArguments?.[3];
 	}
-	if (!routeType?.isStringLiteral()) return;
 	const paths = [];
-	for (const type of methodType?.isUnion() ? methodType.types : [methodType]) if (type?.isStringLiteral()) {
-		const path = nitroRoutes[`${routeType.value}+${type.value}`];
-		if (path !== void 0) paths.push(path);
+	if (routeType?.isStringLiteral()) {
+		for (const type of methodType?.isUnion() ? methodType.types : [methodType]) if (type?.isStringLiteral()) {
+			const path = data.nitroRoutes[`${routeType.value}+${type.value}`];
+			if (path !== void 0) paths.push(path);
+		}
+	}
+	if (!paths.length && firstArg.text.startsWith("/")) {
+		const fallback = (0, pathe.join)(data.publicDir, firstArg.text);
+		if (ts.sys.fileExists(fallback)) paths.push(fallback);
 	}
 	return {
 		textSpan: {
@@ -211,7 +223,7 @@ function visitRuntimeConfig(context, sourceFile, definition) {
 		if (ts.isInterfaceDeclaration(node) && ts.isIdentifier(node.name)) key = node.name.text;
 		else if (ts.isPropertySignature(node) && ts.isIdentifier(node.name)) {
 			key = node.name.text;
-			if (isTextSpanEqual(node.name, definition.textSpan, sourceFile)) {
+			if (isTextSpanWithin(node.name, definition.textSpan, sourceFile)) {
 				path.push(key);
 				definitions = [...forwardRuntimeConfig(context, definition, path)];
 				break;
@@ -303,7 +315,7 @@ function getEditsForFileRename(context, getEditsForFileRename$1) {
 		const references = {};
 		for (const change of result) {
 			const { fileName, textChanges } = change;
-			if (data.components && fileName.endsWith("components.d.ts")) {
+			if (data.features.components && fileName.endsWith("components.d.ts")) {
 				const sourceFile = program.getSourceFile(fileName);
 				if (!sourceFile) continue;
 				for (const { span } of textChanges) for (const node of forEachTouchingNode(ts, sourceFile, span.start)) {
@@ -355,28 +367,6 @@ const plugin = (module$1) => {
 	} };
 };
 var typescript_default = plugin;
-function createData(ts, info) {
-	const initialValue = {
-		buildDir: "",
-		configFiles: [],
-		components: true,
-		importGlob: true,
-		nitroRoutes: {},
-		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.0",
+  "version": "0.2.2",
   "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.1.3",
+    "@nuxt/kit": "^4.2.1",
     "chokidar": "^4.0.3",
-    "pathe": "2.0.3",
+    "pathe": "^2.0.3",
     "tinyglobby": "^0.2.15",
-    "@dxup/unimport": "^0.1.0"
+    "@dxup/unimport": "^0.1.2"
   },
   "devDependencies": {
     "@dxup/shared": "",
     "@volar/language-core": "^2.4.23",
     "@volar/typescript": "^2.4.23",
-    "@vue/language-core": "^3.1.1",
-    "nuxt": "^4.1.3",
+    "@vue/language-core": "^3.1.3",
+    "nuxt": "^4.2.1",
     "typescript": "^5.9.3"
   },
   "scripts": {