@x18n/core 0.0.0 → 0.0.3

package/dist/index.d.mts

@@ -426,6 +426,7 @@ interface CheckContext {
   /** Usages whose key is not defined in the source locale. */
   readonly undefinedUsages: () => readonly Usage[];
   readonly placeholders: (value: string) => readonly Placeholder[];
+  readonly placeholderSyntaxes: readonly PlaceholderSyntax[];
   /** Errors reported by the `validate` of every placeholder syntax. */
   readonly syntaxErrors: (value: string) => readonly string[];
   readonly localeInfo: (code: LocaleCode) => LocaleInfo;
@@ -475,6 +476,8 @@ interface PlaceholderSyntax {
   readonly example?: string | undefined;
   /** The placeholder name is another key (vue-i18n `@:key`, i18next `$t(key)`), which then counts as used. */
   readonly reference?: boolean | undefined;
+  /** Names the library always passes, which a translation may leave out or add (vue-i18n `n` and `count`). */
+  readonly implicit?: readonly string[] | undefined;
 }
 interface KeyContext {
   readonly path: string;
@@ -645,7 +648,10 @@ interface NamespaceOptions {
   readonly separator?: string | undefined;
   /** Namespace of keys written without one. */
   readonly default?: string | undefined;
+  /** How `{namespaces}` folders name a namespace: `dot` makes `pages/home` into `pages.home`, `slash` keeps `pages/home`, `camel` makes `todos-page` into `todosPage`. Default `dot`. */
+  readonly fromPath?: "dot" | "slash" | "camel" | undefined;
 }
+type NamespaceFromPath = NonNullable<NamespaceOptions["fromPath"]>;
 type PluginSpecifier = string | readonly [string, JsonObject];
 /** The part of the config that YAML and JSON files can hold. Validated by `ConfigSchema`. */
 interface SerializableConfig {
@@ -713,6 +719,7 @@ interface ResolvedConfig {
   readonly namespace: {
     readonly separator: string;
     readonly default: string | undefined;
+    readonly fromPath: NamespaceFromPath;
   };
   readonly usage: {
     readonly include: readonly string[];
@@ -1093,6 +1100,8 @@ interface Project {
   readonly keys: (query?: KeyQuery) => KeyString[];
   readonly get: (key: KeyString) => KeyInfo | undefined;
   readonly message: (key: KeyString, locale: LocaleCode) => Message | undefined;
+  /** The message a usage of `key` shows: the key's own, or one of its derived keys (`item` → `item_other`). */
+  readonly lookup: (key: KeyString, locale: LocaleCode) => Message | undefined;
   /** Parses user input such as `common:save` or `save` into a key string. */
   readonly parseKey: (input: string) => KeyString;
   readonly usages: (query?: UsageQuery) => UsageMatch[];
@@ -1137,6 +1146,15 @@ interface PlaceholderProblem {
 /** Parses the batch shape `{ "<locale>": { "<key>": "<value>" } }` (as in `x18n apply`) into set ops. */
 export declare function parseMessageBatch(project: Project, data: JsonValue): EditOp[];
 /** Set ops whose value drops or adds placeholders compared to the source value. */
+type PlaceholderComparer = (source: string, target: string) => {
+  readonly missing: string[];
+  readonly extra: string[];
+};
+/**
+ * Compares the placeholders of a target value with its source. Key references (`@:key`) are not
+ * parameters, and implicit names (vue-i18n `{n}` in plural messages) may be left out. Build it once per run.
+ */
+export declare function createPlaceholderComparer(syntaxes: readonly PlaceholderSyntax[], find?: (value: string) => readonly Placeholder[]): PlaceholderComparer;
 export declare function placeholderProblems(project: Project, ops: readonly EditOp[]): PlaceholderProblem[];
 //#endregion
 //#region src/project/project.d.ts
@@ -1166,10 +1184,7 @@ interface PluginFile {
     readonly sourceLocale?: string | undefined;
     readonly locales?: readonly string[] | undefined;
     readonly resources?: readonly ResourceSpec[] | undefined;
-    readonly namespace?: {
-      readonly separator?: string | undefined;
-      readonly default?: string | undefined;
-    } | undefined;
+    readonly namespace?: NamespaceOptions | undefined;
     readonly keyStyle?: "auto" | "nested" | "flat" | undefined;
   } | undefined;
   readonly scanners?: {
@@ -1237,4 +1252,4 @@ export declare function rangeContains(range: TextRange, offset: number): boolean
 /** Fast non-cryptographic string hash (cyrb53), as hex. */
 export declare function hashText(text: string): string;
 //#endregion
-export type { Analysis, Answers, ApplyResult, ArgSource, Builtins, CacheStore, CallSpec, CapabilityConflict, Check, CheckContext, CheckIds, CheckLevel, CheckSetting, ConfigContext, ConfigDraft, ConfigOrigin, CreateProjectOptions, Decision, DecisionOption, DetectContext, Diagnostic, DiagnosticInput, Disposable, EditOp, Envelope, ErrorCode, ErrorInfo, ExtractItem, ExtractOptions, ExtractTemplate, Extractor, FileChange, FileEvent, FileScan, FinderContext, Fix, Format, FormatContext, GlobOptions, GlossaryEntry, HardString, Host, JsonObject, JsonPrimitive, JsonValue, KeyContext, KeyId, KeyInfo, KeyQuery, KeyString, KeyTarget, LineIndex, LinePosition, LocaleCode, LocaleCoverage, LocaleFinder, LocaleInfo, Location, Logger, ManifestReader, MemoryHost, Message, MessageLeaf, MessageOp, MessageTree, NamespaceOptions, NodeRange, OverlayHost, ParseResult, Placeholder, PlaceholderProblem, PlaceholderSyntax, Plan, Plugin, PluginConfigs, PluginFile, PluginOption, PluginRegistry, PluginSpecifier, Preset, PresetExplanation, PresetFactory, PresetOption, Project, ProjectChange, ProjectExplanation, PromptContext, PromptData, PromptDraft, PromptItem, PromptOptions, RegexScannerSpec, ReportInput, ReportSummary, Reporter, ReporterContext, ResolveConfigOptions, ResolvedConfig, Resource, ResourceBlock, ResourceCandidate, ResourceId, ResourceNode, ResourceSpec, ResourceTransform, ResourceTransformContext, ScanContext, ScanResult, Scanner, SchemaIssue, Scope, SerializableConfig, Setup, Severity, SourceFile, TextEdit, TextRange, TreeLeaf, Usage, UsageCandidate, UsageContext, UsageKind, UsageMatch, UsageOptions, UsageQuery, UserConfig, WireDiagnostic, WireRange, WriteOptions };
+export type { Analysis, Answers, ApplyResult, ArgSource, Builtins, CacheStore, CallSpec, CapabilityConflict, Check, CheckContext, CheckIds, CheckLevel, CheckSetting, ConfigContext, ConfigDraft, ConfigOrigin, CreateProjectOptions, Decision, DecisionOption, DetectContext, Diagnostic, DiagnosticInput, Disposable, EditOp, Envelope, ErrorCode, ErrorInfo, ExtractItem, ExtractOptions, ExtractTemplate, Extractor, FileChange, FileEvent, FileScan, FinderContext, Fix, Format, FormatContext, GlobOptions, GlossaryEntry, HardString, Host, JsonObject, JsonPrimitive, JsonValue, KeyContext, KeyId, KeyInfo, KeyQuery, KeyString, KeyTarget, LineIndex, LinePosition, LocaleCode, LocaleCoverage, LocaleFinder, LocaleInfo, Location, Logger, ManifestReader, MemoryHost, Message, MessageLeaf, MessageOp, MessageTree, NamespaceFromPath, NamespaceOptions, NodeRange, OverlayHost, ParseResult, Placeholder, PlaceholderComparer, PlaceholderProblem, PlaceholderSyntax, Plan, Plugin, PluginConfigs, PluginFile, PluginOption, PluginRegistry, PluginSpecifier, Preset, PresetExplanation, PresetFactory, PresetOption, Project, ProjectChange, ProjectExplanation, PromptContext, PromptData, PromptDraft, PromptItem, PromptOptions, RegexScannerSpec, ReportInput, ReportSummary, Reporter, ReporterContext, ResolveConfigOptions, ResolvedConfig, Resource, ResourceBlock, ResourceCandidate, ResourceId, ResourceNode, ResourceSpec, ResourceTransform, ResourceTransformContext, ScanContext, ScanResult, Scanner, SchemaIssue, Scope, SerializableConfig, Setup, Severity, SourceFile, TextEdit, TextRange, TreeLeaf, Usage, UsageCandidate, UsageContext, UsageKind, UsageMatch, UsageOptions, UsageQuery, UserConfig, WireDiagnostic, WireRange, WriteOptions };

package/dist/index.mjs

@@ -690,7 +690,12 @@ const glossaryEntry = v.strictObject({
 const checkSetting = v.union([level, v.tuple([level, jsonObject])]);
 const namespaceOptions = v.strictObject({
 	separator: v.optional(v.string()),
-	default: v.optional(v.string())
+	default: v.optional(v.string()),
+	fromPath: v.optional(v.picklist([
+		"dot",
+		"slash",
+		"camel"
+	]))
 });
 /** Validates YAML and JSON configs, and the serializable part of TS configs. */
 const ConfigSchema = v.strictObject({
@@ -808,17 +813,38 @@ function parseMessageBatch(project, data) {
 	}
 	return ops;
 }
-/** Set ops whose value drops or adds placeholders compared to the source value. */
+/**
+* Compares the placeholders of a target value with its source. Key references (`@:key`) are not
+* parameters, and implicit names (vue-i18n `{n}` in plural messages) may be left out. Build it once per run.
+*/
+function createPlaceholderComparer(syntaxes, find = (value) => syntaxes.flatMap((s) => s.find(value))) {
+	const references = new Set(syntaxes.filter((s) => s.reference).map((s) => s.id));
+	const implicit = new Set(syntaxes.flatMap((s) => s.implicit ?? []));
+	const seen = /* @__PURE__ */ new Map();
+	const names = (text) => {
+		let found = seen.get(text);
+		if (!found) {
+			found = new Set(find(text).filter((p) => !references.has(p.syntax) && !implicit.has(p.name)).map((p) => p.name));
+			seen.set(text, found);
+		}
+		return found;
+	};
+	return (source, target) => {
+		const expected = names(source);
+		const actual = names(target);
+		return {
+			missing: [...expected].filter((name) => !actual.has(name)).sort(),
+			extra: [...actual].filter((name) => !expected.has(name)).sort()
+		};
+	};
+}
 function placeholderProblems(project, ops) {
-	const names = (text) => project.placeholderSyntaxes.flatMap((s) => s.find(text)).map((ph) => ph.name).sort();
+	const compare = createPlaceholderComparer(project.placeholderSyntaxes);
 	return ops.flatMap((op) => {
 		if (op.type !== "set" || op.locale === project.sourceLocale || typeof op.value !== "string") return [];
 		const source = project.message(op.key, project.sourceLocale)?.value;
 		if (typeof source !== "string") return [];
-		const expected = names(source);
-		const actual = names(op.value);
-		const missing = expected.filter((n) => !actual.includes(n));
-		const extra = actual.filter((n) => !expected.includes(n));
+		const { missing, extra } = compare(source, op.value);
 		return missing.length || extra.length ? [{
 			key: op.key,
 			locale: op.locale,
@@ -991,6 +1017,7 @@ function createAnalyzer(options) {
 			unused: () => unused,
 			undefinedUsages: () => undefinedUsages,
 			placeholders,
+			placeholderSyntaxes: registry.placeholders,
 			syntaxErrors: (value) => registry.placeholders.flatMap((syntax) => syntax.validate?.(value) ?? []),
 			localeInfo: options.localeInfo,
 			text: options.text,
@@ -1151,9 +1178,12 @@ var PlanBuilder = class {
 	createTarget(key, locale) {
 		const { resources, sourceLocale, namespaced } = this.state;
 		const fits = (s) => this.relativePath(key, s.resource) !== void 0;
-		const namespace = namespaced ? this.keyId(key).namespace ?? this.config.namespace.default : void 0;
+		const source = this.options.message(key, sourceLocale);
+		const sourceState = source && this.stateById.get(source.resource);
+		const namespace = namespaced ? this.keyId(key).namespace ?? this.config.namespace.default : sourceState?.resource.namespace;
+		const exists = (path) => resources.some((r) => r.resource.path === path);
 		const resolved = this.options.resolveNew(locale, namespace);
-		if (resolved) {
+		if (resolved && !exists(resolved)) {
 			const format = this.options.registry.formatFor(resolved);
 			if (format?.serialize) {
 				const target = {
@@ -1168,15 +1198,17 @@ var PlanBuilder = class {
 				return target;
 			}
 		}
-		const model = resources.find((s) => s.resource.locale === sourceLocale && fits(s)) ?? resources.find(fits);
+		const sibling = (r) => r.resource.locale === locale && r.resource.namespace !== void 0 && namespace !== void 0;
+		const model = (sourceState && fits(sourceState) ? sourceState : void 0) ?? resources.find((s) => s.resource.locale === sourceLocale && fits(s)) ?? resources.find(fits) ?? resources.find(sibling);
 		const format = model && this.options.registry.formatById(model.resource.format);
-		const path = model && mirrorPath(model.resource.path, model.resource.locale, locale);
-		if (!model || !format?.serialize || model.resource.block || !path || path === model.resource.path) throw new X18nError("X18N4005", `${key} in ${locale}`);
+		let path = model && mirrorPath(model.resource.path, model.resource.locale, locale);
+		if (model && path && namespace !== void 0 && model.resource.namespace !== void 0 && model.resource.namespace !== namespace) path = mirrorPath(path, model.resource.namespace, namespace);
+		if (!model || !format?.serialize || model.resource.block || !path || exists(path)) throw new X18nError("X18N4005", `${key} in ${locale}`);
 		const target = {
 			id: path,
 			path,
 			locale,
-			namespace: model.resource.namespace ?? namespace,
+			namespace: namespace ?? model.resource.namespace,
 			format,
 			state: void 0
 		};
@@ -1185,7 +1217,10 @@ var PlanBuilder = class {
 	}
 	/** Placement: the namespace's resource, then the longest shared prefix, then the first; a tie is a decision. */
 	pickTarget(key, locale) {
-		const inLocale = this.state.resources.filter((s) => s.resource.locale === locale && this.relativePath(key, s.resource) !== void 0);
+		let inLocale = this.state.resources.filter((s) => s.resource.locale === locale && this.relativePath(key, s.resource) !== void 0);
+		const source = this.options.message(key, this.state.sourceLocale);
+		const sourceNamespace = source && this.stateById.get(source.resource)?.resource.namespace;
+		if (sourceNamespace !== void 0 && !this.state.namespaced) inLocale = inLocale.filter((s) => s.resource.namespace === sourceNamespace);
 		if (inLocale.length === 0) return [...this.created.values()].find((t) => t.locale === locale && this.relativePath(key, t) !== void 0) ?? this.createTarget(key, locale);
 		if (inLocale.length === 1) return this.targetOf(inLocale[0]);
 		const path = this.keyId(key).path;
@@ -1253,11 +1288,50 @@ var PlanBuilder = class {
 		});
 	}
 	/** Renames a key in every locale, in place when only the last segment changes. */
-	moveKey(from, to) {
+	/**
+	* Renames a parent object in place where only its last segment changes, so the subtree keeps its
+	* position and layout. Returns the resources it handled.
+	*/
+	renameNode(from, to) {
+		const handled = /* @__PURE__ */ new Set();
+		for (const s of this.state.resources) {
+			const relativeFrom = this.relativePath(from, s.resource);
+			const relativeTo = this.relativePath(to, s.resource);
+			if (!relativeFrom || !relativeTo || s.resource.readonly || !this.options.registry.formatById(s.resource.format)?.edit) continue;
+			const stored = s.toStored(relativeFrom);
+			const next = s.toStored(relativeTo);
+			const node = nodeAt(s.rawTree, stored);
+			const range = s.ranges.get(pathId(stored));
+			const last = next.at(-1);
+			const sameParent = next.length === stored.length && next.slice(0, -1).every((segment, i) => segment === stored[i]);
+			if (node === void 0 || isMessageLeaf(node) || !range || !sameParent || !safeSegment.test(last)) continue;
+			const entry = this.workFor(this.targetOf(s));
+			entry.keyRenames.push({
+				range: {
+					start: range.key.start + s.offset,
+					end: range.key.end + s.offset
+				},
+				text: last
+			});
+			const leaves = [...walkLeaves(node, stored)];
+			entry.tree = applyMessageOps(entry.tree, [...leaves.map((leaf) => ({
+				type: "delete",
+				path: leaf.path
+			})), ...leaves.map((leaf) => ({
+				type: "set",
+				path: [...next, ...leaf.path.slice(stored.length)],
+				value: leaf.value
+			}))]);
+			handled.add(s.resource.id);
+		}
+		return handled;
+	}
+	moveKey(from, to, renamed = /* @__PURE__ */ new Set()) {
 		this.touched.add(from);
 		this.touched.add(to);
 		for (const [locale, list] of this.options.messages(from) ?? []) {
 			const m = list[0];
+			if (renamed.has(m.resource)) continue;
 			const s = this.writable(m.resource);
 			const relative = this.relativePath(to, s.resource);
 			if (!relative) {
@@ -1295,6 +1369,10 @@ var PlanBuilder = class {
 	}
 	/** The raw text a usage needs to refer to `next`, given its scope. */
 	rawFor(usage, next) {
+		if (usage.raw.startsWith(".") && usage.key?.endsWith(usage.raw)) {
+			const scope = usage.key.slice(0, usage.key.length - usage.raw.length);
+			if (next.startsWith(`${scope}.`)) return next.slice(scope.length);
+		}
 		const { namespace, path } = this.keyId(next);
 		let rest = path.join(".");
 		const separator = this.config.namespace.separator;
@@ -1355,8 +1433,9 @@ var PlanBuilder = class {
 		if (keys.length === 0) throw new X18nError("X18N4006", op.from);
 		const pairs = keys.map((key) => [key, replaceKeyPrefix(key, op.from, op.to)]);
 		for (const [, to] of pairs) this.conflictCheck(to);
+		const renamed = keys.includes(op.from) ? /* @__PURE__ */ new Set() : this.renameNode(op.from, op.to);
 		for (const [from, to] of pairs) {
-			this.moveKey(from, to);
+			this.moveKey(from, to, renamed);
 			if (op.usages !== false) this.rewriteUsages(from, to);
 		}
 		if (op.usages === false) return;
@@ -1452,6 +1531,11 @@ var PlanBuilder = class {
 				path: newPath,
 				value
 			});
+			else if (value !== void 0) renameOps.push(...[...walkLeaves(value, newPath)].map((leaf) => ({
+				type: "set",
+				path: leaf.path,
+				value: leaf.value
+			})));
 		}
 		return applyTextEdits(s.content, edit(s.content, [...renameOps, ...entry.ops], ctx));
 	}
@@ -2185,7 +2269,7 @@ function createProject(options) {
 	function buildIndex() {
 		resourceIndex ??= buildResourceIndex();
 		const usages = [];
-		for (const [path, state] of files) {
+		for (const [path, state] of [...files].sort(([a], [b]) => a < b ? -1 : a > b ? 1 : 0)) {
 			let list = resolved.get(state);
 			if (!list) {
 				list = state.result.usages.map((candidate) => resolver.resolve(candidate, state.result.scopes ?? [], path, "scanner"));
@@ -2501,10 +2585,23 @@ function createProject(options) {
 		nodes: (path) => idx().nodes.get(path) ?? [],
 		locations(key) {
 			const order = new Map(locales.map((locale, i) => [locale, i]));
-			return [...idx().nodes.values()].flat().filter((node) => node.key === key).sort((a, b) => (order.get(a.locale) ?? 0) - (order.get(b.locale) ?? 0));
+			const all = [...idx().nodes.values()].flat();
+			let found = all.filter((node) => node.key === key);
+			if (found.length === 0) {
+				const derived = new Set(idx().derived.get(key) ?? []);
+				found = all.filter((node) => derived.has(node.key));
+			}
+			return found.sort((a, b) => (order.get(a.locale) ?? 0) - (order.get(b.locale) ?? 0));
+		},
+		lookup(key, locale) {
+			const exact = message(key, locale);
+			if (exact) return exact;
+			const derived = [...idx().derived.get(key) ?? []].sort();
+			const other = derived.find((k) => /[._-]other$/.test(k)) ?? derived[0];
+			return other === void 0 ? void 0 : message(other, locale);
 		},
 		keySlots: (path) => files.get(path)?.result.keySlots ?? [],
-		hardStrings: (path) => [...files].filter(([p]) => path === void 0 || p === path).flatMap(([p, state]) => (state.result.hardStrings ?? []).map((h) => ({
+		hardStrings: (path) => [...files].sort(([a], [b]) => a < b ? -1 : a > b ? 1 : 0).filter(([p]) => path === void 0 || p === path).flatMap(([p, state]) => (state.result.hardStrings ?? []).map((h) => ({
 			...h,
 			path: p
 		}))),
@@ -2562,7 +2659,8 @@ function defaultDraft() {
 		keyStyle: "auto",
 		namespace: {
 			separator: ".",
-			default: void 0
+			default: void 0,
+			fromPath: "dot"
 		},
 		usage: {
 			include: ["**/*"],
@@ -2625,7 +2723,8 @@ function applyLayer(draft, layer, origin, origins) {
 	if (layer.namespace !== void 0) {
 		draft.namespace = {
 			separator: layer.namespace.separator ?? draft.namespace.separator,
-			default: layer.namespace.default ?? draft.namespace.default
+			default: layer.namespace.default ?? draft.namespace.default,
+			fromPath: layer.namespace.fromPath ?? draft.namespace.fromPath
 		};
 		mark("namespace");
 	}
@@ -2821,4 +2920,4 @@ async function resolveConfig(options) {
 	};
 }
 //#endregion
-export { ConfigSchema, PluginFileSchema, X18nError, applyMessageOps, applyTextEdits, buildTree, contractVersion, createLineIndex, createMemoryHost, createOverlayHost, createProject, createRegistry, defineConfig, definePlugin, definePreset, diffText, envelope, errorCodes, extensionOf, globToRegExp, hashText, isJsonObject, isKeyUnder, isMessageLeaf, isMessageTree, isPreset, isX18nError, joinKey, keyMatcher, localeSpellingKey, parseLocaleInfo, parseMessageBatch, pathId, pathMatcher, placeholderProblems, rangeContains, renderPrompt, replaceKeyPrefix, resolveConfig, sortTree, splitKey, toWireDiagnostic, toWireRange, validate, walkLeaves };
+export { ConfigSchema, PluginFileSchema, X18nError, applyMessageOps, applyTextEdits, buildTree, contractVersion, createLineIndex, createMemoryHost, createOverlayHost, createPlaceholderComparer, createProject, createRegistry, defineConfig, definePlugin, definePreset, diffText, envelope, errorCodes, extensionOf, globToRegExp, hashText, isJsonObject, isKeyUnder, isMessageLeaf, isMessageTree, isPreset, isX18nError, joinKey, keyMatcher, localeSpellingKey, parseLocaleInfo, parseMessageBatch, pathId, pathMatcher, placeholderProblems, rangeContains, renderPrompt, replaceKeyPrefix, resolveConfig, sortTree, splitKey, toWireDiagnostic, toWireRange, validate, walkLeaves };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@x18n/core",
   "type": "module",
-  "version": "0.0.0",
+  "version": "0.0.3",
   "description": "Runtime-neutral engine of x18n: domain model, plugin API and project analysis",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",

package/schema/config.json

@@ -128,6 +128,14 @@
         },
         "default": {
           "type": "string"
+        },
+        "fromPath": {
+          "enum": [
+            "dot",
+            "slash",
+            "camel"
+          ],
+          "type": "string"
         }
       },
       "required": [],

package/schema/plugin.json

@@ -89,6 +89,14 @@
             },
             "default": {
               "type": "string"
+            },
+            "fromPath": {
+              "enum": [
+                "dot",
+                "slash",
+                "camel"
+              ],
+              "type": "string"
             }
           },
           "required": [],