handlebars-i18n-cli 1.0.4 → 2.0.0

package/bin/i18n-collect

@@ -1,4 +1,38 @@
 #!/usr/bin/env node
 
-require = require('esm')(module);
-require('../src/i18n-collect').cli(process.argv);
+import {program} from 'commander';
+import {i18nCollect} from "../src/index.js";
+import fs from 'async-file-tried';
+
+const [packageJS, err] = await fs.readJson('./package.json');
+if (err) throw (err);
+
+program
+  .name('i18n-deepl')
+  .version(packageJS.version)
+  .description(`Automatically extract translation strings from your handlebars templates and generate i18next conform json files from it`)
+  .arguments('<source> <target>')
+  .option('-a, --alphabetical', 'sort keys alphabetically in the json output')
+  .option('-dr, --dryRun', 'perform a dry run without making any changes')
+  .option('-e, --empty', 'will create empty value strings for the translations in the json. Default: value strings contain current language and key name')
+  .option('--lng <languages>', 'the languages you want to be generated, e.g., de,fr,es. default: en',
+    (value) => value.split(','))
+  .option('-l, --log', 'enable logging')
+  .option('-sf, --separateLngFiles', 'create separate json files for each language')
+  .option('--translFunc <function>', 'specify your custom translation function name. Default: __ like handlebars-i18n notation: {{__ keyToTranslate}}')
+  .option('-u, --update', 'updates existing json files(s)')
+  .action(async (source, target, options) => {
+
+    if (await i18nCollect(source, target, options)) {
+      return (options.separateLngFiles)
+        ? console.log('\x1b[32m%s\x1b[0m', 'You’re good. The output was written to separate language files.')
+        : console.log('\x1b[32m%s\x1b[0m', `Done and Ready. Your output was written to ${target}`);
+    }
+  });
+
+program.parse(process.argv);
+
+// If no arguments are provided, display help
+if (!process.argv.slice(2).length) {
+  program.outputHelp();
+}

package/bin/i18n-deepl

@@ -0,0 +1,71 @@
+#!/usr/bin/env node
+
+import dotenv from 'dotenv';
+
+dotenv.config();
+import {program} from 'commander';
+import {getSupportedLanguages, setAuthKey, translateToJSON} from '../src/index.js';
+import fs from 'async-file-tried';
+
+const [packageJS, err] = await fs.readJson('./package.json');
+if (err) throw (err);
+
+program
+  .name('i18n-deepl')
+  .version(packageJS.version)
+  .description('Translate i18next JSON files via DeepL API.')
+
+program
+  .command('languages')
+  .description('List DeepL’s supported languages.')
+  .option('--auth-key <authKey>', 'The DeepL Auth Key.')
+  .action(async (options) => {
+    const authKey = options.authKey || process.env.DEEPL_AUTH;
+    const languages = await getSupportedLanguages(authKey);
+    console.log('DeepL’s Supported Languages:');
+    languages.forEach(lang =>
+      console.log(`${lang.language} - ${lang.name}`)
+    );
+  });
+
+program
+  .command('setAuth authKey')
+  .description('Sets the DeepL Auth Key as environmental variable (.env).')
+  .action(async (authKey) => {
+    await setAuthKey(authKey);
+    return console.log('Success. DeepL Auth Key is now set.');
+  });
+
+program
+  .command('translate')
+  .description('Translate texts from a JSON file to the target language.')
+  .arguments('<source> <target> <targetLang>')
+  .option('--auth-key, -ak <authKey>', 'The DeepL Auth Key.')
+  .option('--source-lang, -sl <sourceLang>', 'Source language for translation, such as "de".')
+  .option('-sn, --source-nested <sourceNested>', 'Send only a sub-entry of the source JSON to DeepL API. ' +
+    'I.E. --source-nested="translations.de]" will route to the nested entry \'translations\' and within it will send the entries of \'de\' to translation.')
+  .option('--log, -l', 'Log translation response to console.')
+  .option('--dryRun, -dr', 'Perform a dry run and log it without making any changes to actual data.')
+  .option('--options, -o <options>', 'DeepL API options, given as object, i.E. --options="{formality: \'less\'}."')
+  .action(
+    async (source, target, targetLang, options) => {
+
+      await translateToJSON(options.authKey || process.env.DEEPL_AUTH,
+        source,
+        target,
+        options.sourceLang || null,
+        targetLang,
+        options.options || {},
+        options.sourceNested || null,
+        options.L || false,
+        options.Dr || false,
+      );
+      console.log(`Translation complete. See ${target} for your results.`)
+    });
+
+program.parse(process.argv);
+
+// If no arguments are provided, display help
+if (!process.argv.slice(2).length) {
+  program.outputHelp();
+}

