@x18n/node 0.0.0 → 0.0.3

package/dist/index.mjs

@@ -1,16 +1,16 @@
 import { createRequire } from "node:module";
-import { existsSync } from "node:fs";
+import { existsSync, readFileSync } from "node:fs";
 import { mkdir, readFile, readdir, rm, writeFile } from "node:fs/promises";
 import { dirname, isAbsolute, join, relative, resolve, sep } from "node:path";
-import { pathToFileURL } from "node:url";
+import { fileURLToPath, pathToFileURL } from "node:url";
 import { compileYamlPlugin } from "@x18n/builtins/yaml-plugin";
 import { PluginFileSchema, X18nError, createProject, hashText, isX18nError, resolveConfig, validate } from "@x18n/core";
 import { createJiti } from "jiti";
+import { glob } from "tinyglobby";
 import { parse, stringify } from "yaml";
 import process from "node:process";
 import { watch } from "chokidar";
 import ignore from "ignore";
-import { glob } from "tinyglobby";
 import { createBuiltins } from "@x18n/builtins";
 import { applyEdits, modify, parse as parse$1 } from "jsonc-parser";
 //#region src/config.ts
@@ -41,9 +41,17 @@ function findConfigUpward(cwd) {
 		dir = parent;
 	}
 }
+const core = fileURLToPath(import.meta.resolve("@x18n/core"));
+const presets = fileURLToPath(import.meta.resolve("@x18n/builtins/presets"));
 const jiti = createJiti(import.meta.url, {
 	moduleCache: false,
-	interopDefault: true
+	interopDefault: true,
+	alias: {
+		"@x18n/core": core,
+		"@x18n/cli/presets": presets,
+		"@x18n/cli": core,
+		"@x18n/builtins/presets": presets
+	}
 });
 /** Imports a JS or TS module (config, plugin, executed resource). */
 async function importModule(file) {
@@ -91,16 +99,36 @@ function createPluginLoader(dir) {
 		}
 	};
 }
