Skip to content

Latest commit

 

History

History
380 lines (276 loc) · 15.7 KB

README.md

File metadata and controls

380 lines (276 loc) · 15.7 KB
Raw

Hokeylizzazione

Perché non posso eseguire l'intera app o il sito tramite Google Translate e ottenere una traduzione di base in un'altra lingua?

Ora puoi!

Il nome hokeylization è un portmanteau, che significa "localizzazione hokey"

È un po' strano perché è molto semplice: invia stringhe a Google Translate

Ed è semplice, ma anche molto potente. Ha un supporto speciale per documenti HTML, modelli HandlebarsJS, e file Markdown.

Puoi tradurre:

  • un oggetto JavaScript contenente messaggi
  • qualsiasi numero di file o directory, attraversando sempre le directory in modo ricorsivo

Leggi questo in un'altra lingua

Questo documento README.md è stato tradotto, utilizzando lo stesso strumento di hokeylization, in ogni lingua supportata da Google Translate!

Sono certa che non sia perfetto, ma spero sia meglio di niente!

🇸🇦 Arabo 🇧🇩 Bengali 🇩🇪 Tedesco 🇺🇸 Inglese 🇪🇸 Spagnolo 🇫🇷 Francese 🇹🇩 Hausa 🇮🇳 Hindi 🇮🇩 Indonesiano 🇮🇹 Italiano 🇯🇵 Giapponese 🇰🇷 Coreano 🇮🇳 Marathi 🇵🇱 Polacco 🇧🇷 Portoghese 🇷🇺 Russo 🇰🇪 Swahili 🇵🇭 Tagalog 🇹🇷 Turco 🇵🇰 Urdu 🇻🇳 Vietnamita 🇨🇳 Cinese

📚 ... Tutte le lingue ...

C'è un problema con questa traduzione del README?

Questa particolare traduzione dell'originale README potrebbe essere difettoso -- le correzioni sono molto gradite! Si prega di inviare una richiesta pull su GitHub, o se non ti senti a tuo agio nel farlo, apri un problema

Quando crei un nuovo problema GitHub su una traduzione, esegui:

  • includi l'URL della pagina (copia/incolla dalla barra degli indirizzi del browser)
  • includi il testo esatto che è sbagliato (copia/incolla dal browser)
  • per favore descrivi cosa c'è che non va -- la traduzione è errata? la formattazione è rotta in qualche modo?
  • offrire gentilmente un suggerimento per una traduzione migliore o come formattare correttamente il testo
  • Grazie!

Contenuti

Fonte

Supporto e finanziamento

Sto cercando di essere uno sviluppatore di software open source professionista. Ci ho lavorato nell'industria del software per molti anni, ho avviato società di successo e le ho vendute a società pubbliche. Recentemente ho perso il lavoro, e non ho altro in programma

Quindi proverò a scrivere un software utile e vedere se funziona

Se ti piace usare questo software, sarei così felice di ricevere anche il il più piccolo contributo mensile tramite Patreon

Grazie!

Installazione

Per utilizzare lo strumento da riga di comando, installa usando npm o yarn :

npm install -g hokeylization
yarn global add hokeylization

Per usarla come libreria, installa la versione lite , che è molto più piccola:

npm install -g hokeylization-lite
yarn global add hokeylization-lite

Quindi guarda la guida per il comando hokey :

hokey --help
hokey -h

Vuoi vedere l'output nella tua lingua o in un'altra lingua?

hokey prova a rilevare automaticamente la lingua dalle variabili d'ambiente della tua shell

Puoi forzare una lingua impostando la variabile d'ambiente LC_ALL :

LC_ALL=it hokey --help

Nota che se hai installato hokeylization-lite , la guida ai comandi è disponibile solo in inglese

Impostare

Imposta la variabile di ambiente GOOGLE_TRANSLATE_PROJECT_ID per identificare il tuo progetto Google Translate

Imposta la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS sulle credenziali JSON che hai scaricato dopo aver capito come funziona l'autenticazione su Google cloud (può essere divertente)

Se stai eseguendo dal codice sorgente, puoi anche inserirli in un file .env nel sorgente directory verranno caricati in fase di esecuzione tramite dotenv

Traduzione di un file di risorse stringa JavaScript

La tua tabella di stringhe deve essere in un file JavaScript in una di queste due forme:

Esportazione ES6:

export default {
  string_key: "some value",
  another_key: "another value",
  ... more keys ...
}

Esportazione CommonJS

module.exports = {
  string_key: "some value",
  another_key: "another value",
  ... more keys ...
}

Se questo file è stato chiamato myfile.en.js , puoi tradurlo in spagnolo e tedesco con:

hokey -l es,de -o myfile.LANG.js myfile.en.js

Il LANG in quanto sopra è speciale -- è una parola riservata in questo strumento!

Il LANG viene sostituito con il codice della lingua per i file di output

Quindi il comando sopra crea i file:

myfile.es.js
myfile.de.js

L' -l / --languages è un elenco di codici lingua ISO separati da virgole supportato da Google Translate

Se il file di output esiste già, verrà esaminato per determinare quali chiavi esistono già. Le chiavi esistenti non verranno tradotte. Le traduzioni per le chiavi mancanti verranno generate e aggiunte alla fine dell'oggetto JS. L'intero file viene sempre riscritto.

Per forzare la ritraduzione di tutte le chiavi, usa l' -f / --force

Traduzione di una directory di file di testo

Puoi anche tradurre una directory di file. l'hokeylizzazione visiterà ricorsivamente ogni file nella directory ed esegui il suo contenuto tramite Google Translate e salva l'output in un file con lo stesso nome in un albero di directory separato

Quando la destinazione della tua traduzione è una directory, questa modalità è abilitata

L' -o / --outfile specifica la directory di output

GRANDE AVVISO: durante la traduzione delle directory, NON specificare una directory di output che è all'interno della tua directory di input! Se lo fai, dovrai:

  • indurre una ricorsione infinita
  • aumenta la tua fattura di Google
  • riempi il tuo disco
  • divertiti di meno

Ecco un esempio di cosa non fare:

hokey -l es -o templates/es templates # <--- DON'T DO THIS!

Quando viene eseguito, i file tradotti vengono scritti in templates/es , e quindi diventano nuovi file sorgente da tradurre, poiché si trovano in templates/ -- questo processo continua per sempre, non farlo!

Uso corretto

OK, supponiamo che tu abbia alcuni modelli di email in una directory:

templates/email/en/welcome.txt
templates/email/en/welcome.html
templates/email/en/verify-account.txt
templates/email/en/verify-account.html
templates/email/en/reset-password.txt
templates/email/en/reset-password.html

Per tradurre tutto questo in spagnolo e tedesco, esegui:

hokey -l es,de -o templates/email/LANG templates/email/en

In quanto sopra, LANG è una parola riservata e verrà sostituita con il codice della lingua ISO

Cosa succede quando viene eseguito quanto sopra:

  • Verranno create le directory templates/email/es e templates/email/de (se non esistono)
  • Ogni file in templates/email/en sarà tradotto in spagnolo e tedesco
  • I file di output esistenti non verranno rigenerati a meno che non si utilizzi -f / --force
  • Ti ritroverai con una struttura di directory e file identici all'interno di es e de come quelli di en

Altre opzioni

Funzionamento a secco

Passa -n / --dry-run per visualizzare cosa sarebbe stato fatto, ma in realtà non effettuare chiamate API o scrivere file

Forza

Passa -f / --force per rigenerare sempre le traduzioni, anche se esistono già

Incontro

Passa -m / --match per limitare i file elaborati durante l'esecuzione in modalità directory

Potresti non voler sempre tradurre ogni file nella tua directory di origine nella tua directory di destinazione

Il valore -m / --match è una regex (attenzione alle regole di citazione della shell!) che specifica quali file devono essere tradotti

In caso di dubbio, puoi combinare questa opzione con -n / --dry-run per vedere quali file verrebbero tradotti

Esclude

A volte il tuo -m corrisponde a troppi file. Usa l' -e / --excludes per escludere esplicitamente file che altrimenti avrebbero corrisposto

Puoi elencare più espressioni regolari, separate da spazi

Un uso comune sarebbe: --excludes node_modules dist \.git build tmp

Manubri

Le stringhe da tradurre potrebbero contenere modelli {{ handlebars }} , con due o tre parentesi graffe

Probabilmente NON vuoi che le cose all'interno di quei modelli vengano tradotte

Passa il -H / --handlebars e qualsiasi cosa all'interno di {{ ... }} non verrà tradotta

Ribasso

Markdown non è né testo né html, quindi Google Translate ha alcune difficoltà con esso

Il -M / --markdown abilita una gestione speciale per i file markdown