package/de.json

@@ -0,0 +1,72 @@
+{
+  "de": {
+    "Invoice": "Facture",
+    "Invoicepre": "Prepayment",
+    "Invoice_final": "The invoice finale",
+    "Intro_statement": "Based on our {{refLetterId}} offer, we will invoice you for the following items sent on {{date of dispatch}}:",
+    "Intro_statement_pre": "We hereby confirm that we have received your order request in accordance with our offer {{refLetterId}}.",
+    "Info_EU": "This is an intra-Community supply exempt from tax under Articles 4(1b) and 6a of the VAT Act.",
+    "Info_World": "This is a tax-free export transaction.",
+    "The_date_of_performance": "The date of performance of the service corresponds to the date of invoicing.",
+    "Transfer_statement": "Please transfer the invoice amount within {{paymentTerms}} days with reference {{letterId}} to the following account :",
+    "Transfer_statement_pre": "Transfer the total amount of the deposit to the following account using the reference number {{letterId}}:",
+    "Confirmation_statement_pre": "Once we have received this deposit, we will confirm your order and start manufacturing the products you have ordered.",
+    "Thank_statement": "We thank you warmly for your confidence and hope to receive further orders from you in the future. Please do not hesitate to contact us <a href=\"{{telHref}}\" class=\"black\">{{phone}}</a> if you need any further information.",
+    "General_Sale_and_Delivery_Terms": "This service is provided solely in accordance with our general terms and conditions of sale and delivery as set out on <a href=\"http://{{webAgb}}\" class=\"orange\"> {{webAgb}} </a>.",
+    "Net_pre": "Amount of deposit (net)",
+    "Total_pre": "Total amount of payments",
+    "Net_final": "Deposit received",
+    "Total_final": "Total stock",
+    "VAT_final": "VAT on the deposit received",
+    "Proforma": "Facture pro forma",
+    "Comercial": "Commercial invoice",
+    "EORI_no": "EORI-number"
+  },
+  "en-US": {
+    "a": "b",
+    "Invoice": "Facture",
+    "Invoicepre": "Prepayment",
+    "Invoice_final": "The invoice finale",
+    "Intro_statement": "Based on our {{refLetterId}} offer, we will invoice you for the following items sent on {{date of dispatch}}:",
+    "Intro_statement_pre": "We hereby confirm that we have received your order request in accordance with our offer {{refLetterId}}.",
+    "Info_EU": "This is an intra-Community supply exempt from tax under Articles 4(1b) and 6a of the VAT Act.",
+    "Info_World": "This is a tax-free export transaction.",
+    "The_date_of_performance": "The date of performance of the service corresponds to the date of invoicing.",
+    "Transfer_statement": "Please transfer the invoice amount within {{paymentTerms}} days with reference {{letterId}} to the following account :",
+    "Transfer_statement_pre": "Transfer the total amount of the deposit to the following account using the reference number {{letterId}}:",
+    "Confirmation_statement_pre": "Once we have received this deposit, we will confirm your order and start manufacturing the products you have ordered.",
+    "Thank_statement": "We thank you warmly for your confidence and hope to receive further orders from you in the future. Please do not hesitate to contact us <a href=\"{{telHref}}\" class=\"black\">{{phone}}</a> if you need any further information.",
+    "General_Sale_and_Delivery_Terms": "This service is provided solely in accordance with our general terms and conditions of sale and delivery as set out on <a href=\"http://{{webAgb}}\" class=\"orange\"> {{webAgb}} </a>.",
+    "Net_pre": "Amount of deposit (net)",
+    "Total_pre": "Total amount of payments",
+    "Net_final": "Deposit received",
+    "Total_final": "Total stock",
+    "VAT_final": "VAT on the deposit received",
+    "Proforma": "Facture pro forma",
+    "Comercial": "Commercial invoice",
+    "EORI_no": "EORI-number"
+  },
+  "fi": {
+    "Invoice": "Facture",
+    "Invoicepre": "Ennakkolasku",
+    "Invoice_final": "Faktuurin finaali",
+    "Intro_statement": "Tarjouksemme {{refLetterId}} perusteella laskutamme sinua seuraavista eristä {{lähetyspäivänä}} lähetetyistä tavaroista:",
+    "Intro_statement_pre": "Vahvistamme täten, että olemme vastaanottaneet tilauspyyntösi tarjouksemme mukaisesti {{refLetterId}}.",
+    "Info_EU": "Kyseessä on arvonlisäverolain 4 §:n 1 b kohdan ja 6 a §:n mukainen veroton yhteisön sisäinen luovutus.",
+    "Info_World": "Tämä on verovapaa vientitoimitus.",
+    "The_date_of_performance": "Palvelun suorituspäivä vastaa laskutuspäivää.",
+    "Transfer_statement": "Pyydämme teitä siirtämään laskun summan {{paymentTerms}}-päivien kuluessa viitteellä {{letterId}} seuraavalle tilille :",
+    "Transfer_statement_pre": "Siirrä talletuksen kokonaissumma seuraavalle tilille viitenumeroa {{letterId}} käyttäen:",
+    "Confirmation_statement_pre": "Kun olemme saaneet tämän talletuksen, vahvistamme tilauksesi ja aloitamme tilattujen tuotteiden valmistuksen.",
+    "Thank_statement": "Kiitämme teitä lämpimästi luottamuksestanne ja toivomme voivamme ottaa teiltä vastaan uusia tilauksia tulevaisuudessa. Älä epäröi ottaa meihin yhteyttä <a href=\"{{telHref}}\" class=\"black\">{{puhelin}}</a>, jos tarvitset lisätietoja.",
+    "General_Sale_and_Delivery_Terms": "Tämä palvelu on tarjottu yksinomaan <a href=\"http://{{webAgb}}\" class=\"orange\"> {{webAgb}} </a> -sivustolla olevien yleisten myynti- ja toimitusehtojemme mukaisesti.",
+    "Net_pre": "Talletuksen määrä (netto)",
+    "Total_pre": "Maksujen kokonaismäärä",
+    "Net_final": "Saatu talletus",
+    "Total_final": "Kokonaiskanta",
+    "VAT_final": "saadun talletuksen arvonlisävero",
+    "Proforma": "Facture pro forma",
+    "Comercial": "Kauppalasku",
+    "EORI_no": "EORI-numero"
+  }
+}

