Skip to content

Latest commit

 

History

History
380 lines (276 loc) · 15.6 KB

README.md

File metadata and controls

380 lines (276 loc) · 15.6 KB

Hokeylització

Per què no puc executar tota la meva aplicació o lloc a través de Google Translate i obtenir una traducció bàsica en un altre idioma?

Ara pots!

El nom hokeylization és un acrònim, que significa "localització hokey"

És una mica hokey perquè és molt senzill: envia cadenes a Google Translate

I és senzill, però també molt potent. Té suport especial per a documents HTML, Plantilles HandlebarsJS, i fitxers Markdown.

Podeu traduir:

  • un objecte JavaScript que conté missatges
  • qualsevol nombre de fitxers o directoris, sempre recorrent directoris de manera recursiva

Llegeix això en un altre idioma

Aquest document README.md s'ha traduït, utilitzant la pròpia eina hokeylization, a cada idioma compatible amb Google Translate!

Estic segur que no és perfecte, però espero que sigui millor que res!

🇸🇦 Àrab 🇧🇩 bengalí 🇩🇪 Alemany 🇺🇸 Anglès 🇪🇸 Espanyol 🇫🇷 Francès 🇹🇩 Hausa 🇮🇳 Hindi 🇮🇩 indonesi 🇮🇹 italià 🇯🇵 Japonès 🇰🇷 coreà 🇮🇳 Marathi 🇵🇱 polonès 🇧🇷 portuguès 🇷🇺 Rus 🇰🇪 suahili 🇵🇭 Tagalog 🇹🇷 Turc 🇵🇰 Urdu 🇻🇳 vietnamita 🇨🇳 Xinès

📚 ... Tots els idiomes ...

Hi ha algun problema amb aquesta traducció del README?

Aquesta traducció particular de l'original README pot ser defectuós -- les correccions són molt benvingudes! Envieu una sol·licitud d'extracció a GitHub, o si no et sents còmode fent-ho, obre un problema

Quan creeu un nou problema de GitHub sobre una traducció, feu el següent:

  • incloure l'URL de la pàgina (copiar/enganxar des de la barra d'adreces del navegador)
  • inclou el text exacte que és incorrecte (copiar/enganxar des del navegador)
  • si us plau, descriu què està malament: la traducció és incorrecta? el format està trencat d'alguna manera?
  • Oferiu amablement un suggeriment d'una millor traducció o com s'hauria de formatar correctament el text
  • Gràcies!

Continguts

Font

Suport i finançament

Estic intentant ser un desenvolupador professional de programari de codi obert. Hi he estat treballant la indústria del programari durant molts anys, he creat empreses d'èxit i les he venut a empreses públiques. Recentment he perdut la meva feina, i realment no tinc cap altra feina preparada

Així que intentaré escriure programari útil i veure si funciona

Si us agrada utilitzar aquest programari, m'agradaria molt rebre fins i tot el més petita contribució mensual a través de Patreon

Gràcies!

Instal·lació

Per utilitzar l'eina de línia d'ordres, instal·leu-lo amb npm ' o yarn :

npm install -g hokeylization
yarn global add hokeylization

Per utilitzar-la com a biblioteca, instal·leu la versió lite , que és molt més petita:

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

A continuació, consulteu l'ajuda per a l'ordre hokey :

hokey --help
hokey -h

Voleu veure la sortida en el vostre idioma o en un altre idioma?

hokey intenta detectar l'idioma automàticament a partir de les variables d'entorn del vostre shell

Podeu forçar un idioma configurant la variable d'entorn LC_ALL :

LC_ALL=it hokey --help

Tingueu en compte que si heu instal·lat hokeylization-lite , l'ajuda d'ordres només està disponible en anglès

Configuració

Estableix la variable d'entorn GOOGLE_TRANSLATE_PROJECT_ID per identificar el teu projecte de Google Translate

Estableix la variable d'entorn GOOGLE_APPLICATION_CREDENTIALS a les credencials JSON que has baixat després d'esbrinar com funciona l'autenticació al núvol de Google (pot ser divertit)

Si esteu executant des del codi font, també podeu posar-los en un fitxer .env a la font directori, es carregaran en temps d'execució mitjançant dotenv

