README.md

I-Hokeylization

Kungani ngingakwazi ukusebenzisa lonke uhlelo lwami lokusebenza noma isayithi nge-Google Translate futhi ngithole ukuhumusha okuyisisekelo ngolunye ulimi?

Manje, ungakwazi!

Igama elithi hokeylization liyi-portmanteau, okusho ukuthi 'indawo ye-hokey'

I-hokey ngandlela-thile ngoba ilula kakhulu: ithumela uchungechunge ku-Google Translate

Futhi ilula, kodwa futhi inamandla kakhulu. Inokusekelwa okukhethekile kwemibhalo ye-HTML, HandlebarsJS izifanekiso, kanye namafayela Markdown.

Ungakwazi ukuhumusha:

• into ye-JavaScript equkethe imilayezo
• Noma iyiphi inombolo yamafayela noma izinkomba, ehlala enqamula uhla lwemibhalo ngokuphindaphindiwe

Funda lokhu ngolunye ulimi

Lo mbhalo we-README.md uhunyushwe, kusetshenziswa ithuluzi le-hokeylization ngokwalo, kwaba zonke izilimi zisekelwa i-Google Translate!

Ngiqinisekile ukuthi ayiphelele, kodwa ngethemba ukuthi ingcono kunalutho!

🇸🇦 Arabic 🇧🇩 Bengali 🇩🇪 isiJalimane 🇺🇸 IsiNgisi 🇪🇸 Spanish 🇫🇷 French 🇹🇩 Hausa 🇮🇳 Hindi 🇮🇩 isi-Indonesian 🇮🇹 isiNtaliyane 🇯🇵 Japanese 🇰🇷 Korean 🇮🇳 Marathi 🇵🇱 Polish 🇧🇷 isi-Portuguese 🇷🇺 Russian 🇰🇪 Swahili 🇵🇭 Tagalog 🇹🇷 Turkish 🇵🇰 Urdu 🇻🇳 Vietnamese 🇨🇳 isiShayina

📚 ... Zonke Izilimi ...

Ingabe kunenkinga ngalokhu kuhunyushwa kwe- README?

Lokhu kuhunyushwa koqobo README ingase ibe namaphutha -- izilungiso zamukelekile kakhulu! Sicela uthumele isicelo sokudonsa ku-GitHub, noma uma ungakhululekile ukwenza lokho, vula inkinga

Uma udala udaba olusha lwe-GitHub mayelana nokuhumusha, sicela wenze:

• faka i-URL yekhasi (kopisha/unamathisele kubha yekheli lesiphequluli)
• faka phakathi nombhalo ongalungile (kopisha/unamathisele esipheqululini)
• ngicela uchaze ukuthi yini engalungile -- ingabe ukuhumusha akulungile? ingabe ukufometha kwephukile ngandlela thile?
• ngomusa nikeza isiphakamiso senguqulo engcono kakhulu, noma indlela umbhalo okufanele ufomethwe kahle ngayo
• Ngiyabonga!

Okuqukethwe