package/en.json

@@ -0,0 +1,5 @@
+{
+  "header": {
+    "greet": "Hello World!"
+  }
+}

package/fi.json

@@ -0,0 +1,5 @@
+{
+  "header": {
+    "greet": "Hei maailma!"
+  }
+}

package/my.json

@@ -0,0 +1,23 @@
+{
+  "Invoice": "Fattore",
+  "Invoicepre": "Pagamento anticipato",
+  "Invoice_final": "Il finale della fattura",
+  "Intro_statement": "In base alla nostra offerta {{refLetterId}}, vi fattureremo i seguenti articoli inviati il {{data di spedizione}}:",
+  "Intro_statement_pre": "Con la presente vi confermiamo di aver ricevuto la vostra richiesta d'ordine in conformità con la nostra offerta {{refLetterId}}.",
+  "Info_EU": "Si tratta di una cessione intracomunitaria esente da imposta ai sensi dell'articolo 4, paragrafo 1b, e dell'articolo 6a della legge sull'IVA.",
+  "Info_World": "Si tratta di una transazione di esportazione esente da imposte.",
+  "The_date_of_performance": "La data di esecuzione del servizio corrisponde alla data di fatturazione.",
+  "Transfer_statement": "Si prega di trasferire l'importo della fattura entro {{Termini di pagamento}} giorni con riferimento {{letteraId}} al seguente conto:",
+  "Transfer_statement_pre": "Trasferire l'importo totale del deposito sul seguente conto utilizzando il numero di riferimento {{letterId}}:",
+  "Confirmation_statement_pre": "Una volta ricevuto il deposito, confermeremo l'ordine e inizieremo a produrre i prodotti ordinati.",
+  "Thank_statement": "Vi ringraziamo calorosamente per la vostra fiducia e speriamo di ricevere altri ordini da parte vostra in futuro. Non esitate a contattarci <a href=\"{{telHref}}\" class=\"black\">{{phone}}</a> se avete bisogno di ulteriori informazioni.",
+  "General_Sale_and_Delivery_Terms": "Questo servizio è fornito esclusivamente in conformità con i nostri termini e condizioni generali di vendita e consegna, come indicato su <a href=\"http://{{webAgb}}\" class=\"orange\"> {{webAgb}} </a>.",
+  "Net_pre": "Importo del deposito (netto)",
+  "Total_pre": "Importo totale dei pagamenti",
+  "Net_final": "Deposito ricevuto",
+  "Total_final": "Totale azioni",
+  "VAT_final": "IVA sulla caparra ricevuta",
+  "Proforma": "Fattura pro forma",
+  "Comercial": "Attività commerciale",
+  "EORI_no": "Numero EORI"
+}

