Add Chinese translation for README and implement README translation script
- Created README.zh.md for Chinese localization of the project. - Developed a README translation script to support multiple languages using Claude Agent SDK. - Implemented CLI and programmatic usage for the translation tool. - Added examples for integrating the translation tool into build scripts and CI/CD pipelines. - Enhanced error handling and logging for translation processes. - Included support for various languages and output customization options.
This commit is contained in:
Alex Newman
@@ -0,0 +1,233 @@
|
||||
#!/usr/bin/env npx tsx
|
||||
|
||||
import { translateReadme, SUPPORTED_LANGUAGES } from "./index.ts";
|
||||
|
||||
interface CliArgs {
|
||||
source: string;
|
||||
languages: string[];
|
||||
outputDir?: string;
|
||||
pattern?: string;
|
||||
preserveCode: boolean;
|
||||
model?: string;
|
||||
maxBudget?: number;
|
||||
verbose: boolean;
|
||||
help: boolean;
|
||||
listLanguages: boolean;
|
||||
}
|
||||
|
||||
function printHelp(): void {
|
||||
console.log(`
|
||||
readme-translator - Translate README.md files using Claude Agent SDK
|
||||
|
||||
AUTHENTICATION:
|
||||
If Claude Code is installed and authenticated (Pro/Max subscription),
|
||||
no API key is needed. Otherwise, set ANTHROPIC_API_KEY environment variable.
|
||||
|
||||
USAGE:
|
||||
translate-readme [options] <source> <languages...>
|
||||
translate-readme --help
|
||||
translate-readme --list-languages
|
||||
|
||||
ARGUMENTS:
|
||||
source Path to the source README.md file
|
||||
languages Target language codes (e.g., es fr de ja zh)
|
||||
|
||||
OPTIONS:
|
||||
-o, --output <dir> Output directory (default: same as source)
|
||||
-p, --pattern <pat> Output filename pattern (default: README.{lang}.md)
|
||||
--no-preserve-code Translate code blocks too (not recommended)
|
||||
-m, --model <model> Claude model to use (default: sonnet)
|
||||
--max-budget <usd> Maximum budget in USD
|
||||
-v, --verbose Show detailed progress
|
||||
-h, --help Show this help message
|
||||
--list-languages List all supported language codes
|
||||
|
||||
EXAMPLES:
|
||||
# Translate to Spanish and French
|
||||
translate-readme README.md es fr
|
||||
|
||||
# Translate to multiple languages with custom output
|
||||
translate-readme -v -o ./i18n --pattern docs.{lang}.md README.md de ja ko zh
|
||||
|
||||
# Use in npm scripts
|
||||
# package.json: "translate": "translate-readme README.md es fr de"
|
||||
|
||||
SUPPORTED LANGUAGES:
|
||||
Run with --list-languages to see all supported language codes
|
||||
`);
|
||||
}
|
||||
|
||||
function printLanguages(): void {
|
||||
const LANGUAGE_NAMES: Record<string, string> = {
|
||||
ar: "Arabic",
|
||||
bg: "Bulgarian",
|
||||
cs: "Czech",
|
||||
da: "Danish",
|
||||
de: "German",
|
||||
el: "Greek",
|
||||
es: "Spanish",
|
||||
et: "Estonian",
|
||||
fi: "Finnish",
|
||||
fr: "French",
|
||||
he: "Hebrew",
|
||||
hi: "Hindi",
|
||||
hu: "Hungarian",
|
||||
id: "Indonesian",
|
||||
it: "Italian",
|
||||
ja: "Japanese",
|
||||
ko: "Korean",
|
||||
lt: "Lithuanian",
|
||||
lv: "Latvian",
|
||||
nl: "Dutch",
|
||||
no: "Norwegian",
|
||||
pl: "Polish",
|
||||
pt: "Portuguese",
|
||||
"pt-br": "Brazilian Portuguese",
|
||||
ro: "Romanian",
|
||||
ru: "Russian",
|
||||
sk: "Slovak",
|
||||
sl: "Slovenian",
|
||||
sv: "Swedish",
|
||||
th: "Thai",
|
||||
tr: "Turkish",
|
||||
uk: "Ukrainian",
|
||||
vi: "Vietnamese",
|
||||
zh: "Chinese (Simplified)",
|
||||
"zh-tw": "Chinese (Traditional)",
|
||||
};
|
||||
|
||||
console.log("\nSupported Language Codes:\n");
|
||||
const sorted = Object.entries(LANGUAGE_NAMES).sort((a, b) =>
|
||||
a[1].localeCompare(b[1])
|
||||
);
|
||||
for (const [code, name] of sorted) {
|
||||
console.log(` ${code.padEnd(8)} ${name}`);
|
||||
}
|
||||
console.log("");
|
||||
}
|
||||
|
||||
function parseArgs(argv: string[]): CliArgs {
|
||||
const args: CliArgs = {
|
||||
source: "",
|
||||
languages: [],
|
||||
preserveCode: true,
|
||||
verbose: false,
|
||||
help: false,
|
||||
listLanguages: false,
|
||||
};
|
||||
|
||||
const positional: string[] = [];
|
||||
let i = 2; // Skip node and script path
|
||||
|
||||
while (i < argv.length) {
|
||||
const arg = argv[i];
|
||||
|
||||
switch (arg) {
|
||||
case "-h":
|
||||
case "--help":
|
||||
args.help = true;
|
||||
break;
|
||||
case "--list-languages":
|
||||
args.listLanguages = true;
|
||||
break;
|
||||
case "-v":
|
||||
case "--verbose":
|
||||
args.verbose = true;
|
||||
break;
|
||||
case "--no-preserve-code":
|
||||
args.preserveCode = false;
|
||||
break;
|
||||
case "-o":
|
||||
case "--output":
|
||||
args.outputDir = argv[++i];
|
||||
break;
|
||||
case "-p":
|
||||
case "--pattern":
|
||||
args.pattern = argv[++i];
|
||||
break;
|
||||
case "-m":
|
||||
case "--model":
|
||||
args.model = argv[++i];
|
||||
break;
|
||||
case "--max-budget":
|
||||
args.maxBudget = parseFloat(argv[++i]);
|
||||
break;
|
||||
default:
|
||||
if (arg.startsWith("-")) {
|
||||
console.error(`Unknown option: ${arg}`);
|
||||
process.exit(1);
|
||||
}
|
||||
positional.push(arg);
|
||||
}
|
||||
i++;
|
||||
}
|
||||
|
||||
if (positional.length > 0) {
|
||||
args.source = positional[0];
|
||||
args.languages = positional.slice(1);
|
||||
}
|
||||
|
||||
return args;
|
||||
}
|
||||
|
||||
async function main(): Promise<void> {
|
||||
const args = parseArgs(process.argv);
|
||||
|
||||
if (args.help) {
|
||||
printHelp();
|
||||
process.exit(0);
|
||||
}
|
||||
|
||||
if (args.listLanguages) {
|
||||
printLanguages();
|
||||
process.exit(0);
|
||||
}
|
||||
|
||||
if (!args.source) {
|
||||
console.error("Error: No source file specified");
|
||||
console.error("Run with --help for usage information");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
if (args.languages.length === 0) {
|
||||
console.error("Error: No target languages specified");
|
||||
console.error("Run with --help for usage information");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
// Validate language codes
|
||||
const invalidLangs = args.languages.filter(
|
||||
(lang) => !SUPPORTED_LANGUAGES.includes(lang.toLowerCase())
|
||||
);
|
||||
if (invalidLangs.length > 0) {
|
||||
console.error(`Error: Unknown language codes: ${invalidLangs.join(", ")}`);
|
||||
console.error("Run with --list-languages to see supported codes");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
try {
|
||||
const result = await translateReadme({
|
||||
source: args.source,
|
||||
languages: args.languages,
|
||||
outputDir: args.outputDir,
|
||||
pattern: args.pattern,
|
||||
preserveCode: args.preserveCode,
|
||||
model: args.model,
|
||||
maxBudgetUsd: args.maxBudget,
|
||||
verbose: args.verbose,
|
||||
});
|
||||
|
||||
// Exit with error code if any translations failed
|
||||
if (result.failed > 0) {
|
||||
process.exit(1);
|
||||
}
|
||||
} catch (error) {
|
||||
console.error(
|
||||
"Translation failed:",
|
||||
error instanceof Error ? error.message : error
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
main();
|
||||
Reference in New Issue
Block a user