Traduint un fitxer de recurs de cadena JavaScript

La vostra taula de cadenes ha de estar en un fitxer JavaScript en una d'aquestes dues formes:

Exportació ES6:

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

Exportació CommonJS

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

Si aquest fitxer es deia myfile.en.js , podeu traduir-lo a l'espanyol i l'alemany amb:

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

El LANG de l'anterior és especial: és una paraula reservada en aquesta eina!

El LANG es substitueix pel codi d'idioma per als fitxers de sortida

Així, l'ordre anterior crea els fitxers:

myfile.es.js
myfile.de.js

L' -l / --languages és una llista separada per comes de codis d'idioma ISO admès per Google Translate

Si el fitxer de sortida ja existeix, s'examinarà per determinar quines claus ja existeixen. Les claus existents no es traduiran. Es generaran i s'afegiran traduccions de les claus que falten fins al final de l'objecte JS. Sempre es reescriu tot el fitxer.

Per forçar la retraducció de totes les claus, utilitzeu l' -f / --force

Traduir un directori de fitxers de text

També podeu traduir un directori de fitxers. hokeylization visitarà de manera recursiva tots fitxer al directori i executeu-ne el contingut mitjançant Google Translate i deseu la sortida a un fitxer de nom idèntic en un arbre de directoris independent

Quan l'objectiu de la traducció és un directori, aquest mode està habilitat

L' -o / --outfile especifica el directori de sortida

GRAN ADVERTIMENT: quan traduïu directoris, NO especifiqueu un directori de sortida que es troba dins del vostre directori d'entrada! Si fas això, faràs:

  • induir recursivitat infinita
  • Augmenta la teva factura de Google
  • ompliu el vostre disc
  • divertir-se menys

Aquí teniu un exemple del que no fer:

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

Quan s'executa, els fitxers traduïts s'escriuen a templates/es i, per tant, esdevenen nous fitxers font per traduir, ja que es troben sota templates/ -- aquest procés continua per sempre, no ho facis!

Ús correcte

D'acord, suposem que teniu algunes plantilles de correu electrònic en un directori:

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 traduir tot això a l'espanyol i l'alemany, executeu:

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

A l'anterior, LANG és una paraula reservada i es substituirà pel codi d'idioma ISO

Què passa quan s'executa l'anterior:

  • Es crearan els directoris templates/email/es i templates/email/de (si no existeixen)
  • Tots els fitxers de templates/email/en es traduiran a l'espanyol i l'alemany
  • Els fitxers de sortida existents no es regeneraran tret que utilitzeu -f / --force
  • Acabaràs amb una estructura de directoris i fitxers idèntics a es i de com els que tens a en

Altres opcions

Carrera en sec

Passeu -n / --dry-run per mostrar el que es faria, però en realitat no feu cap trucada a l'API ni escriviu cap fitxer

Força

Passeu -f / --force per regenerar sempre les traduccions, encara que ja existeixin

Coincidència

Passeu -m / --match per limitar els fitxers processats quan s'executen en mode directori

És possible que no sempre vulgueu traduir cada fitxer del vostre directori d'origen al directori de destinació

El valor de l' -m / --match és una expressió regular (compte amb les regles de cites de shell!) que especifica quins fitxers s'han de traduir

En cas de dubte, podeu combinar aquesta opció amb -n / --dry-run per veure quins fitxers es traduirien

Exclou

De vegades, el vostre -m coincideix amb massa fitxers. Utilitzeu l' -e / --excludes per excloure explícitament fitxers que d'altra manera haurien coincidit

Podeu llistar diverses execucions regulars, separades per espais

Un ús comú seria: --excludes node_modules dist \.git build tmp

Manillars

Les cadenes a traduir poden contenir plantilles {{ handlebars }} , amb dues o tres claus.

Probablement NO vulgueu que es tradueixin les coses dins d'aquestes plantilles

