@x18n/core 0.1.4 → 0.1.5

package/dist/index.d.mts

@@ -1340,6 +1340,13 @@ interface PromptOptions {
   readonly context?: boolean | undefined;
   /** Translate prompts: add stale translations (load history first). */
   readonly stale?: boolean | undefined;
+  /** Translate prompts: add translations that checks report in the target locale, all of them (`true`) or of these check ids. */
+  readonly check?: boolean | readonly string[] | undefined;
+}
+interface PromptIssue {
+  /** Check id, for example `identical-to-source`. */
+  readonly code: string;
+  readonly message: string;
 }
 interface UsageContext {
   readonly path: string;
@@ -1354,6 +1361,8 @@ interface PromptItem {
   readonly existing: string | undefined;
   /** For a stale translation: the source value when the translation last changed, when known. */
   readonly previousSource?: string | undefined;
+  /** With `check`: what the checks report for the current value. */
+  readonly issues?: readonly PromptIssue[] | undefined;
   readonly context: readonly UsageContext[];
 }
 interface PromptData {
@@ -1780,4 +1789,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, BaselineSummary, 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, FormatEntry, GlobOptions, GlossaryEntry, HardString, HistoryConfigs, HistoryContext, HistoryOptions, HistoryProvider, HistorySettings, Host, JsonObject, JsonPrimitive, JsonValue, KeyContext, KeyId, KeyInfo, KeyQuery, KeyString, KeyTarget, LazyFormat, LazyScanner, LibraryOptions, LineIndex, LinePosition, LocaleCode, LocaleCoverage, LocaleFinder, LocaleInfo, Location, Logger, ManifestReader, MemoryHost, Message, MessageChange, MessageHistory, MessageLeaf, MessageOp, MessageTree, NamespaceFromPath, NamespaceOptions, NodeRange, OverlayHost, ParamsSource, ParseResult, Placeholder, PlaceholderComparer, PlaceholderProblem, PlaceholderSyntax, Plan, Plugin, PluginConfigs, PluginFile, PluginLoader, PluginOption, PluginRegistry, PluginSpecifier, PluralForm, Preset, PresetDetection, PresetEntry, PresetExplanation, PresetFactory, PresetLoader, PresetOption, Project, ProjectChange, ProjectExplanation, PromptContext, PromptData, PromptDraft, PromptItem, PromptOptions, RegexScannerSpec, ReportInput, ReportSummary, Reporter, ReporterContext, ReporterLoader, ResolveConfigOptions, ResolvedConfig, Resource, ResourceBlock, ResourceCandidate, ResourceId, ResourceNode, ResourceSpec, ResourceTransform, ResourceTransformContext, ReviewAuthor, ReviewComment, ReviewData, ReviewFile, ReviewFilter, ReviewOptions, ReviewState, ReviewStore, ReviewThread, ReviewType, ScanContext, ScanResult, Scanner, ScannerEntry, SchemaIssue, Scope, SearchMatch, SearchOptions, SerializableConfig, Setup, Severity, SourceFile, TextEdit, TextRange, ThreadComment, TreeLeaf, Usage, UsageCandidate, UsageContext, UsageKind, UsageMatch, UsageOptions, UsageQuery, UserConfig, WireDiagnostic, WireRange, WriteOptions, X18nError };
+export type { Analysis, Answers, ApplyResult, ArgSource, BaselineSummary, 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, FormatEntry, GlobOptions, GlossaryEntry, HardString, HistoryConfigs, HistoryContext, HistoryOptions, HistoryProvider, HistorySettings, Host, JsonObject, JsonPrimitive, JsonValue, KeyContext, KeyId, KeyInfo, KeyQuery, KeyString, KeyTarget, LazyFormat, LazyScanner, LibraryOptions, LineIndex, LinePosition, LocaleCode, LocaleCoverage, LocaleFinder, LocaleInfo, Location, Logger, ManifestReader, MemoryHost, Message, MessageChange, MessageHistory, MessageLeaf, MessageOp, MessageTree, NamespaceFromPath, NamespaceOptions, NodeRange, OverlayHost, ParamsSource, ParseResult, Placeholder, PlaceholderComparer, PlaceholderProblem, PlaceholderSyntax, Plan, Plugin, PluginConfigs, PluginFile, PluginLoader, PluginOption, PluginRegistry, PluginSpecifier, PluralForm, Preset, PresetDetection, PresetEntry, PresetExplanation, PresetFactory, PresetLoader, PresetOption, Project, ProjectChange, ProjectExplanation, PromptContext, PromptData, PromptDraft, PromptIssue, PromptItem, PromptOptions, RegexScannerSpec, ReportInput, ReportSummary, Reporter, ReporterContext, ReporterLoader, ResolveConfigOptions, ResolvedConfig, Resource, ResourceBlock, ResourceCandidate, ResourceId, ResourceNode, ResourceSpec, ResourceTransform, ResourceTransformContext, ReviewAuthor, ReviewComment, ReviewData, ReviewFile, ReviewFilter, ReviewOptions, ReviewState, ReviewStore, ReviewThread, ReviewType, ScanContext, ScanResult, Scanner, ScannerEntry, SchemaIssue, Scope, SearchMatch, SearchOptions, SerializableConfig, Setup, Severity, SourceFile, TextEdit, TextRange, ThreadComment, TreeLeaf, Usage, UsageCandidate, UsageContext, UsageKind, UsageMatch, UsageOptions, UsageQuery, UserConfig, WireDiagnostic, WireRange, WriteOptions, X18nError };

package/dist/index.mjs

@@ -2438,13 +2438,28 @@ function contextOf(project, key) {
 		}];
 	});
 }