• Umthombo
• Ukwesekwa Noxhaso
• Ukufakwa
• Ukumisa
• Kuhunyushwa ifayela lesisetshenziswa sochungechunge lwe-JavaScript
• Ukuhumusha uhla lwemibhalo lwamafayela ombhalo
• [Ezinye izinketho](#Ezinye izinketho)
• Imiyalo yenqwaba ye-JSON

Umthombo

• hokeylization ku-GitHub
• hokeylization ku-npm

Ukusekela Nokuxhaswa Ngezimali

Ngizama ukuba umthuthukisi wesofthiwe yomthombo ovulekile ochwepheshe. Bengisebenza e imboni yesofthiwe iminyaka eminingi, ngiqale izinkampani eziphumelelayo futhi ngazithengisa ezinkampanini zomphakathi. Muva nje ngilahlekelwe umsebenzi, futhi anginawo omunye umsebenzi engiwulandelayo

Ngakho-ke ngizozama ukubhala isoftware ewusizo futhi ngibone ukuthi lokho kuyasebenza

Uma ujabulela ukusebenzisa le software, ngingajabula kakhulu ukuthola noma okuncane kakhulu umnikelo wanyanga zonke nge-Patreon

Ngiyabonga!

Ukufakwa

Ukuze usebenzise ithuluzi lomugqa womyalo, faka usebenzisa npm noma yarn :

npm install -g hokeylization
yarn global add hokeylization

Ukuze uyisebenzise njengomtapo wolwazi, faka inguqulo lite , encane kakhulu:

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

Bese ubheka usizo lomyalo othi hokey :

hokey --help
hokey -h

Ingabe ufuna ukubona okukhiphayo ngolimi lwakho noma ngolunye ulimi?

hokey izama ukuthola ulimi ngokuzenzakalelayo kusuka kokuguquguqukayo kwemvelo yegobolondo lakho

Ungaphoqa ulimi ngokusetha LC_ALL okuguquguqukayo kwemvelo:

LC_ALL=it hokey --help

Qaphela ukuthi uma ufake hokeylization-lite , usizo lomyalo lutholakala kuphela ngesiNgisi

Setha

Setha GOOGLE_TRANSLATE_PROJECT_ID okuhluka kwemvelo ukuze uhlonze iphrojekthi yakho ye-Google Translate

Setha ukuguquguquka kwemvelo kokuthi GOOGLE_APPLICATION_CREDENTIALS ye-JSON oyilandile ngemuva kokuthola ukuthi ukuqinisekiswa kusebenza kanjani kumafu we-Google (kungaba mnandi)

Uma usebenzisa ikhodi yomthombo, ungaphinda ubeke lokhu kufayela .env emthonjeni uhla lwemibhalo luzolayishwa ngesikhathi sokusebenza nge-dotenv

Ukuhumusha ifayela lensiza yochungechunge lwe-JavaScript

Ithebula lakho leyunithi yezinhlamvu kumele libe kufayela le-JavaScript kwelinye lalawa mafomu amabili:

Ukuthunyelwa kwe-ES6:

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

Ukuthunyelwa kwe-CommonJS

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

Uma leli fayela beliqanjwe ngokuthi myfile.en.js , ungakwazi ukulihumushela kwisiSpanishi nesiJalimane ngokuthi:

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

I LANG engenhla ikhethekile -- igama eligodliwe kuleli thuluzi!

I LANG ithathelwa indawo ikhodi yolimi yamafayela okukhiphayo

Ngakho umyalo ongenhla udala amafayela:

myfile.es.js
myfile.de.js

Inketho ethi -l / --languages oluhlukaniswe ngokhefana lwamakhodi olimi e-ISO isekelwa i-Google Translate

Uma ifayela lokuphumayo selivele likhona, lizohlolwa ukuze kutholwe ukuthi yibaphi okhiye asebevele bakhona. Okhiye abakhona ngeke bahunyushwe. Ukuhunyushwa kokhiye abangekho kuzokwenziwa futhi kwengezwe kuze kube sekupheleni kwento ye-JS. Ifayela lonke lihlala libhalwa kabusha.

Ukuphoqa ukuhumusha kabusha bonke okhiye, sebenzisa -f / --force

Ukuhumusha uhla lwemibhalo lwamafayela ombhalo

Ungakwazi futhi ukuhumusha uhla lwemibhalo lwamafayela. i-hokeylization izovakashela ngokuphindaphindiwe njalo ifayela ohlwini lwemibhalo bese uqhuba elikuqukethe nge-Google Translate, bese ulondoloza okukhiphayo efayeleni elinegama elifanayo esihlahleni sohla lwemibhalo esihlukile

Uma okuqondiwe kokuhumusha kwakho kuwuhla lwemibhalo, le modi inikwa amandla

Inketho ethi -o / --outfile icacisa uhla lwemibhalo lokuphumayo

ISIXWAYISO ESIKHULU: Uma uhumusha izinkomba, UNGAKUNGAZI cacisa uhla lwemibhalo oluphumayo lokho kungaphakathi kwemibhalo yakho yokufaka! Uma wenza lokhu, uzo:

• yenza ukuphindaphinda okungapheli
• yenza ibhili lakho le-Google
• Gcwalisa idiski yakho
• ujabule kancane

Nasi isibonelo salokho okungamelwe ukwenze:

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

Uma lokhu kusebenza, amafayela ahunyushiwe abhalwa templates/es , kanjalo abe masha amafayela omthombo azohumushwa, njengoba angaphansi templates/ -- le nqubo iyaqhubeka kuze kube phakade, ungakwenzi!

Ukusetshenziswa okulungile

Kulungile, ake sithi unezifanekiso ze-imeyili kuhla lwemibhalo:

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

Ukuze uhumushele konke lokhu kusi-Spanish nesiJalimane, sebenzisa:

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

Okungenhla, LANG igama eligodliwe futhi lizothathelwa indawo ikhodi yolimi ye-ISO

Kwenzekani uma okungenhla kusebenza:

• Izikhombisi templates/email/eskanyetemplates/email/de` zizokwakhiwa (uma zingekho)
• Lonke ifayela kokuthi templates/email/en kwisi-Spanish nesiJalimane
• Amafayela aphumayo akhona ngeke enziwe kabusha ngaphandle uma usebenzisa -f / --force
• Uzogcina unesakhiwo sohla lwemibhalo olufanayo namafayela ngaphakathi es kanye de njengoba unawo ngaphansi kokuthi en

Ezinye izinketho

Ukugijima okomile

Dlula -n / --dry-run ukuze ubonise lokho okuzokwenziwa, kodwa empeleni ungenzi noma yiziphi izingcingo ze-API noma ubhale noma yimaphi amafayela.

Force

Dlula -f / --force ukuze uhlale uvuselela ukuhumusha, noma ngabe sekukhona kakade

Ukufana

Dlula -m / --match ukuze ukhawulele amafayela acutshungulwe lapho esebenza kumodi yohlu lwemibhalo

Ungase ungafuni njalo ukuhumusha onke ifayela kuhla lwemibhalo lwakho oluwumthombo kuya kunkomba yakho oyiqondise

Inani -m / --match i-regex (qaphela imithetho yokucaphuna igobolondo!) ecacisayo imaphi amafayela okufanele ahunyushwe

Uma ungabaza, ungakwazi ukuhlanganisa le nketho nokuthi -n / --dry-run ukuze ubone ukuthi imaphi amafayela azohumushwa.

Ayifaki

Kwesinye isikhathi -m yakho ifana namafayela amaningi kakhulu. Sebenzisa -e / --excludes ukuze ukhiphe ngokusobala amafayela obekungenjalo afane

Ungaklelisa ama-regex amaningi, ahlukaniswe izikhala

Ukusetshenziswa okuvamile kungaba: --excludes node_modules dist \.git build tmp

Izibambo

Iyunithi yezinhlamvu okufanele ihumushwe ingase ibe nezifanekiso {{ handlebars }} , okungaba ngabakaki abagoqekile ababili noma abathathu

Cishe AWUFUNI ukuthi izinto ezingaphakathi kwalezo zifanekiso zihunyushwe

Dlula -H / --handlebars , futhi noma yini engaphakathi kokuthi {{ ... }} ngeke ihunyushwe

Markdown

I-Markdown akuwona umbhalo noma i-html, ngakho-ke i-Google Translate inobunzima obuthile ngayo

-M / --markdown amandla ukuphathwa okukhethekile kwamafayela okumaka

Ngamafayela okubeka phansi, uma ungasebenzisi ifulegi -M , cishe uzothola lezi zinkinga:

• Izixhumanisi eziphukile. Ekuhumusheni, kuvela uhlamvu lwesikhala ngemva kokuphela kwencazelo yesixhumanisi sokubeka phansi (nokuthi ] ) kodwa ngaphambi kokuthi isixhumanisi sayo esiqondiswe kuso siqale (ngokuthi ( ). Lokhu kubangela ukuthi ukubeke phansi kunikezwe ngokungalungile, kanye nesixhumanisi iphukile uma ubuka idokhumenti.
• Amabhulokhi ekhodi ahunyushwa. I-Google Translate ayazi ukuthi i-markdown icabangani ngekhodi nokuthi yini engayazi
• Isikhala esingalungile samabhulokhi amakhodi ahlehlisiwe. Isikhala sinzima ukusigcina ekuhumusheni
• Izinto ezingaphakathi kokuthi backticks zizohunyushwa, lapho cishe uhlale ufuna ukuthi abe amanani angokoqobo

Uma -M / --markdown :

• Iphethini ]( izofinyezwa ukuze ithi ]( ngaleyo ndlela kulungiswe izixhumanisi zokumaka eziphukile *Isembozo esithi "no translate" sizobekwa eduze kwamabhulokhi amakhodi ahlehlisiwe, alondoloze ukuhlehlisa okulungile nokuqinisekisa ukuthi awahunyushwa *Isembozo esithi "no translate" sizobekwa phakathi kombhalo phakathi backticks ukuze kuqinisekiswe ukuthi awahunyushwa

Inqubo-njenge

Ngokuvamile yonke into icutshungulwa njengombhalo ongenalutho

Uma okuqukethwe kwakho kuyi-HTML, kuzokonakala ngaphandle uma udlula -p html / --process-as html

Hlunga

Okwesikhashana: lapho ucubungula amafayela ohlwini lwemibhalo, ungadlula -F / --filter ukuhlunga okukhiphayo ngaphambi kokuthi kubhalwe ohlelweni lwefayela

Inani lale nketho kufanele libe indlela eya efayeleni le-JS elithumela ngaphandle umsebenzi okuthiwa filter

Umsebenzi filter kumelwe async ngoba await kuwo

Ngaphambi kokuthi amafayela abhalwe kudiski, konke okuqukethwe kwefayela kuzodluliselwa kumsebenzi filter njengeyunithi yezinhlamvu

Inani lokubuyisela elisuka filter isitoreji

Ngakho-ke, uyakwazi ukulawula lokho okuzobhalwa ekugcineni

Iskripthi filter sizobhekwa ezindaweni ezilandelayo (ene .js esihlungini igama, ngaphandle uma .js )

• Inkomba yamanje
• Uhla lwemibhalo .hokey-filters ngaphakathi kohla lwemibhalo lwamanje
• Uhla lwemibhalo ${HOME}/.hokey-filters , lapho ${HOME} kuwuhlu lwamanje lwasekhaya lomsebenzisi
• Uhlu olwakhelwe ngaphakathi lwemibhalo yezihlungi

Amapharamitha wesihlungi

Iyunithi yezinhlamvu filter ingaba amagama amaningi. Kulokhu, igama lokuqala igama lokuhlunga, futhi amagama asele azodluliswa njengama-agumenti kumsebenzi filter

Usizo

Sebenzisa -h / --help ukuze ubonise usizo

Imiyalo yenqwaba ye-JSON

-j / --json , ungasebenzisa imiyalo eminingi edidiyelwe hokey

Ngokwesimiso leli fayela libizwa ngokuthi hokey.json , kodwa ungakwazi ukusho noma yini oyifunayo

Uma uphasa uhla lwemibhalo njengenketho ethi -j , hokey izobheka hokey.json lwemibhalo.

Ifayela le-JSON kufanele liqukathe into eyodwa. Ngaphakathi kwaleyo nto, amagama ezakhiwo zayo ayafana izinketho zomugqa womyalo, kanye nempahla eyodwa eyengeziwe ebizwa ngokuthi hokey

Indawo ethi hokey isetshenziswe. Izakhiwo ezimenyezelwe ngaphakathi kwale miyalo zizo khipha noma yiziphi izimemezelo eziyimpinda entweni engaphandle.

Ngaphakathi kwento ngayinye ohlwini lwe- hokey , kufanele ucacise name , kanye namafayela okokufaka nokukhiphayo.

Nasi isibonelo se 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"
      }
    ]
}

Amafayela okokufaka amaningi

Dlula uxhaxha lwezindlela zefayela njengokuthi infiles esikhundleni somzila owodwa infile , njengakulesi sibonelo:

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

Izinkomba

Lapho uhumushela ezilimini eziningi, hokey ingakha ifayela lenkomba elibonisa zonke izinguqulo ezenziwe futhi inikeza izixhumanisi kubo

Lapho ukhiqiza izinkomba, ungaba nomthombo owodwa kuphela wokufaka

Dlula -I / --index , inani yilapho ifayela lenkomba lizokhiqizwa khona, okungaba ifayela noma uhla lwemibhalo. Uma kuwuhla lwemibhalo, kuzosetshenziswa igama lefayela elizenzakalelayo, ngokusekelwe kusifanekiso (bona ngezansi)

Sebenzisa -A / --index-template ukuze unqume ukuthi okukhiphayo kwenkomba kufomethwe kanjani. Ungacacisa 'html', 'markdown', 'text', noma indlela yefayela eya HandlebarsJS isifanekiso sakho

Uma ucacisa isifanekiso sakho, kufanele ucacise ifayela (hhayi uhla lwemibhalo) le -I / --index inketho

Yiba nesikhathi esimnandi sokuhumusha izilimi!