@dialexjs/cli 0.5.2 → 0.7.0

package/dist/{project-BJYmnKiU.mjs → project-DBVeKLa3.mjs}

@@ -1,14 +1,15 @@
 import fs from "node:fs";
 import path from "node:path";
-import { renderDts, resolveDialexConfig } from "dialexjs/scanner";
-import fg from "fast-glob";
 import pc from "picocolors";
 import { pathToFileURL } from "node:url";
 import { generateCode, parseExpression, parseModule, writeFile } from "magicast";
+import fg from "fast-glob";
+import ignore from "ignore";
 import { argumentSignature, findPlurals, getArguments, isIcuStructured, parseMessage } from "dialexjs/icu";
 import { createHash } from "node:crypto";
-import chokidar from "chokidar";
 import { DEFAULT_CONFIG } from "dialexjs";
+import { loadConfigSync } from "unconfig";
+import chokidar from "chokidar";
 //#region src/utils/dictionary-edit.ts
 const TODO_PREFIX = "[TODO] ";
 const IDENTIFIER$1 = /^[A-Za-z_$][\w$]*$/;
@@ -272,6 +273,100 @@ function getLeafSource(df, locale, path) {
 	return generateCode(prop.type === "ObjectMethod" ? prop : prop.value).code;
 }
 //#endregion