Con i file markdown, se non usi il flag -M , probabilmente troverai questi problemi:

  • Collegamenti interrotti. Nella traduzione, viene visualizzato uno spazio dopo che la descrizione di un collegamento markdown termina (con ] ) ma prima che il suo collegamento di destinazione inizi (con ( ). Ciò causa un rendering errato del markdown e il collegamento è rotto durante la visualizzazione del documento.
  • I blocchi di codice vengono tradotti. Google Translate non sa cosa markdown considera il codice e cosa no
  • Spaziatura errata per i blocchi di codice rientrati. La spaziatura è difficile da preservare nella traduzione
  • Le cose all'interno di backticks verranno tradotte, quando quasi sempre vorrai che siano valori letterali

Quando il -M / --markdown è abilitato:

  • Il pattern ]( sarà condensato in ]( così i link di markdown interrotti
  • Un wrapper "no translate" verrà posizionato attorno ai blocchi di codice rientrati, preservando la corretta indentazione e assicurando che non vengano tradotti
  • Un wrapper "nessuna traduzione" verrà posizionato attorno al testo all'interno di backticks per garantire che non vengano tradotti

Elabora come

Normalmente tutto viene elaborato come testo normale

Se il tuo contenuto è HTML, verrà alterato a meno che tu non passi l' -p html / --process-as html

Filtro

Per gli avventurosi: durante l'elaborazione di file in una directory, puoi passare l' -F / --filter --filter` per filtrare l'output prima che venga scritto nel filesystem

Il valore di questa opzione deve essere un percorso di un file JS che esporta una funzione denominata filter

La funzione filter deve essere async perché su di essa verrà chiamato await

Prima che i file vengano scritti su disco, l'intero contenuto del file verrà passato alla funzione filter come una stringa

Il valore restituito dalla funzione filter è ciò che verrà effettivamente scritto nella memoria

Quindi, hai il controllo totale su ciò che verrà finalmente scritto

Lo script filter verrà cercato nelle seguenti posizioni (con .js verrà aggiunto al filtro nome, a meno che non finisca già con .js )

Parametri del filtro

La stringa filter può essere composta da più parole. In questo caso, la prima parola è il nome del filtro e le parole rimanenti verranno passate come argomenti alla funzione filter

Aiuto

Usa -h / --help per mostrare la guida

Comandi batch JSON

Con l' -j / --json , puoi eseguire più comandi hokey coordinati

Per convenzione questo file è chiamato hokey.json , ma puoi nominarlo come preferisci

Se passi una directory come opzione -j,hokeycercherà unhokey.json` in quella directory

Il file JSON deve contenere un oggetto. All'interno di quell'oggetto, i suoi nomi di proprietà sono gli stessi di le opzioni della riga di comando, più una proprietà aggiuntiva denominata hokey

La proprietà hokey è un array di comandi da eseguire. Le proprietà dichiarate all'interno di questi comandi lo faranno ignorare eventuali dichiarazioni duplicate nell'oggetto esterno.

All'interno di ogni oggetto hokey , dovresti specificare un name e i file di input e output

Ecco un esempio di hokey.json

{
    "inputLanguage": "en",
    "languages": "es,fr,ja", # can also be an array of strings
    "force": false,
    "match": null,
    "processAs": null,
    "excludes": ["exclude-1", "exclude-2"],
    "handlebars": false,
    "markdown": false,
    "regular": false,
    "dryRun": false,
    "filter": "theFilter.js",
    "hokey": [
      {
        "name": "locale names",
        "infile": "messages/locales_en.js",
        "outfile": "messages/locales_LANG.js",
        "handlebars": true
      },
      {
        "name": "CLI messages",
        "infile": "messages/en_messages.js",
        "outfile": "messages/LANG_messages.js",
        "handlebars": true
      },
      {
        "name": "README",
        "infile": "README.md",
        "outfile": "lang/LANG/",
        "excludes": ["lang/", "node_modules/", "\\.git/", "tmp/"],
        "filter": "relativizeMarkdownLinks lang",
        "markdown": true,
        "index": "lang/README.md"
      }
    ]
}

File di input multipli

Passa un array di percorsi di file come infiles invece di un singolo percorso infile , come in questo esempio:

{
  ... [
    {
      "name": "my docs",
      "infiles": ["README.md", "INSTALL.md", "TUTORIAL.md"],
      "outfile": "docs/LANG/",
      "markdown": true
  ]
}

Indici

Quando si traduce in molte lingue, hokey può creare un file di indice che elenca tutte le traduzioni effettuate e fornisce collegamenti ad essi

Durante la generazione degli indici, puoi avere una sola sorgente di input

Passa l' -I / --index , il valore è dove verrà generato il file di indice, che può essere un file o una directory. Se è una directory, verrà utilizzato un nome file predefinito, basato sul modello (vedi sotto)

Usa -A / --index-template per determinare come è formattato l'output dell'indice. Puoi specificare 'html', 'markdown', 'text' o il percorso del file del tuo modello HandlebarsJS

Se specifichi il tuo modello, devi anche specificare un file (non una directory) per -I / --index opzione

Divertiti a tradurre le lingue!