-/** Paths from `root` up to the git root, relative to `root` (`..`, `../..`), whose manifests count for detection. */
-function manifestRootsOf(root, gitRoot) {
+/** Workspace package directories of `root`, from `pnpm-workspace.yaml` or the `workspaces` field of `package.json`. */
+async function workspacePackages(root) {
+	const pnpm = parse(await readFile(join(root, "pnpm-workspace.yaml"), "utf8").catch(() => "") || "{}");
+	const manifest = JSON.parse(await readFile(join(root, "package.json"), "utf8").catch(() => "{}"));
+	const field = (value, key) => typeof value === "object" && value !== null && key in value ? new Map(Object.entries(value)).get(key) : void 0;
+	const workspaces = field(manifest, "workspaces");
+	const patterns = [
+		field(pnpm, "packages"),
+		workspaces,
+		field(workspaces, "packages")
+	].flatMap((list) => Array.isArray(list) ? list.filter((item) => typeof item === "string") : []);
+	if (patterns.length === 0) return [];
+	return (await glob(patterns.filter((p) => !p.startsWith("!")).map((p) => `${p.replace(/\/$/, "")}/package.json`), {
+		cwd: root,
+		ignore: ["**/node_modules/**", ...patterns.filter((p) => p.startsWith("!")).map((p) => p.slice(1))]
+	})).map((file) => dirname(file)).sort();
+}
+/**
+* Directories, relative to `root`, whose manifests count for preset detection: the parents up to the
+* git root (`..`, `../..`), and the workspace packages of a monorepo root, where the i18n library is often listed.
+*/
+async function manifestRootsOf(root, gitRoot) {
 	const out = [];
-	if (!gitRoot) return out;
+	const top = gitRoot ?? resolve(root);
 	let dir = resolve(root);
-	while (dir !== gitRoot && dir.startsWith(gitRoot)) {
+	while (dir !== top && dir.startsWith(top)) {
 		dir = dirname(dir);
 		out.push(relative(root, dir).replace(/\\/g, "/"));
 	}
-	return out;
+	return [...out, ...await workspacePackages(root)];
 }
 //#endregion
 //#region src/host.ts
@@ -256,90 +284,6 @@ function createNodeHost(root, options = {}) {
 	};
 }
 //#endregion
-//#region src/load.ts
-async function projectSpecs(rootConfigFile, cwd) {
-	const configDir = rootConfigFile ? dirname(rootConfigFile) : resolve(cwd);
-	const rootConfig = rootConfigFile ? await loadConfigFile(rootConfigFile) : {};
-	const root = resolve(configDir, rootConfig.root ?? ".");
-	if (!rootConfig.projects?.length) return {
-		root,
-		specs: [{
-			root,
-			config: rootConfig,
-			parent: void 0,
-			configFile: rootConfigFile
-		}]
-	};
-	const { projects, ...parent } = rootConfig;
-	const dirs = await glob([...projects], {
-		cwd: root,
-		onlyDirectories: true,
-		ignore: ["**/node_modules/**"]
-	});
-	const specs = [];
-	for (const dir of dirs.sort()) {
-		const projectRoot = resolve(root, dir);
-		const file = findConfigFile(projectRoot);
-		const config = file ? await loadConfigFile(file) : {};
-		specs.push({
-			root: resolve(projectRoot, config.root ?? "."),
-			config,
-			parent,
-			configFile: file
-		});
-	}
-	return {
-		root,
-		specs
-	};
-}
-/** Finds the config, resolves every project and waits until each is indexed. */
-async function loadWorkspace(options) {
-	const configFile = options.configFile ? resolve(options.cwd, options.configFile) : options.upward === false ? findConfigFile(resolve(options.cwd)) : findConfigUpward(options.cwd);
-	const { root, specs } = await projectSpecs(configFile, options.cwd);
-	const builtins = options.builtins ?? createBuiltins();
-	const gitRoot = findGitRoot(root);
-	const loaded = [];
-	for (const spec of specs) {
-		const name = spec.config.name ?? (spec.root === root ? relative(dirname(root), root) : relative(root, spec.root)).replace(/\\/g, "/");
-		if (options.project !== void 0 && options.project !== name) continue;
-		const host = createNodeHost(spec.root, {
-			cacheDir: options.cache === false ? false : void 0,
-			logger: options.logger
-		});
-		const projectHost = options.wrapHost?.(host) ?? host;
-		const setup = await resolveConfig({
-			host: projectHost,
-			config: spec.config,
-			parent: spec.parent,
-			builtins,
-			name,
-			runtime: "node",
-			loadPlugin: createPluginLoader(spec.configFile ? dirname(spec.configFile) : spec.root),
-			manifestRoots: manifestRootsOf(spec.root, gitRoot)
-		});
-		const project = createProject({
-			host: projectHost,
-			setup
-		});
-		await project.ready;
-		await host.flush();
-		loaded.push({
-			name,
-			root: spec.root,
-			configFile: spec.configFile,
-			host,
-			project
-		});
-	}
-	if (options.project !== void 0 && loaded.length === 0) throw new X18nError("X18N0003", options.project);
-	return {
-		root,
-		configFile,
-		projects: loaded
-	};
-}
-//#endregion
 //#region src/migrate.ts
 const frameworkPresets = {
 	"vue": "vue-i18n",
@@ -427,13 +371,30 @@ const handledByDefaults = [
 async function readText(path) {
 	return readFile(path, "utf8").catch(() => void 0);
 }
+/** The first of `paths` that exists; the i18n-ally-next name comes first. */
+async function readFirst(root, paths) {
+	for (const path of paths) {
+		const text = await readText(join(root, path));
+		if (text !== void 0) return {
+			path,
+			text
+		};
+	}
+}
 function isRecord(value) {
 	return typeof value === "object" && value !== null && !Array.isArray(value);
 }
 const asStrings = (value) => (Array.isArray(value) ? value : value === void 0 ? [] : [value]).filter((v) => typeof v === "string");
-/** `i18n-ally.*` and legacy `vue-i18n-ally.*` keys from `.vscode/settings.json` and `*.code-workspace` files. */
+/** Setting prefixes by priority: the i18n-ally-next fork renames `i18n-ally.*` keys, so its value is the newest. */
+const settingPrefixes = [
+	"i18n-ally-next",
+	"i18n-ally",
+	"vue-i18n-ally"
+];
+/** `i18n-ally-next.*`, `i18n-ally.*` and legacy `vue-i18n-ally.*` keys from `.vscode/settings.json` and `*.code-workspace` files. */
 async function readSettings(root) {
 	const settings = /* @__PURE__ */ new Map();
+	const ranks = /* @__PURE__ */ new Map();
 	const keys = [];
 	const sources = [];
 	const vscode = await readText(join(root, ".vscode/settings.json"));
@@ -445,10 +406,13 @@ async function readSettings(root) {
 	for (const source of sources) {
 		if (!isRecord(source)) continue;
 		for (const [key, value] of Object.entries(source)) {
-			const match = /^(?:vue-)?i18n-ally\.(.+)$/.exec(key);
-			if (match && !settings.has(match[1])) {
-				settings.set(match[1], value);
-				keys.push(key);
+			const match = /^(i18n-ally-next|i18n-ally|vue-i18n-ally)\.(.+)$/.exec(key);
+			if (!match) continue;
+			keys.push(key);
+			const rank = settingPrefixes.indexOf(match[1]);
+			if (rank < (ranks.get(match[2]) ?? Infinity)) {
+				settings.set(match[2], value);
+				ranks.set(match[2], rank);
 			}
 		}
 	}
@@ -521,7 +485,7 @@ function configFile(config, format) {
 	};
 	return {
 		path: "x18n.config.ts",
-		content: `import { defineConfig } from 'x18n'\n\n// Migrated from i18n-ally by \`x18n migrate i18n-ally\`.\nexport default defineConfig(${JSON.stringify(config, null, 2).replace(/"([a-z_$][\w$]*)":/gi, "$1:").replace(/'/g, "\\'").replace(/"/g, "'")})\n`
+		content: `import { defineConfig } from '@x18n/core'\n\n// Migrated from i18n-ally by \`x18n migrate i18n-ally\`.\nexport default defineConfig(${JSON.stringify(config, null, 2).replace(/"([a-z_$][\w$]*)":/gi, "$1:").replace(/'/g, "\\'").replace(/"/g, "'")})\n`
 	};
 }
 function readerOf(settings) {
@@ -639,17 +603,16 @@ function mapConfig(settings, parts, notes) {
 		...Object.keys(extract).length ? { extract } : {}
 	};
 }
-/** Converts i18n-ally settings, custom framework and reviews into x18n files. Never deletes i18n-ally files. */
-async function migrateI18nAlly(root, options = {}) {
+/** The x18n config that a project's i18n-ally settings and custom framework mean, or undefined without any. */
+async function readI18nAllyConfig(root) {
 	const { settings, keys } = await readSettings(root);
-	const customText = await readText(join(root, ".vscode/i18n-ally-custom-framework.yml"));
-	const reviews = await readText(join(root, ".vscode/i18n-ally-reviews.yml"));
+	return configOf(root, settings, keys);
+}
+async function configOf(root, settings, keys) {
+	const custom = await readFirst(root, [".vscode/i18n-ally-next-custom-framework.yml", ".vscode/i18n-ally-custom-framework.yml"]);
+	const customText = custom?.text;
+	if (keys.length === 0 && customText === void 0) return void 0;
 	const notes = [];
-	if (keys.length === 0 && customText === void 0) return {
-		files: [],
-		notes: ["No i18n-ally settings found."],
-		removable: []
-	};
 	const parts = {
 		regex: [],
 		scopes: void 0,
@@ -659,28 +622,43 @@ async function migrateI18nAlly(root, options = {}) {
 	};
 	if (customText !== void 0) customFramework(parse(customText), parts);
 	const config = mapConfig(settings, parts, notes);
-	const files = [];
-	const plugin = {
-		$schema: "../node_modules/@x18n/core/schema/plugin.json",
-		name: "custom",
-		...parts.regex.length ? { scanners: { regex: parts.regex } } : {},
-		...parts.scopes ? { scopes: { regex: parts.scopes } } : {},
-		...parts.templates.length ? { extract: { templates: parts.templates } } : {},
-		...Object.keys(parts.localeInfo).length ? { localeInfo: parts.localeInfo } : {}
+	if (parts.exclusive) notes.push("The custom framework was exclusive (`monopoly`), so built-in presets are turned off (`presets: []`).");
+	return {
+		config,
+		plugin: parts.regex.length > 0 || parts.scopes !== void 0 || parts.templates.length > 0 || Object.keys(parts.localeInfo).length > 0 ? {
+			name: "custom",
+			...parts.regex.length ? { scanners: { regex: parts.regex } } : {},
+			...parts.scopes ? { scopes: { regex: parts.scopes } } : {},
+			...parts.templates.length ? { extract: { templates: parts.templates } } : {},
+			...Object.keys(parts.localeInfo).length ? { localeInfo: parts.localeInfo } : {}
+		} : void 0,
+		notes,
+		keys,
+		customFramework: custom?.path
 	};
-	const needsPlugin = parts.regex.length > 0 || parts.scopes !== void 0 || parts.templates.length > 0 || Object.keys(parts.localeInfo).length > 0;
-	const finalConfig = needsPlugin ? {
+}
+/** Converts i18n-ally settings, custom framework and reviews into x18n files. Never deletes i18n-ally files. */
+async function migrateI18nAlly(root, options = {}) {
+	const { settings, keys } = await readSettings(root);
+	const found = await configOf(root, settings, keys);
+	if (!found) return {
+		files: [],
+		notes: ["No i18n-ally settings found."],
+		removable: []
+	};
+	const { config, plugin } = found;
+	const notes = [...found.notes];
+	const reviews = (await readFirst(root, [".vscode/i18n-ally-next-reviews.yml", ".vscode/i18n-ally-reviews.yml"]))?.text;
+	const files = [];
+	const finalConfig = plugin !== void 0 ? {
 		...config,
 		plugins: ["./x18n/custom.x18n-plugin.yml"]
 	} : config;
 	files.push(configFile(finalConfig, options.format ?? "ts"));
-	if (needsPlugin) {
-		const { $schema, ...rest } = plugin;
-		files.push({
-			path: "x18n/custom.x18n-plugin.yml",
-			content: `# yaml-language-server: $schema=${$schema}\n${stringify(rest)}`
-		});
-	}
+	if (plugin) files.push({
+		path: "x18n/custom.x18n-plugin.yml",
+		content: `# yaml-language-server: $schema=../node_modules/@x18n/core/schema/plugin.json\n${stringify(plugin)}`
+	});
 	let vscodeText = await readText(join(root, ".vscode/settings.json"));
 	if (vscodeText !== void 0) {
 		let changed = false;
@@ -703,11 +681,164 @@ async function migrateI18nAlly(root, options = {}) {
 		});
 		notes.push("Reviews were copied to `.x18n/reviews.yml`; x18n reads them once reviews ship (1.x).");
 	}
-	if (parts.exclusive) notes.push("The custom framework was exclusive (`monopoly`), so built-in presets are turned off (`presets: []`).");
 	return {
 		files,
 		notes,
-		removable: [...keys, ...customText !== void 0 ? [".vscode/i18n-ally-custom-framework.yml"] : []]
+		removable: [...keys, ...found.customFramework ? [found.customFramework] : []]
+	};
+}
+//#endregion
+//#region src/load.ts
+/** The nearest directory at or above `cwd`, up to the git root, whose `.vscode/settings.json` has i18n-ally settings. */
+function findI18nAllyRoot(cwd, upward) {
+	let dir = resolve(cwd);
+	while (true) {
+		const settings = join(dir, ".vscode/settings.json");
+		if (existsSync(settings) && /"(?:i18n-ally-next|i18n-ally|vue-i18n-ally)\./.test(readFileSync(settings, "utf8"))) return dir;
+		const parent = dirname(dir);
+		if (!upward || parent === dir || existsSync(join(dir, ".git"))) return void 0;
+		dir = parent;
+	}
+}
+/**
+* Without an x18n config, the project's i18n-ally settings act as defaults, so an i18n-ally project
+* works as it did in the editor. A plugin applies them, so detection and the locale guess still fill gaps.
+*/
+async function i18nAllyFallback(root) {
+	const found = await readI18nAllyConfig(root);
+	if (!found) return void 0;
+	const { presets, plugins: _plugins, ...defaults } = found.config;
+	const settingsPlugin = {
+		name: "x18n:i18n-ally-settings",
+		config: (draft) => applyDefaults(draft, defaults)
+	};
+	return {
+		...presets ? { presets } : {},
+		plugins: [settingsPlugin, ...found.plugin ? [compileYamlPlugin(found.plugin)] : []]
+	};
+}
+function applyDefaults(draft, config) {
+	if (config.sourceLocale) draft.sourceLocale = config.sourceLocale;
+	if (config.ignoreLocales) draft.ignoreLocales = [...draft.ignoreLocales, ...config.ignoreLocales];
+	if (config.resources) draft.resources = [...draft.resources, ...config.resources];
+	if (config.formats) draft.formats = {
+		...draft.formats,
+		...config.formats
+	};
+	if (config.keyStyle) draft.keyStyle = config.keyStyle;
+	if (config.namespace?.default) draft.namespace = {
+		...draft.namespace,
+		default: config.namespace.default
+	};
+	if (config.usage) draft.usage = {
+		...draft.usage,
+		keysInUse: [...draft.usage.keysInUse, ...config.usage.keysInUse ?? []],
+		derivedKeys: [...draft.usage.derivedKeys, ...config.usage.derivedKeys ?? []],
+		exclude: [...draft.usage.exclude, ...config.usage.exclude ?? []]
+	};
+	if (config.write) draft.write = {
+		sort: config.write.sort ?? draft.write.sort,
+		indent: config.write.indent ?? draft.write.indent,
+		keepFilled: config.write.keepFilled ?? draft.write.keepFilled
+	};
+	if (config.extract) draft.extract = {
+		...draft.extract,
+		...config.extract
+	};
+}
+async function projectSpecs(rootConfigFile, cwd, upward) {
+	if (!rootConfigFile) {
+		const settingsRoot = findI18nAllyRoot(cwd, upward);
+		const fallback = settingsRoot && await i18nAllyFallback(settingsRoot);
+		if (settingsRoot && fallback) return {
+			root: settingsRoot,
+			specs: [{
+				root: settingsRoot,
+				config: fallback,
+				parent: void 0,
+				configFile: join(settingsRoot, ".vscode/settings.json")
+			}]
+		};
+	}
+	const configDir = rootConfigFile ? dirname(rootConfigFile) : resolve(cwd);
+	const rootConfig = rootConfigFile ? await loadConfigFile(rootConfigFile) : {};
+	const root = resolve(configDir, rootConfig.root ?? ".");
+	if (!rootConfig.projects?.length) return {
+		root,
+		specs: [{
+			root,
+			config: rootConfig,
+			parent: void 0,
+			configFile: rootConfigFile
+		}]
+	};
+	const { projects, ...parent } = rootConfig;
+	const dirs = await glob([...projects], {
+		cwd: root,
+		onlyDirectories: true,
+		ignore: ["**/node_modules/**"]
+	});
+	const specs = [];
+	for (const dir of dirs.sort()) {
+		const projectRoot = resolve(root, dir);
+		const file = findConfigFile(projectRoot);
+		const config = file ? await loadConfigFile(file) : {};
+		specs.push({
+			root: resolve(projectRoot, config.root ?? "."),
+			config,
+			parent,
+			configFile: file
+		});
+	}
+	return {
+		root,
+		specs
+	};
+}
+/** Finds the config, resolves every project and waits until each is indexed. */
+async function loadWorkspace(options) {
+	const configFile = options.configFile ? resolve(options.cwd, options.configFile) : options.upward === false ? findConfigFile(resolve(options.cwd)) : findConfigUpward(options.cwd);
+	const { root, specs } = await projectSpecs(configFile, options.cwd, options.upward !== false);
+	const builtins = options.builtins ?? createBuiltins();
+	const gitRoot = findGitRoot(root);
+	const loaded = [];
+	for (const spec of specs) {
+		const name = spec.config.name ?? (spec.root === root ? relative(dirname(root), root) : relative(root, spec.root)).replace(/\\/g, "/");
+		if (options.project !== void 0 && options.project !== name) continue;
+		const host = createNodeHost(spec.root, {
+			cacheDir: options.cache === false ? false : void 0,
+			logger: options.logger
+		});
+		const projectHost = options.wrapHost?.(host) ?? host;
+		const setup = await resolveConfig({
+			host: projectHost,
+			config: spec.config,
+			parent: spec.parent,
+			builtins,
+			name,
+			runtime: "node",
+			loadPlugin: createPluginLoader(spec.configFile ? dirname(spec.configFile) : spec.root),
+			manifestRoots: await manifestRootsOf(spec.root, gitRoot)
+		});
+		const project = createProject({
+			host: projectHost,
+			setup
+		});
+		await project.ready;
+		await host.flush();
+		loaded.push({
+			name,
+			root: spec.root,
+			configFile: spec.configFile,
+			host,
+			project
+		});
+	}
+	if (options.project !== void 0 && loaded.length === 0) throw new X18nError("X18N0003", options.project);
+	return {
+		root,
+		configFile,
+		projects: loaded
 	};
 }
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@x18n/node",
   "type": "module",
-  "version": "0.0.0",
+  "version": "0.0.3",
   "description": "Node.js host for x18n: file system access, config and plugin loading",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -25,8 +25,8 @@
     "node": ">=22"
   },
   "dependencies": {
-    "@x18n/builtins": "0.0.0",
-    "@x18n/core": "0.0.0",
+    "@x18n/builtins": "0.0.3",
+    "@x18n/core": "0.0.3",
     "chokidar": "^5.0.0",
     "ignore": "^7.0.12",
     "jiti": "^2.6.1",