+//#region src/utils/files.ts
+/** Folders that never hold project dictionaries or sources, in every scanner. */
+const BUILTIN_IGNORE = [
+	"**/node_modules/**",
+	"**/dist/**",
+	"**/.next/**",
+	"**/dialex.locales/**"
+];
+/** What the source scan skips on top: other tools' output, declarations, generated and config files. */
+const SOURCE_BUILTIN_IGNORE = [
+	...BUILTIN_IGNORE,
+	"**/.nuxt/**",
+	"**/.output/**",
+	"**/.svelte-kit/**",
+	"**/.astro/**",
+	"**/.turbo/**",
+	"**/coverage/**",
+	"**/graphify-out/**",
+	"**/*.d.ts",
+	"**/dialex.generated.*",
+	"**/dialex.config.*",
+	"**/i18n.config.*"
+];
+/** The nearest directory at or above `root` that contains `.git`, or `root` itself. */
+function repositoryRoot(root) {
+	for (let dir = root;; dir = path.dirname(dir)) {
+		if (fs.existsSync(path.join(dir, ".git"))) return dir;
+		if (path.dirname(dir) === dir) return root;
+	}
+}
+function readScope(dir) {
+	try {
+		const text = fs.readFileSync(path.join(dir, ".gitignore"), "utf-8");
+		return {
+			dir,
+			matcher: ignore().add(text)
+		};
+	} catch {
+		return;
+	}
+}
+/**
+* A function that says whether an absolute path is ignored by Git. It reads the `.gitignore`
+* files of the project folder, of every folder above it up to the repository root (monorepo
+* packages inherit the root's rules), and of nested folders.
+*/
+function createGitignoreFilter(root) {
+	const base = path.resolve(root);
+	const top = repositoryRoot(base);
+	const scopes = [];
+	for (let dir = base;; dir = path.dirname(dir)) {
+		const scope = readScope(dir);
+		if (scope) scopes.push(scope);
+		if (dir === top || path.dirname(dir) === dir) break;
+	}
+	const nested = fg.sync("**/.gitignore", {
+		cwd: base,
+		absolute: true,
+		dot: true,
+		ignore: ["**/node_modules/**", "**/.git/**"]
+	});
+	for (const file of nested) {
+		const dir = path.dirname(file);
+		if (dir === base) continue;
+		const scope = readScope(dir);
+		if (scope) scopes.push(scope);
+	}
+	if (scopes.length === 0) return () => false;
+	return (absolutePath) => {
+		for (const { dir, matcher } of scopes) {
+			const relative = path.relative(dir, absolutePath);
+			if (!relative || relative.startsWith("..") || path.isAbsolute(relative)) continue;
+			if (matcher.ignores(relative.split(path.sep).join("/"))) return true;
+		}
+		return false;
+	};
+}
+/** Finds files under `root`, skipping build output, configured excludes and Git-ignored paths. */
+function scanFiles(root, patterns, options = {}) {
+	const builtin = options.kind === "source" ? SOURCE_BUILTIN_IGNORE : BUILTIN_IGNORE;
+	const files = fg.sync(patterns, {
+		cwd: root,
+		absolute: true,
+		ignore: [
+			...builtin,
+			...options.exclude ?? [],
+			...options.ignore ?? []
+		]
+	});
+	if (options.gitignore === false) return files;
+	const ignored = createGitignoreFilter(root);
+	return files.filter((file) => !ignored(file));
+}
+//#endregion
 //#region src/utils/icu-check.ts
 /** CLDR order. `resolvedOptions().pluralCategories` order differs between Node versions. */
 const CATEGORY_ORDER = [
@@ -423,26 +518,7 @@ function lockFor(root, sourceLocale) {
 }
 //#endregion
 //#region src/analysis.ts
-const DICTIONARY_IGNORE$1 = [
-	"**/node_modules/**",
-	"**/dist/**",
-	"**/.next/**",
-	"**/dialex.locales/**"
-];
 const DEFAULT_SOURCE_GLOB = "**/*.{ts,tsx,js,jsx,mjs,cjs,vue,svelte,astro,mdx}";
-const SOURCE_IGNORE = [
-	...DICTIONARY_IGNORE$1,
-	"**/.nuxt/**",
-	"**/.output/**",
-	"**/.svelte-kit/**",
-	"**/.astro/**",
-	"**/coverage/**",
-	"**/graphify-out/**",
-	"**/*.d.ts",
-	"**/dialex.generated.*",
-	"**/dialex.config.*",
-	"**/i18n.config.*"
-];
 /** `getDictionary("x")`, `useDictionary("x")`, `@DialexDictionary("x")` */
 const DICTIONARY_CALL = /\b(?:getDictionary|useDictionary|DialexDictionary)\(\s*(["'`])([^"'`$\n]+)\1/dg;
 /** `t("dictionary.path.to.key")` */
@@ -583,10 +659,9 @@ async function analyzeProject(options) {
 	const configuredLocales = config.locales || [];
 	const defaultLocale = config.defaultLocale || "en";
 	const extraIgnore = options.ignore ?? [];
-	const files = fg.sync(include, {
-		cwd: root,
-		absolute: true,
-		ignore: [...DICTIONARY_IGNORE$1, ...extraIgnore]
+	const files = scanFiles(root, include, {
+		exclude: config.exclude,
+		ignore: extraIgnore
 	});
 	const issues = [];
 	const dictionaries = [];
@@ -699,10 +774,10 @@ async function analyzeProject(options) {
 	const known = new Map(dictionaries.map((d) => [d.name, d]));
 	const dictionaryFiles = new Set(files);
 	const sourceGlobs = options.src ?? ["**/*.{ts,tsx,js,jsx,mjs,cjs,vue,svelte,astro,mdx}"];
-	const sourceFiles = sourceGlobs.length === 0 ? [] : fg.sync(sourceGlobs, {
-		cwd: root,
-		absolute: true,
-		ignore: [...SOURCE_IGNORE, ...extraIgnore]
+	const sourceFiles = sourceGlobs.length === 0 ? [] : scanFiles(root, sourceGlobs, {
+		kind: "source",
+		exclude: config.exclude,
+		ignore: extraIgnore
 	}).filter((f) => !dictionaryFiles.has(f));
 	if (sourceFiles.length > 0) {
 		const tokens = /* @__PURE__ */ new Set();
@@ -795,6 +870,157 @@ const logger = {
 	log: (msg) => console.log(msg)
 };
 //#endregion
+//#region src/utils/scanner.ts
+function resolveDialexConfig(root, inlineConfig = {}) {
+	let loadedConfig = {};
+	try {
+		const sources = [];
+		if (inlineConfig.configFile) sources.push({ files: inlineConfig.configFile });
+		sources.push({
+			files: "dialex.config",
+			extensions: [
+				"ts",
+				"mts",
+				"cts",
+				"js",
+				"mjs",
+				"cjs",
+				"json",
+				""
+			]
+		}, {
+			files: "i18n.config",
+			extensions: [
+				"ts",
+				"mts",
+				"cts",
+				"js",
+				"mjs",
+				"cjs",
+				"json",
+				""
+			]
+		});
+		const result = loadConfigSync({
+			sources,
+			merge: false,
+			defaults: {},
+			cwd: root
+		});
+		if (result && result.config) loadedConfig = result.config;
+	} catch {}
+	return {
+		...DEFAULT_CONFIG,
+		...loadedConfig,
+		...inlineConfig
+	};
+}
+/** Every adapter entry point that has its own `DictionaryRegistry` to augment. */
+const REGISTRY_ADAPTERS = [
+	"react",
+	"server",
+	"hono",
+	"express",
+	"fastify",
+	"koa",
+	"nestjs",
+	"elysia",
+	"sveltekit",
+	"astro",
+	"vue",
+	"web",
+	"h3",
+	"angular"
+];
+/** Dependencies that tell which `dialexjs/*` entry points a project can import. */
+const ADAPTER_DEPENDENCIES = {
+	react: ["react"],
+	"react-dom": ["react"],
+	next: ["react", "server"],
+	hono: ["hono"],
+	express: ["express"],
+	fastify: ["fastify"],
+	koa: ["koa"],
+	"@nestjs/core": ["nestjs"],
+	"@nestjs/common": ["nestjs"],
+	elysia: ["elysia"],
+	"@sveltejs/kit": ["sveltekit"],
+	astro: ["astro"],
+	vue: ["vue"],
+	nuxt: ["vue", "h3"],
+	h3: ["h3"],
+	nitropack: ["h3"],
+	"@angular/core": ["angular"],
+	"react-router": ["web"],
+	"react-router-dom": ["web"],
+	"@remix-run/react": ["web"],
+	"@remix-run/node": ["web"],
+	"@tanstack/react-start": ["web"],
+	"@solidjs/start": ["web"],
+	wrangler: ["web"]
+};
+/**
+* The adapter entry points to augment for a project, read from its `package.json`. Falls back to
+* all of them when nothing is recognised, so types never silently go missing.
+*/
+function detectAdapters(root) {
+	try {
+		const pkg = JSON.parse(fs.readFileSync(path.join(root, "package.json"), "utf-8"));
+		const deps = {
+			...pkg.dependencies,
+			...pkg.devDependencies,
+			...pkg.peerDependencies
+		};
+		const found = /* @__PURE__ */ new Set();
+		for (const name of Object.keys(deps)) for (const adapter of ADAPTER_DEPENDENCIES[name] ?? []) found.add(adapter);
+		if (found.size > 0) return REGISTRY_ADAPTERS.filter((adapter) => found.has(adapter));
+	} catch {}
+	return [...REGISTRY_ADAPTERS];
+}
+/**
+* The `dialex-env.d.ts` a project should have: its path and contents, or `undefined` when there
+* are no dictionary files. Nothing is written.
+*/
+function renderDts(root, files, locales, messageArguments = {}) {
+	if (files.length === 0) return void 0;
+	const dtsDir = fs.existsSync(path.join(root, "src")) ? path.join(root, "src") : root;
+	const imports = [];
+	const records = [];
+	files.forEach((file, index) => {
+		let relPath = path.relative(dtsDir, file).replace(/\\/g, "/");
+		relPath = relPath.replace(/\.ts$/, "");
+		if (!relPath.startsWith(".")) relPath = "./" + relPath;
+		imports.push(`import dict${index} from '${relPath}';`);
+		records.push(`Record<typeof dict${index}['name'], typeof dict${index}['dictionary'][keyof typeof dict${index}['dictionary']]>`);
+	});
+	const localesType = locales && locales.length > 0 ? locales.map((l) => `"${l}"`).join(" | ") : "string";
+	const registry = records.join(",\n    ");
+	const messageEntries = Object.entries(messageArguments).sort(([a], [b]) => a.localeCompare(b)).map(([key, type]) => `    ${JSON.stringify(key)}: ${type};`).join("\n");
+	const adapterBlocks = detectAdapters(root).map((adapter) => `
+declare module 'dialexjs/${adapter}' {
+  export interface DictionaryRegistry extends ${registry} {}
+}
+`).join("");
+	const dtsContent = `/* eslint-disable */
+// @ts-nocheck
+// Generated by dialex
+${imports.join("\n")}
+
+declare module 'dialexjs' {
+  export interface Register {
+    locales: ${localesType};
+  }
+  export interface DictionaryRegistry extends ${records.join(",\n    ")} {}
+  export interface MessageArguments {${messageEntries ? `\n${messageEntries}\n  ` : ""}}
+}
+${adapterBlocks}
+`;
+	return {
+		path: path.join(dtsDir, "dialex-env.d.ts"),
+		content: dtsContent
+	};
+}
+//#endregion
 //#region src/utils/message-arguments.ts
 const IDENTIFIER = /^[A-Za-z_$][\w$]*$/;
 /**
@@ -981,6 +1207,7 @@ const DEFAULT_STATIC_CONFIG = {
 	defaultLocale: "en",
 	locales: [],
 	include: "**/*.content.ts",
+	exclude: [],
 	fallbacks: {},
 	prefixDefault: true,
 	lazy: false
@@ -1028,6 +1255,7 @@ function apply(object, config, notes) {
 	accept("defaultLocale", (v) => typeof v === "string" && v !== "", "a string literal");
 	accept("locales", isStringArray, "an array of string literals");
 	accept("include", (v) => typeof v === "string" || isStringArray(v), "a string or array of strings");
+	accept("exclude", isStringArray, "an array of string literals");
 	accept("fallbacks", (v) => typeof v === "object" && v !== null && Object.values(v).every((list) => isStringArray(list)), "an object of string arrays");
 	accept("prefixDefault", (v) => typeof v === "boolean", "true or false");
 	accept("lazy", (v) => typeof v === "boolean" || v === "locale", "true, false or \"locale\"");
@@ -1059,6 +1287,7 @@ function parseStaticConfig(text, file = "dialex.config.ts") {
 				"defaultLocale",
 				"locales",
 				"include",
+				"exclude",
 				"fallbacks",
 				"prefixDefault",
 				"lazy"
@@ -1157,12 +1386,6 @@ function relativeImportExtension(root) {
 }
 //#endregion
 //#region src/commands/generate.ts
-const DICTIONARY_IGNORE = [
-	"**/node_modules/**",
-	"**/dist/**",
-	"**/.next/**",
-	"**/dialex.locales/**"
-];
 /** The folder, next to `dialex.generated.ts`, that holds the per-locale modules. */
 const LOCALES_DIR = "dialex.locales";
 const safeName = (text) => text.replace(/[^A-Za-z0-9._-]/g, "_");
@@ -1177,12 +1400,7 @@ function renderGenerated(root, options = {}) {
 	const inlineConfig = options.config ? { configFile: options.config } : {};
 	const staticRead = readStaticConfig(root, options.config);
 	const config = options.static ? staticRead.config : resolveDialexConfig(root, inlineConfig);
-	const include = config.include || DEFAULT_CONFIG.include;
-	const found = fg.sync(include, {
-		cwd: root,
-		absolute: true,
-		ignore: DICTIONARY_IGNORE
-	}).sort();
+	const found = scanFiles(root, config.include || DEFAULT_CONFIG.include, { exclude: config.exclude }).sort();
 	const srcDir = fs.existsSync(path.join(root, "src")) ? path.join(root, "src") : root;
 	const outputPath = options.output ? path.resolve(root, options.output) : path.join(srcDir, "dialex.generated.ts");
 	const outputDir = path.dirname(outputPath);
@@ -1372,9 +1590,10 @@ function startGenerateWatcher(root, options, regenerate, delay = 100) {
 			} catch {}
 		}, delay);
 	};
+	const gitIgnored = createGitignoreFilter(root);
 	const watcher = chokidar.watch(root, {
 		ignoreInitial: true,
-		ignored: (file) => WATCH_IGNORED.test(file)
+		ignored: (file) => WATCH_IGNORED.test(file) || gitIgnored(path.resolve(root, file))
 	});
 	watcher.on("all", (event, filePath) => {
 		const file = path.resolve(root, filePath);
@@ -1399,17 +1618,7 @@ function startGenerateWatcher(root, options, regenerate, delay = 100) {
 //#endregion
 //#region src/utils/project.ts
 async function loadDictionaries(root, config) {
-	const include = config.include || "**/*.content.ts";
-	const files = fg.sync(include, {
-		cwd: root,
-		absolute: true,
-		ignore: [
-			"**/node_modules/**",
-			"**/dist/**",
-			"**/.next/**",
-			"**/dialex.locales/**"
-		]
-	});
+	const files = scanFiles(root, config.include || "**/*.content.ts", { exclude: config.exclude });
 	const dictionaries = [];
 	const unsupported = [];
 	for (const file of files) {
@@ -1460,6 +1669,6 @@ async function loadStaticProject(root, configFile) {
 /** `home` + `["nav", "about"]` -> `home.nav.about` */
 const toKey = (dictionary, keyPath) => [dictionary, ...keyPath].join(".");
 //#endregion
-export { listLocales as A, TODO_PREFIX as C, getString as D, getLeafSource as E, saveDictionaryFile as F, setString as I, locationOf as M, parseDictionaryText as N, hasPath as O, renderDictionaryFile as P, writeLock as S, dictionaryLocation as T, isStale as _, renderGenerated as a, readLock as b, parseStaticConfig as c, DEFAULT_SOURCE_GLOB as d, analyzeProject as f, hashSource as g, LOCK_FILE as h, generateDictionaries as i, loadDictionaryFile as j, listLeaves as k, readStaticConfig as l, scanReferences as m, loadStaticProject as n, runGenerate as o, relativeFile as p, toKey as r, DEFAULT_STATIC_CONFIG as s, loadProject as t, logger as u, lockFor as v, copyLeaf as w, record as x, lockPath as y };
+export { dictionaryLocation as A, saveDictionaryFile as B, writeLock as C, scanFiles as D, createGitignoreFilter as E, listLocales as F, loadDictionaryFile as I, locationOf as L, getString as M, hasPath as N, TODO_PREFIX as O, listLeaves as P, parseDictionaryText as R, record as S, SOURCE_BUILTIN_IGNORE as T, setString as V, hashSource as _, renderGenerated as a, lockPath as b, parseStaticConfig as c, logger as d, DEFAULT_SOURCE_GLOB as f, LOCK_FILE as g, scanReferences as h, generateDictionaries as i, getLeafSource as j, copyLeaf as k, readStaticConfig as l, relativeFile as m, loadStaticProject as n, runGenerate as o, analyzeProject as p, toKey as r, DEFAULT_STATIC_CONFIG as s, loadProject as t, resolveDialexConfig as u, isStale as v, BUILTIN_IGNORE as w, readLock as x, lockFor as y, renderDictionaryFile as z };
 
-//# sourceMappingURL=project-BJYmnKiU.mjs.map
+//# sourceMappingURL=project-DBVeKLa3.mjs.map