package/package.json

@@ -1,17 +1,22 @@
 {
   "name": "handlebars-i18n-cli",
-  "version": "1.0.4",
-  "description": "A CLI tool to support node module handlebars-i18n",
-  "main": "./src/i18n-collect.js",
+  "version": "2.0.0",
+  "description": "Extracts translation keys from handlebars templates and forms JSON from it; generates automatic translations via DeepL.",
+  "main": "src/index.js",
+  "type": "module",
+  "types": "types/index.d.ts",
   "bin": {
     "@fwalzel/handlebars-i18n-cli": "./bin/i18n-collect",
-    "i18n-collect": "./bin/i18n-collect"
+    "i18n-collect": "./bin/i18n-collect",
+    "@fwalzel/i18n-deepl": "./bin/i18n-deepl",
+    "i18n-deepl": "./bin/i18n-deepl"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "test" : "nyc mocha",
+    "test": "c8 mocha",
+    "test:coverage": "npm run test && c8 report --reporter=text-lcov > coverage/lcov.info",
     "test:istanbul": "istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec",
     "coveralls": "npm test && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage",
     "i18n-collect": "cd bin && node i18n-collect"
@@ -23,10 +28,10 @@
   "keywords": [
     "cli helper",
     "handlebars-i18n",
-    "handlebars",
-    "i18n-next",
+    "handlebars translation",
     "extract translations from i18next templates",
-    "handlebars-i18next"
+    "deepL automatic translation",
+    "i18next JSON"
   ],
   "author": "Florian Walzel",
   "license": "MIT",
@@ -35,16 +40,22 @@
   },
   "homepage": "https://github.com/fwalzel/handlebars-i18n-cli#readme",
   "dependencies": {
-    "esm": "^3.2.25",
-    "util": "^0.12.5"
+    "async-file-tried": "^1.2.1",
+    "axios": "^1.7.2",
+    "commander": "^12.1.0",
+    "deepl-node": "^1.13.0",
+    "dotenv": "^16.4.5",
+    "glob": "^11.0.0"
   },
   "devDependencies": {
-    "chai": "^4.3.6",
-    "chai-as-promised": "^7.1.1",
-    "coveralls": "3.1.1",
-    "istanbul": "^0.4.5",
+    "c8": "^10.1.2",
+    "chai": "^5.1.1",
+    "chai-as-promised": "^8.0.0",
+    "coveralls-next": "^4.2.1",
     "mocha": "^10.1.0",
-    "nyc": "^15.1.0",
-    "test-console": "^2.0.0"
+    "sinon": "^18.0.0",
+    "sinon-chai": "^4.0.0",
+    "test-console": "^2.0.0",
+    "typescript": "^5.7.2"
   }
 }