+/** The diagnostics of checks (all, or these ids) on values the locale has, by key. */
+function reportedValues(project, diagnostics, to, check) {
+	const codes = check === true ? void 0 : new Set(check);
+	const reported = /* @__PURE__ */ new Map();
+	for (const diagnostic of diagnostics) {
+		if (diagnostic.key === void 0 || diagnostic.locale !== to || codes && !codes.has(diagnostic.code)) continue;
+		if (!text(project.message(diagnostic.key, to)?.value)) continue;
+		const found = reported.get(diagnostic.key) ?? [];
+		reported.set(diagnostic.key, found);
+		found.push(diagnostic);
+	}
+	return reported;
+}
 /** Builds the parts of a translate or review prompt from project state. */
 function buildPrompt(project, kind, to, options, extra) {
 	const from = project.sourceLocale;
 	const match = typeof options.keys === "string" ? keyMatcher([options.keys]) : void 0;
 	const list = Array.isArray(options.keys) ? new Set(options.keys) : void 0;
-	const outdated = new Set(project.analyze().coverage.find((c) => c.locale === to)?.outdated);
+	const analysis = project.analyze();
+	const outdated = new Set(analysis.coverage.find((c) => c.locale === to)?.outdated);
 	const stale = (key) => outdated.has(key);
+	const reported = kind === "translate" && options.check ? reportedValues(project, analysis.diagnostics, to, options.check) : /* @__PURE__ */ new Map();
 	const candidates = project.keys({ namespace: options.namespace }).filter((key) => {
 		if (match && !match(key)) return false;
 		if (list && !list.has(key)) return false;
@@ -2452,7 +2467,7 @@ function buildPrompt(project, kind, to, options, extra) {
 		if (source === void 0 || source === "") return false;
 		const target = text(project.message(key, to)?.value);
 		if (kind === "review") return target !== void 0 && target !== "";
-		return list !== void 0 || target === void 0 || target === "" || options.stale === true && stale(key);
+		return list !== void 0 || target === void 0 || target === "" || options.stale === true && stale(key) || reported.has(key);
 	});
 	const start = Number(options.cursor ?? 0) || 0;
 	const limit = options.limit ?? 50;
@@ -2466,6 +2481,7 @@ function buildPrompt(project, kind, to, options, extra) {
 	};
 	if (syntaxes.length > 0) draft.rules.push(`Keep every placeholder exactly as written (${syntaxes.map((s) => `\`${s.example ?? s.id}\``).join(", ")}); do not translate their names.`);
 	draft.rules.push("Keep markup tags and their attributes as they are.", "Match the tone and wording of the existing messages in the target locale.", "Do not translate glossary terms marked \"do not translate\".");
+	if (reported.size > 0) draft.rules.push(`A message with a reported problem has a current ${to} value: fix the problem. When the current value is right as it is, such as a word that is the same in both languages, leave the key out of the results.`);
 	if (info.pluralCategories.length > 1) draft.notes.push(`${to} uses the plural categories ${info.pluralCategories.join(", ")}.`);
 	for (const hook of extra.hooks) hook(draft, {
 		sourceLocale: from,
@@ -2475,7 +2491,7 @@ function buildPrompt(project, kind, to, options, extra) {
 	const examples = kind === "translate" ? project.keys().flatMap((key) => {
 		const source = text(project.message(key, from)?.value);
 		const target = text(project.message(key, to)?.value);
-		return source && target && !candidates.includes(key) ? [{
+		return source && target && target !== source && !candidates.includes(key) ? [{
 			key,
 			source,
 			target
@@ -2491,6 +2507,10 @@ function buildPrompt(project, kind, to, options, extra) {
 			placeholders: [...new Set(syntaxes.flatMap((s) => s.find(source)).map((p) => p.text))],
 			existing: text(project.message(key, to)?.value) || void 0,
 			previousSource: previous === source ? void 0 : previous,
+			issues: reported.get(key)?.map((d) => ({
+				code: d.code,
+				message: d.message
+			})),
 			context: options.context === false ? [] : contextOf(project, key)
 		};
 	});
@@ -2535,6 +2555,7 @@ function renderItem(item, to) {
 	if (item.placeholders.length) out.push(`- Placeholders: ${item.placeholders.map((p) => `\`${p}\``).join(", ")}`);
 	if (item.previousSource !== void 0) out.push(`- Source when ${to} last changed: ${JSON.stringify(item.previousSource)}`);
 	if (item.existing !== void 0) out.push(`- Current ${to}: ${JSON.stringify(item.existing)}`);
+	for (const issue of item.issues ?? []) out.push(`- Reported: ${issue.message} (\`${issue.code}\`)`);
 	for (const context of item.context) out.push(`- Used in \`${context.path}:${context.line}\`:`, "", "  ```", ...context.snippet.split("\n").map((line) => `  ${line}`), "  ```");
 	out.push("");
 	return out;

package/package.json

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