Passeu la -H / --handlebars --handlebarsi qualsevol cosa dins de{{ ... }}` no es traduirà

Reducció

Markdown no és ni text ni html, de manera que Google Translate hi té algunes dificultats

El -M / --markdown permet un maneig especial dels fitxers de reducció

Amb els fitxers de marcatge, si no feu servir el -M , probablement trobareu aquests problemes:

  • Enllaços trencats. A la traducció, apareix un caràcter d'espai després d'acabar la descripció d'un enllaç de reducció (amb ] ), però abans que comenci el seu enllaç de destinació (amb ( ). Això fa que el marcador es mostri incorrectament i l'enllaç està trencat en visualitzar el document.
  • Els blocs de codi es tradueixen. Google Translate no sap què es considera codi i què no
  • Espaiat incorrecte per als blocs de codi sagnats. L'espaiat és difícil de conservar en la traducció
  • Les coses dins de backticks es traduiran, quan gairebé sempre voleu que siguin valors literals

Quan el -M / --markdown està habilitat:

  • El patró ]( es condensarà a ]( arreglant així els enllaços de reducció trencats
  • Es col·locarà un embolcall "sense traducció" al voltant dels blocs de codi amb sagnat, conservant el sagnat adequat i assegurant que no es tradueixin
  • Es col·locarà un embolcall "sense traducció" al voltant del text dins dels backticks per assegurar-se que no es tradueixin

Process-as

Normalment, tot es processa com a text sense format

Si el vostre contingut és HTML, es trencarà tret que passi l'opció -p html / --process-as html

Filtre

Per als aventurers: quan processeu fitxers en un directori, podeu passar l' -F / --filter per filtrar la sortida abans que s'escriu al sistema de fitxers

El valor d'aquesta opció ha de ser una ruta d'accés a un fitxer JS que exporti una funció anomenada filter

La funció filter ha de ser async " perquè s'hi cridarà await

Abans que els fitxers s'escriguin al disc, tot el contingut del fitxer es passarà a la funció filter com a cadena

El valor de retorn de la funció filter és el que realment s'escriurà a l'emmagatzematge

Així, tens un control total sobre el que finalment s'escriurà

L'script filter es buscarà a les ubicacions següents (amb .js s'adjuntarà al filtre nom, tret que ja acabi en .js )

Paràmetres de filtre

La cadena filter pot ser diverses paraules. En aquest cas, la primera paraula és el nom del filtre i les paraules restants es passaran com a arguments a la funció filter

Ajuda

Utilitzeu -h / --help per mostrar l'ajuda

Ordres per lots JSON

Amb l' -j / --json , podeu executar diverses ordres coordinades hokey

Per convenció, aquest fitxer s'anomena hokey.json , però podeu anomenar-lo com vulgueu

Si passeu un directori com a opció -j,hokeybuscarà unhokey.json` en aquest directori

El fitxer JSON ha de contenir un objecte. Dins d'aquest objecte, els seus noms de propietat són els mateixos que les opcions de la línia d'ordres, més una propietat addicional anomenada hokey

La propietat hokey és una matriu d'ordres per executar. Les propietats declarades dins d'aquestes ordres ho faran anul·la qualsevol declaració duplicada a l'objecte extern.

Dins de cada objecte de la matriu hokey , hauríeu d'especificar un name i els fitxers d'entrada i sortida

Aquí teniu un exemple d'un 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"
      }
    ]
}

Fitxers d'entrada múltiples

Passeu una matriu de camins de fitxer com a infiles en comptes d'un sol camí infile , com en aquest exemple:

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

Índexs

Quan es tradueix a molts idiomes, hokey pot crear un fitxer d'índex que enumera totes les traduccions fetes i ofereix enllaços a ells

Quan genereu índexs, només podeu tenir una font d'entrada

Passeu l' -I / --index , el valor és on es generarà el fitxer d'índex, que pot ser un fitxer o un directori. Si és un directori, s'utilitzarà un nom de fitxer per defecte, basat en la plantilla (vegeu més avall)

Utilitzeu -A / --index-template per determinar com es formatea la sortida de l'índex. Podeu especificar "html", 'markdown', 'text' o la ruta del fitxer a la vostra pròpia plantilla HandlebarsJS

Si especifiqueu la vostra pròpia plantilla, també heu d'especificar un fitxer (no un directori) per a -I / --index opció

Passeu-vos una estona divertida traduint idiomes!