@wolfstar/i18next-type-generator 3.1.0-next-20260830180323

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 Wolfstar Project
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,72 @@
+# `@wolfstar/i18next-type-generator`
+
+A fast and modern type augmentation generator for the [`@wolfstar/i18next-backend`](https://www.npmjs.com/package/@wolfstar/i18next-backend) filesystem-based [`i18next`](https://www.npmjs.com/package/i18next) backend for Node.js.
+
+## Usage
+
+```bash
+$ i18next-type-generator [options] [source] [destination]
+
+# Arguments:
+#   source                     The directory to generate types from (default: "./src/locales/en-US/")
+#   destination                The directory to generate types to (default: "./src/@types/i18next.d.ts")
+#
+# Options:
+#   -V, --version              output the version number
+#   -v, --verbose              Verbose output
+#   -i, --indentation <value>  Indentation for generated output (number of spaces or "tabs", default: tabs)
+#   --no-prettier              Disable prettier
+#   -h, --help                 display help for command
+```
+
+This CLI tool generates a `.d.ts` file with the following structure:
+
+```typescript
+// This file is automatically generated, do not edit it.
+/* eslint-disable */
+/* oxlint-disable */
+// oxfmt-ignore
+// prettier-ignore
+import 'i18next';
+
+// oxfmt-ignore
+// prettier-ignore
+declare module 'i18next' {
+	interface CustomTypeOptions {
+		resources: {
+			'commands/choice': {
+				name: 'choice';
+				description: 'Get a random value from a set of choices';
+				// ...
+			};
+			// ...
+		} & CustomResources;
+	}
+
+	interface CustomResources {}
+}
+```
+
+The generated `resources` type is intersected with an empty, mergeable `CustomResources` interface. This is the supported extension point: it lets you add resource keys that are not present in your locale JSON (for example keys whose runtime translation is supplied by the consuming application) without redeclaring `CustomTypeOptions.resources`, which would otherwise trigger `TS2717` for consumers that build with `skipLibCheck: false`.
+
+The output includes `eslint-disable` / `oxlint-disable` comments to suppress linting, and `oxfmt-ignore` / `prettier-ignore` comments before each top-level statement to prevent formatters from rewriting the generated file. These ignore directives are always emitted; the `--no-oxfmt` and `--no-prettier` flags only affect the internal formatting pass used to produce the resource block, not the emitted ignore comments.
+
+The command reads the JSON files inside a directory writes their contents into the `.d.ts` file. This is needed because `typeof import(pathToJSON)` requires the JSON files to be included in `tsconfig.json`, which may be undesirable, and because it types the keys and their inferred types, but does not load the exact values, which breaks i18next's ability to extract arguments from strings.
+
+You can control indentation with `-i` / `--indentation` (a space count or `tabs`). `prettier` is also used under the hood to format output before writing to a file; opt out with `--no-prettier` if you want to use a different tool.
+
+> **Note**: To add resource keys that are not generated from your locale JSON, merge them into `CustomResources` from a separate declaration file:
+>
+> ```typescript
+> import 'i18next';
+>
+> declare module 'i18next' {
+> 	interface CustomResources {
+> 		'commands/shared': {
+> 			extraKey: string;
+> 		};
+> 	}
+> }
+> ```
+>
+> To add other [`CustomTypeOptions` options](https://www.i18next.com/overview/typescript) (such as `defaultNS`), create a separate file too; TypeScript merges the augmentations.

package/dist/cli.js

@@ -0,0 +1,196 @@
+#!/usr/bin/env node
+import { defineCommand, runCommand, showUsage } from "citty";
+import { mkdir, opendir, readFile, writeFile } from "node:fs/promises";
+import { gray, green, italic, yellow } from "colorette";
+import { dirname, join, resolve } from "node:path";
+import { inspect } from "node:util";
+
+//#region src/generate.ts
+const ci = "CI" in process.env && process.env.CI !== "false";
+const FileIcon = ci ? "📄" : "";
+const DirectoryIcon = ci ? "📂" : "";
+const GENERATED_FILE_HEADER = [
+	"// This file is automatically generated, do not edit it.",
+	"/* eslint-disable */",
+	"/* oxlint-disable */"
+];
+const FORMATTER_IGNORE = ["// oxfmt-ignore", "// prettier-ignore"];
+/**
+* Inject formatter and linter ignore directives into the already-formatted output.
+*
+* The file-level `eslint-disable` / `oxlint-disable` comments suppress all lint rules, while the
+* per-statement `oxfmt-ignore` / `prettier-ignore` comments protect the two top-level statements
+* (the `i18next` import and the `declare module` block), since neither formatter supports a
+* whole-file inline ignore.
+* @param source The formatted generated source.
+*/
+function annotateGeneratedFile(source) {
+	const ignore = FORMATTER_IGNORE.join("\n");
+	const annotated = source.replace(/^(import\s+['"]i18next['"])/m, `${ignore}\n$1`).replace(/^(declare\s+module\s+['"]i18next['"])/m, `${ignore}\n$1`);
+	return `${GENERATED_FILE_HEADER.join("\n")}\n${annotated}`;
+}
+/**
+* Recursively walk through the directory and generate the types.
+* @param path The path to walk through.
+* @param namespace The namespace to use.
+*/
+async function recurse(lines, path, namespace, options) {
+	const indent = options.indentation.repeat(3);
+	if (options.verbose) console.log(gray(`Reading directory ${DirectoryIcon} ${green(path)}...`));
+	const entries = [];
+	for await (const dirent of await opendir(path)) entries.push(dirent);
+	entries.sort((a, b) => a.name.localeCompare(b.name));
+	for (const dirent of entries) {
+		const file = join(path, dirent.name);
+		if (dirent.isFile()) {
+			if (!dirent.name.endsWith(".json")) continue;
+			if (options.verbose) console.log(gray(`Processing ${FileIcon} ${green(file)}...`));
+			const name = dirent.name.slice(0, -5);
+			const key = JSON.stringify(namespace ? `${namespace}/${name}` : name);
+			const data = JSON.stringify(JSON.parse(await readFile(file, "utf8")), void 0, options.indentation);
+			lines.push(`${indent}${key}: ${data.replaceAll("\n", `\n${indent}`)};`);
+		} else if (dirent.isDirectory()) await recurse(lines, file, namespace ? `${namespace}/${dirent.name}` : dirent.name, options);
+	}
+}
+async function formatWithOxfmt(source, destination, options) {
+	if (!options.oxfmt) return;
+	try {
+		if (options.verbose) console.log(gray("Loading oxfmt..."));
+		const { format } = await import("oxfmt");
+		const { code, errors } = await format(destination, source);
+		if (errors.length > 0) throw new Error(errors.map((error) => error.message).join("\n"));
+		if (options.verbose) console.log(gray("Formatting with oxfmt."));
+		return code;
+	} catch (error) {
+		const message = error instanceof Error ? error.message : String(error);
+		console.warn(yellow(options.verbose ? `Failed to format with oxfmt: ${message}. Continuing with unformatted output.` : "Failed to format with oxfmt; install it as a dependency or use --no-oxfmt. Continuing with unformatted output."));
+	}
+}
+async function formatWithPrettier(source, destination, options) {
+	if (!options.prettier) return;
+	try {
+		if (options.verbose) console.log(gray("Loading prettier..."));
+		const { resolveConfig, format } = await import("prettier");
+		const config = await resolveConfig(destination);
+		if (options.verbose) console.log(gray(`Formatting with prettier config: ${inspect(config, { colors: true })}`));
+		return await format(source, {
+			...config,
+			filepath: destination
+		});
+	} catch (error) {
+		const message = error instanceof Error ? error.message : String(error);
+		console.warn(yellow(options.verbose ? `Failed to format with prettier: ${message}. Continuing with unformatted output.` : "Failed to format with prettier; install it as a dependency or use --no-prettier. Continuing with unformatted output."));
+	}
+}
+async function formatSource(source, destination, options) {
+	return await formatWithOxfmt(source, destination, options) ?? await formatWithPrettier(source, destination, options) ?? source;
+}
+async function generate([source, destination], options) {
+	const sourceDirectory = resolve(source);
+	const destinationFile = resolve(destination);
+	const i1 = options.indentation;
+	const i2 = i1.repeat(2);
+	if (options.verbose) {
+		const lines = [
+			`Source: ${DirectoryIcon} ${green(sourceDirectory)}...`,
+			`Output: ${FileIcon} ${green(destinationFile)}...`,
+			"",
+			"Options:",
+			`  - Verbose: ${green(options.verbose ? "yes" : "no")}`,
+			`  - Indentation: ${green(JSON.stringify(options.indentation))}`
+		];
+		console.log(italic(gray(lines.join("\n"))));
+	}
+	const lines = [
+		"import 'i18next';",
+		"",
+		"declare module 'i18next' {",
+		`${i1}interface CustomTypeOptions {`,
+		`${i2}resources: {`
+	];
+	await recurse(lines, sourceDirectory, "", options);
+	lines.push(`${i2}} & CustomResources;`, `${i1}}`, "", `${i1}interface CustomResources {}`, "}", "");
+	let generatedSource = lines.join("\n");
+	generatedSource = await formatSource(generatedSource, destinationFile, options);
+	generatedSource = annotateGeneratedFile(generatedSource);
+	await mkdir(dirname(destinationFile), { recursive: true });
+	await writeFile(destinationFile, generatedSource, "utf8");
+}
+
+//#endregion
+//#region src/cli.ts
+const packageFile = new URL("../package.json", import.meta.url);
+const packageJson = JSON.parse(await readFile(packageFile, "utf-8"));
+const parseIndentation = (value) => {
+	if (value === "tabs") return "	";
+	const parsed = Number(value);
+	if (Number.isNaN(parsed)) throw new Error("The indentation must be a number or \"tabs\"");
+	return " ".repeat(parsed);
+};
+const main = defineCommand({
+	meta: {
+		name: "i18next-type-generator",
+		version: packageJson.version,
+		description: packageJson.description
+	},
+	args: {
+		source: {
+			type: "positional",
+			description: "The directory to generate types from",
+			default: "./src/locales/en-US/"
+		},
+		destination: {
+			type: "positional",
+			description: "The directory to generate types to",
+			default: "./src/@types/i18next.d.ts"
+		},
+		indentation: {
+			type: "string",
+			description: "The indentation to use",
+			alias: "i",
+			default: "tabs"
+		},
+		verbose: {
+			type: "boolean",
+			description: "Verbose output",
+			alias: "v"
+		},
+		prettier: {
+			type: "boolean",
+			description: "Format output with prettier",
+			default: true
+		},
+		oxfmt: {
+			type: "boolean",
+			description: "Format output with oxfmt",
+			default: true
+		}
+	},
+	async run({ args }) {
+		await generate([args.source, args.destination], {
+			verbose: args.verbose,
+			oxfmt: args.oxfmt,
+			prettier: args.prettier,
+			indentation: parseIndentation(args.indentation)
+		});
+	}
+});
+const rawArgs = process.argv.slice(2);
+if (rawArgs.includes("--help") || rawArgs.includes("-h")) {
+	await showUsage(main);
+	process.exit(0);
+}
+if (rawArgs.includes("--version")) {
+	console.log(packageJson.version);
+	process.exit(0);
+}
+try {
+	await runCommand(main, { rawArgs });
+} catch (error) {
+	console.error(error instanceof Error ? error.message : error);
+	process.exit(1);
+}
+
+//#endregion
+export {  };
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","names":[],"sources":["../src/generate.ts","../src/cli.ts"],"sourcesContent":["import { gray, green, italic, yellow } from 'colorette';\nimport { mkdir, opendir, readFile, writeFile } from 'node:fs/promises';\nimport { dirname, join, resolve } from 'node:path';\nimport { inspect } from 'node:util';\n\nconst ci = 'CI' in process.env && process.env.CI !== 'false';\n\nconst FileIcon = ci ? '📄' : '\\uE628';\nconst DirectoryIcon = ci ? '📂' : '\\uF413';\n\nconst GENERATED_FILE_HEADER = ['// This file is automatically generated, do not edit it.', '/* eslint-disable */', '/* oxlint-disable */'] as const;\n\nconst FORMATTER_IGNORE = ['// oxfmt-ignore', '// prettier-ignore'] as const;\n\n/**\n * Inject formatter and linter ignore directives into the already-formatted output.\n *\n * The file-level `eslint-disable` / `oxlint-disable` comments suppress all lint rules, while the\n * per-statement `oxfmt-ignore` / `prettier-ignore` comments protect the two top-level statements\n * (the `i18next` import and the `declare module` block), since neither formatter supports a\n * whole-file inline ignore.\n * @param source The formatted generated source.\n */\nexport function annotateGeneratedFile(source: string): string {\n\tconst ignore = FORMATTER_IGNORE.join('\\n');\n\tconst annotated = source\n\t\t.replace(/^(import\\s+['\"]i18next['\"])/m, `${ignore}\\n$1`)\n\t\t.replace(/^(declare\\s+module\\s+['\"]i18next['\"])/m, `${ignore}\\n$1`);\n\n\treturn `${GENERATED_FILE_HEADER.join('\\n')}\\n${annotated}`;\n}\n\n/**\n * Recursively walk through the directory and generate the types.\n * @param path The path to walk through.\n * @param namespace The namespace to use.\n */\nasync function recurse(lines: string[], path: string, namespace: string, options: GenerateOptions) {\n\tconst indent = options.indentation.repeat(3);\n\n\tif (options.verbose) console.log(gray(`Reading directory ${DirectoryIcon} ${green(path)}...`));\n\n\tconst entries = [];\n\tfor await (const dirent of await opendir(path)) {\n\t\tentries.push(dirent);\n\t}\n\tentries.sort((a, b) => a.name.localeCompare(b.name));\n\n\tfor (const dirent of entries) {\n\t\tconst file = join(path, dirent.name);\n\t\tif (dirent.isFile()) {\n\t\t\tif (!dirent.name.endsWith('.json')) continue;\n\t\t\tif (options.verbose) console.log(gray(`Processing ${FileIcon} ${green(file)}...`));\n\n\t\t\tconst name = dirent.name.slice(0, -5);\n\t\t\tconst key = JSON.stringify(namespace ? `${namespace}/${name}` : name);\n\t\t\tconst data = JSON.stringify(JSON.parse(await readFile(file, 'utf8')), undefined, options.indentation);\n\t\t\tlines.push(`${indent}${key}: ${data.replaceAll('\\n', `\\n${indent}`)};`);\n\t\t} else if (dirent.isDirectory()) {\n\t\t\tawait recurse(lines, file, namespace ? `${namespace}/${dirent.name}` : dirent.name, options);\n\t\t}\n\t}\n}\n\nasync function formatWithOxfmt(source: string, destination: string, options: GenerateOptions): Promise<string | undefined> {\n\tif (!options.oxfmt) return;\n\n\ttry {\n\t\tif (options.verbose) console.log(gray('Loading oxfmt...'));\n\n\t\tconst { format } = await import('oxfmt');\n\t\tconst { code, errors } = await format(destination, source);\n\t\tif (errors.length > 0) {\n\t\t\tthrow new Error(errors.map((error) => error.message).join('\\n'));\n\t\t}\n\n\t\tif (options.verbose) console.log(gray('Formatting with oxfmt.'));\n\n\t\treturn code;\n\t} catch (error) {\n\t\tconst message = error instanceof Error ? error.message : String(error);\n\t\tconsole.warn(\n\t\t\tyellow(\n\t\t\t\toptions.verbose\n\t\t\t\t\t? `Failed to format with oxfmt: ${message}. Continuing with unformatted output.`\n\t\t\t\t\t: 'Failed to format with oxfmt; install it as a dependency or use --no-oxfmt. Continuing with unformatted output.'\n\t\t\t)\n\t\t);\n\t}\n\n\treturn undefined;\n}\n\nasync function formatWithPrettier(source: string, destination: string, options: GenerateOptions): Promise<string | undefined> {\n\tif (!options.prettier) return;\n\n\ttry {\n\t\tif (options.verbose) console.log(gray('Loading prettier...'));\n\n\t\tconst { resolveConfig, format } = await import('prettier');\n\t\tconst config = await resolveConfig(destination);\n\t\tif (options.verbose) console.log(gray(`Formatting with prettier config: ${inspect(config, { colors: true })}`));\n\n\t\treturn await format(source, { ...config, filepath: destination });\n\t} catch (error) {\n\t\tconst message = error instanceof Error ? error.message : String(error);\n\t\tconsole.warn(\n\t\t\tyellow(\n\t\t\t\toptions.verbose\n\t\t\t\t\t? `Failed to format with prettier: ${message}. Continuing with unformatted output.`\n\t\t\t\t\t: 'Failed to format with prettier; install it as a dependency or use --no-prettier. Continuing with unformatted output.'\n\t\t\t)\n\t\t);\n\t}\n\n\treturn undefined;\n}\n\nasync function formatSource(source: string, destination: string, options: GenerateOptions) {\n\treturn (await formatWithOxfmt(source, destination, options)) ?? (await formatWithPrettier(source, destination, options)) ?? source;\n}\n\nexport async function generate([source, destination]: string[], options: GenerateOptions) {\n\tconst sourceDirectory = resolve(source);\n\tconst destinationFile = resolve(destination);\n\tconst i1 = options.indentation;\n\tconst i2 = i1.repeat(2);\n\n\tif (options.verbose) {\n\t\tconst lines = [\n\t\t\t`Source: ${DirectoryIcon} ${green(sourceDirectory)}...`,\n\t\t\t`Output: ${FileIcon} ${green(destinationFile)}...`,\n\t\t\t'',\n\t\t\t'Options:',\n\t\t\t`  - Verbose: ${green(options.verbose ? 'yes' : 'no')}`,\n\t\t\t`  - Indentation: ${green(JSON.stringify(options.indentation))}`\n\t\t];\n\t\tconsole.log(italic(gray(lines.join('\\n'))));\n\t}\n\n\tconst lines = [\"import 'i18next';\", '', \"declare module 'i18next' {\", `${i1}interface CustomTypeOptions {`, `${i2}resources: {`];\n\n\tawait recurse(lines, sourceDirectory, '', options);\n\t// Intersecting with the mergeable `CustomResources` interface lets consumers add extra keys (e.g. keys\n\t// whose runtime data is provided externally) from their own declaration file without redeclaring\n\t// `resources`, which would otherwise trigger TS2717 (conflicting property declarations).\n\tlines.push(`${i2}} & CustomResources;`, `${i1}}`, '', `${i1}interface CustomResources {}`, '}', '');\n\n\tlet generatedSource = lines.join('\\n');\n\tgeneratedSource = await formatSource(generatedSource, destinationFile, options);\n\tgeneratedSource = annotateGeneratedFile(generatedSource);\n\n\tawait mkdir(dirname(destinationFile), { recursive: true });\n\tawait writeFile(destinationFile, generatedSource, 'utf8');\n}\n\ninterface GenerateOptions {\n\tverbose: boolean;\n\toxfmt: boolean;\n\tprettier: boolean;\n\tindentation: string;\n}\n","#!/usr/bin/env node\n\nimport { defineCommand, runCommand, showUsage } from 'citty';\nimport { readFile } from 'node:fs/promises';\nimport { generate } from './generate.js';\n\nconst packageFile = new URL('../package.json', import.meta.url);\nconst packageJson = JSON.parse(await readFile(packageFile, 'utf-8'));\n\nconst parseIndentation = (value: string): string => {\n\tif (value === 'tabs') return '\\t';\n\n\tconst parsed = Number(value);\n\tif (Number.isNaN(parsed)) throw new Error('The indentation must be a number or \"tabs\"');\n\treturn ' '.repeat(parsed);\n};\n\nconst main = defineCommand({\n\tmeta: {\n\t\tname: 'i18next-type-generator',\n\t\tversion: packageJson.version,\n\t\tdescription: packageJson.description\n\t},\n\targs: {\n\t\tsource: {\n\t\t\ttype: 'positional',\n\t\t\tdescription: 'The directory to generate types from',\n\t\t\tdefault: './src/locales/en-US/'\n\t\t},\n\t\tdestination: {\n\t\t\ttype: 'positional',\n\t\t\tdescription: 'The directory to generate types to',\n\t\t\tdefault: './src/@types/i18next.d.ts'\n\t\t},\n\t\tindentation: {\n\t\t\ttype: 'string',\n\t\t\tdescription: 'The indentation to use',\n\t\t\talias: 'i',\n\t\t\tdefault: 'tabs'\n\t\t},\n\t\tverbose: {\n\t\t\ttype: 'boolean',\n\t\t\tdescription: 'Verbose output',\n\t\t\talias: 'v'\n\t\t},\n\t\tprettier: {\n\t\t\ttype: 'boolean',\n\t\t\tdescription: 'Format output with prettier',\n\t\t\tdefault: true\n\t\t},\n\t\toxfmt: {\n\t\t\ttype: 'boolean',\n\t\t\tdescription: 'Format output with oxfmt',\n\t\t\tdefault: true\n\t\t}\n\t},\n\tasync run({ args }) {\n\t\tawait generate([args.source, args.destination], {\n\t\t\tverbose: args.verbose,\n\t\t\toxfmt: args.oxfmt,\n\t\t\tprettier: args.prettier,\n\t\t\tindentation: parseIndentation(args.indentation)\n\t\t});\n\t}\n});\n\nconst rawArgs = process.argv.slice(2);\n\nif (rawArgs.includes('--help') || rawArgs.includes('-h')) {\n\tawait showUsage(main);\n\tprocess.exit(0);\n}\n\nif (rawArgs.includes('--version')) {\n\tconsole.log(packageJson.version);\n\tprocess.exit(0);\n}\n\ntry {\n\tawait runCommand(main, { rawArgs });\n} catch (error) {\n\tconsole.error(error instanceof Error ? error.message : error);\n\tprocess.exit(1);\n}\n"],"mappings":";;;;;;;;AAKA,MAAM,KAAK,QAAQ,QAAQ,OAAO,QAAQ,IAAI,OAAO;AAErD,MAAM,WAAW,KAAK,OAAO;AAC7B,MAAM,gBAAgB,KAAK,OAAO;AAElC,MAAM,wBAAwB;CAAC;CAA4D;CAAwB;AAAsB;AAEzI,MAAM,mBAAmB,CAAC,mBAAmB,oBAAoB;;;;;;;;;;AAWjE,SAAgB,sBAAsB,QAAwB;CAC7D,MAAM,SAAS,iBAAiB,KAAK,IAAI;CACzC,MAAM,YAAY,OAChB,QAAQ,gCAAgC,GAAG,OAAO,KAAK,CAAC,CACxD,QAAQ,0CAA0C,GAAG,OAAO,KAAK;CAEnE,OAAO,GAAG,sBAAsB,KAAK,IAAI,EAAE,IAAI;AAChD;;;;;;AAOA,eAAe,QAAQ,OAAiB,MAAc,WAAmB,SAA0B;CAClG,MAAM,SAAS,QAAQ,YAAY,OAAO,CAAC;CAE3C,IAAI,QAAQ,SAAS,QAAQ,IAAI,KAAK,qBAAqB,cAAc,GAAG,MAAM,IAAI,EAAE,IAAI,CAAC;CAE7F,MAAM,UAAU,CAAC;CACjB,WAAW,MAAM,UAAU,MAAM,QAAQ,IAAI,GAC5C,QAAQ,KAAK,MAAM;CAEpB,QAAQ,MAAM,GAAG,MAAM,EAAE,KAAK,cAAc,EAAE,IAAI,CAAC;CAEnD,KAAK,MAAM,UAAU,SAAS;EAC7B,MAAM,OAAO,KAAK,MAAM,OAAO,IAAI;EACnC,IAAI,OAAO,OAAO,GAAG;GACpB,IAAI,CAAC,OAAO,KAAK,SAAS,OAAO,GAAG;GACpC,IAAI,QAAQ,SAAS,QAAQ,IAAI,KAAK,cAAc,SAAS,GAAG,MAAM,IAAI,EAAE,IAAI,CAAC;GAEjF,MAAM,OAAO,OAAO,KAAK,MAAM,GAAG,EAAE;GACpC,MAAM,MAAM,KAAK,UAAU,YAAY,GAAG,UAAU,GAAG,SAAS,IAAI;GACpE,MAAM,OAAO,KAAK,UAAU,KAAK,MAAM,MAAM,SAAS,MAAM,MAAM,CAAC,GAAG,QAAW,QAAQ,WAAW;GACpG,MAAM,KAAK,GAAG,SAAS,IAAI,IAAI,KAAK,WAAW,MAAM,KAAK,QAAQ,EAAE,EAAE;EACvE,OAAO,IAAI,OAAO,YAAY,GAC7B,MAAM,QAAQ,OAAO,MAAM,YAAY,GAAG,UAAU,GAAG,OAAO,SAAS,OAAO,MAAM,OAAO;CAE7F;AACD;AAEA,eAAe,gBAAgB,QAAgB,aAAqB,SAAuD;CAC1H,IAAI,CAAC,QAAQ,OAAO;CAEpB,IAAI;EACH,IAAI,QAAQ,SAAS,QAAQ,IAAI,KAAK,kBAAkB,CAAC;EAEzD,MAAM,EAAE,WAAW,MAAM,OAAO;EAChC,MAAM,EAAE,MAAM,WAAW,MAAM,OAAO,aAAa,MAAM;EACzD,IAAI,OAAO,SAAS,GACnB,MAAM,IAAI,MAAM,OAAO,KAAK,UAAU,MAAM,OAAO,CAAC,CAAC,KAAK,IAAI,CAAC;EAGhE,IAAI,QAAQ,SAAS,QAAQ,IAAI,KAAK,wBAAwB,CAAC;EAE/D,OAAO;CACR,SAAS,OAAO;EACf,MAAM,UAAU,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;EACrE,QAAQ,KACP,OACC,QAAQ,UACL,gCAAgC,QAAQ,yCACxC,gHACJ,CACD;CACD;AAGD;AAEA,eAAe,mBAAmB,QAAgB,aAAqB,SAAuD;CAC7H,IAAI,CAAC,QAAQ,UAAU;CAEvB,IAAI;EACH,IAAI,QAAQ,SAAS,QAAQ,IAAI,KAAK,qBAAqB,CAAC;EAE5D,MAAM,EAAE,eAAe,WAAW,MAAM,OAAO;EAC/C,MAAM,SAAS,MAAM,cAAc,WAAW;EAC9C,IAAI,QAAQ,SAAS,QAAQ,IAAI,KAAK,oCAAoC,QAAQ,QAAQ,EAAE,QAAQ,KAAK,CAAC,GAAG,CAAC;EAE9G,OAAO,MAAM,OAAO,QAAQ;GAAE,GAAG;GAAQ,UAAU;EAAY,CAAC;CACjE,SAAS,OAAO;EACf,MAAM,UAAU,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;EACrE,QAAQ,KACP,OACC,QAAQ,UACL,mCAAmC,QAAQ,yCAC3C,sHACJ,CACD;CACD;AAGD;AAEA,eAAe,aAAa,QAAgB,aAAqB,SAA0B;CAC1F,OAAQ,MAAM,gBAAgB,QAAQ,aAAa,OAAO,KAAO,MAAM,mBAAmB,QAAQ,aAAa,OAAO,KAAM;AAC7H;AAEA,eAAsB,SAAS,CAAC,QAAQ,cAAwB,SAA0B;CACzF,MAAM,kBAAkB,QAAQ,MAAM;CACtC,MAAM,kBAAkB,QAAQ,WAAW;CAC3C,MAAM,KAAK,QAAQ;CACnB,MAAM,KAAK,GAAG,OAAO,CAAC;CAEtB,IAAI,QAAQ,SAAS;EACpB,MAAM,QAAQ;GACb,WAAW,cAAc,GAAG,MAAM,eAAe,EAAE;GACnD,WAAW,SAAS,GAAG,MAAM,eAAe,EAAE;GAC9C;GACA;GACA,gBAAgB,MAAM,QAAQ,UAAU,QAAQ,IAAI;GACpD,oBAAoB,MAAM,KAAK,UAAU,QAAQ,WAAW,CAAC;EAC9D;EACA,QAAQ,IAAI,OAAO,KAAK,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC;CAC3C;CAEA,MAAM,QAAQ;EAAC;EAAqB;EAAI;EAA8B,GAAG,GAAG;EAAgC,GAAG,GAAG;CAAa;CAE/H,MAAM,QAAQ,OAAO,iBAAiB,IAAI,OAAO;CAIjD,MAAM,KAAK,GAAG,GAAG,uBAAuB,GAAG,GAAG,IAAI,IAAI,GAAG,GAAG,+BAA+B,KAAK,EAAE;CAElG,IAAI,kBAAkB,MAAM,KAAK,IAAI;CACrC,kBAAkB,MAAM,aAAa,iBAAiB,iBAAiB,OAAO;CAC9E,kBAAkB,sBAAsB,eAAe;CAEvD,MAAM,MAAM,QAAQ,eAAe,GAAG,EAAE,WAAW,KAAK,CAAC;CACzD,MAAM,UAAU,iBAAiB,iBAAiB,MAAM;AACzD;;;;ACpJA,MAAM,cAAc,IAAI,IAAI,mBAAmB,YAAY,GAAG;AAC9D,MAAM,cAAc,KAAK,MAAM,MAAM,SAAS,aAAa,OAAO,CAAC;AAEnE,MAAM,oBAAoB,UAA0B;CACnD,IAAI,UAAU,QAAQ,OAAO;CAE7B,MAAM,SAAS,OAAO,KAAK;CAC3B,IAAI,OAAO,MAAM,MAAM,GAAG,MAAM,IAAI,MAAM,8CAA4C;CACtF,OAAO,IAAI,OAAO,MAAM;AACzB;AAEA,MAAM,OAAO,cAAc;CAC1B,MAAM;EACL,MAAM;EACN,SAAS,YAAY;EACrB,aAAa,YAAY;CAC1B;CACA,MAAM;EACL,QAAQ;GACP,MAAM;GACN,aAAa;GACb,SAAS;EACV;EACA,aAAa;GACZ,MAAM;GACN,aAAa;GACb,SAAS;EACV;EACA,aAAa;GACZ,MAAM;GACN,aAAa;GACb,OAAO;GACP,SAAS;EACV;EACA,SAAS;GACR,MAAM;GACN,aAAa;GACb,OAAO;EACR;EACA,UAAU;GACT,MAAM;GACN,aAAa;GACb,SAAS;EACV;EACA,OAAO;GACN,MAAM;GACN,aAAa;GACb,SAAS;EACV;CACD;CACA,MAAM,IAAI,EAAE,QAAQ;EACnB,MAAM,SAAS,CAAC,KAAK,QAAQ,KAAK,WAAW,GAAG;GAC/C,SAAS,KAAK;GACd,OAAO,KAAK;GACZ,UAAU,KAAK;GACf,aAAa,iBAAiB,KAAK,WAAW;EAC/C,CAAC;CACF;AACD,CAAC;AAED,MAAM,UAAU,QAAQ,KAAK,MAAM,CAAC;AAEpC,IAAI,QAAQ,SAAS,QAAQ,KAAK,QAAQ,SAAS,IAAI,GAAG;CACzD,MAAM,UAAU,IAAI;CACpB,QAAQ,KAAK,CAAC;AACf;AAEA,IAAI,QAAQ,SAAS,WAAW,GAAG;CAClC,QAAQ,IAAI,YAAY,OAAO;CAC/B,QAAQ,KAAK,CAAC;AACf;AAEA,IAAI;CACH,MAAM,WAAW,MAAM,EAAE,QAAQ,CAAC;AACnC,SAAS,OAAO;CACf,QAAQ,MAAM,iBAAiB,QAAQ,MAAM,UAAU,KAAK;CAC5D,QAAQ,KAAK,CAAC;AACf"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@wolfstar/i18next-type-generator",
+  "version": "3.1.0-next-20260830180323",
+  "description": "A fast utility that generates the TypeScript augmentation for i18next.",
+  "keywords": [
+    "api",
+    "discord",
+    "http",
+    "i18next",
+    "pnpm",
+    "ts",
+    "typescript",
+    "wolfstar"
+  ],
+  "homepage": "https://github.com/wolfstar-project/stars-components/tree/main/packages/i18next-type-generator",
+  "bugs": {
+    "url": "https://github.com/wolfstar-project/stars-components/issues"
+  },
+  "license": "Apache-2.0",
+  "author": "@wolfstar",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wolfstar-project/stars-components.git",
+    "directory": "packages/i18next-type-generator"
+  },
+  "bin": {
+    "i18next-type-generator": "./dist/cli.js"
+  },
+  "files": [
+    "dist/"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "dist/cli.js",
+  "exports": {
+    ".": {
+      "default": "./dist/cli.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "citty": "^0.1.6",
+    "colorette": "^2.0.20",
+    "tslib": "^2.8.1"
+  },
+  "devDependencies": {
+    "@types/node": "22.15.21",
+    "@vitest/coverage-v8": "^4.1.8",
+    "tsdown": "^0.22.2",
+    "typescript": "~5.8.3",
+    "vitest": "^4.1.8"
+  },
+  "optionalDependencies": {
+    "oxfmt": "^0.53.0",
+    "prettier": "^3.5.3"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "test": "vitest run",
+    "build": "tsdown --config-loader unrun",
+    "watch": "tsdown --config-loader unrun --watch",
+    "typecheck": "tsc -p ../../tsconfig.json",
+    "lint": "oxlint src --fix"
+  }
+}