npm scenarijai sujungia terminalo komandų rinkinį, kurį galite naudoti „JavaScript“ projekto užduotims automatizuoti. Jie taip pat suteikia nuoseklų komandų vykdymo būdą įvairiose aplinkose.
Galite nustatyti npm scenarijus pakete.json faile, paleisti juos komandinėje eilutėje ir naudoti daugybę parinkčių, kad sukonfigūruotumėte jų elgesį.
npm scenarijų nustatymas pakete.json faile
Paprastai npm scenarijus apibrėžiate pakete.json faile, esančiame jūsų JavaScript projekto šaknyje. Tai nėra būtina, nes galite vykdyti scenarijus iš kitų failų, tačiau paketas.json leidžia lengviau pasiekti ir valdyti scenarijus.
Atminkite, kad kūrimo aplinkoje turite įdiegti „npm“ ir „Node“, kad galėtumėte tęsti. Štai keletas naudingų straipsnių:
- Kaip įdiekite Node.js ir npm sistemoje Windows.
- Kaip įdiekite Node.js ir npm Ubuntu.
Norėdami nustatyti npm scenarijų pakete.json, atlikite toliau nurodytus veiksmus.
- Eikite į savo projekto šaknį.
- Paleiskite npm init terminale. Komanda užduos keletą klausimų apie jūsų projektą. Atsakykite į juos, kad sukurtumėte atitinkamą paketą.json failą.
npm init - Package.json faile raskite scenarijų lauką. Čia galite pridėti scenarijaus pavadinimą ir komandą, kurią jis turėtų vykdyti kaip rakto/reikšmių poras. Pavyzdžiui, toliau pateiktas scenarijus, pavadintas hello-world, paleisdamas terminalą išspausdina „Hello world“.
{
"scenarijai": {
"Labas pasauli": "aidas \\"Labas pasauli\\""
}
}
Štai keletas bendrų „JavaScript“ projektų scenarijų:
- pradėti: Šis scenarijus paleidžia kūrimo serverį. Pavyzdžiui, Node projekte tai gali paleiskite serverį naudodami nodemoną.
- statyti: generuoja jūsų programos gamybos kodą ir gali naudoti tokį įrankį kaip žiniatinklio paketas, kad sumažintų ir sugrupuotų kodą.
- bandymas: Šis scenarijus vykdo jūsų projekte nurodytus testus. Jis gali paleisti testavimo sistemą, pvz., „Jest“.
- pūkelių: „Lint“ scenarijus paleidžia linijavimo įrankį, pvz., „ESLint“, kad patikrintų, ar kode nėra galimų klaidų.
- žiūrėti: Šis scenarijus stebi šaltinio kodo pakeitimus ir paleidžia komandą. Tai naudinga pakartotinai atliekant bandymus arba atkuriant programą keičiant kodą.
- dislokuoti: Vykdo komandą, kuri diegia programą nurodytoje aplinkoje, pvz., gamybos ar sustojimo.
Prieš ir po scenarijų
npm palaiko išankstinius ir postesnius scenarijus. Išankstiniai scenarijai paleidžiami prieš konkretų scenarijų, o paskelbimo scenarijai paleidžiami vėliau. Galite sukurti bet kurio scenarijaus išankstinius ir paskelbtus scenarijus, tiesiog prie savo scenarijaus pavadinimo pridėkite „pre“ arba „post“.
Pavyzdžiui, toliau pateikiami išankstinio ir potestavimo scenarijai, kurie bus vykdomi atitinkamai prieš ir po bandomojo scenarijaus.
{
"scenarijai": {
"pretestas": "npm paleisti pūkelį",
"bandymas": "juokas",
"posttestas": „npm run build“
}
}
Vykdomi npm scenarijai iš package.json
Pridėję npm scenarijų prie paketo.json, galite jį paleisti naudodami komandą npmrun.
Štai sintaksė:
npm paleisti
Pavyzdžiui, norėdami paleisti anksčiau apibrėžtą pradžios scenarijų, naudokite:
npm paleisties pradžia
Galite vykdyti npmrun komandą atskirai, kad gautumėte visų galimų projekto scenarijų sąrašą. Štai keletas išvesties pavyzdžių:
Scenarijai pasiekiami adresu npm-scripts-demo@1.0.0 per „npm run-script“:
Labas pasauli
echo "Labas pasauli"
Jame pateikiamas scenarijaus pavadinimas ir jo vykdoma komanda.
Trumpųjų komandų naudojimas integruotiems scenarijus paleisti
npm palaiko kelis integruotus scenarijus, kuriuos galite paleisti naudodami trumpąsias komandas. Pavyzdžiui, norėdami paleisti npm scenarijų, pavadintą start, galite naudoti npm start, o ne npm run start.
Tai patogiau ir greičiau nei įvesti visą komandą. Kiti integruoti scenarijai, kuriuos galite paleisti taip, yra "testas", "stop" ir "restart".
Vykdomi keli npm scenarijai
Galite paleisti kelis npm scenarijus dviem būdais:
- Iš eilės
- Lygiagrečiai
Jei naudojate „Linux“ ar bet kurią kitą „Unix“ tipo sistemą, galite naudoti standartą kelių komandų paleidimo vienu metu metodai.
Norėdami paleisti kelis npm scenarijus nuosekliai, naudokite &&, pavyzdžiui:
npm paleisties pradžia && npm testas
Norėdami lygiagrečiai paleisti kelis npm scenarijus, naudokite &, pavyzdžiui:
npm paleisti serverį ir npm paleisti klientą
Ne UNIX aplinkoje galite naudoti komandą npm-run-all arba vienu metu npm paketą.
Naudojant npm-run-all:
npm-run-all -- lygiagretaus serverio klientas
Vienu metu naudojamas pakete.json.
"scenarijai": {
"dev": "kartu \\"npm paleisti serverį\\" \\"npm paleisti klientą\\"",
}
Atminkite, kad prieš naudodami turite įdiegti paketus npm-run-all ir Concurrently.
Įprastų Npm scenarijaus klaidų trikčių šalinimas
Toliau pateikiamos kelios įprastos klaidos, su kuriomis galite susidurti vykdydami npm scenarijus:
- npm klaida! trūksta scenarijaus – Ši klaida atsiranda, kai faile package.json neapibrėžėte scenarijaus, kurį bandote paleisti. Įsitikinkite, kad teisingai rašote scenarijaus pavadinimą ir kad jis apibrėžtas paketo.json failo scenarijų lauke.
- Leidimas nesuteiktas - Ši klaida atsiranda, kai neturite leidimo paleisti scenarijų, todėl įsitikinkite, kad turite tinkamus leidimus.
- Trūksta priklausomybių – Ši klaida atsiranda, kai scenarijus naudoja neįdiegtą paketą. Naudokite tokį įrankį kaip depcheck kad patikrintumėte, ar pakete package.json nėra priklausomybių, tada įdiekite jas naudodami npm install.
- Nežinoma komanda — Ši klaida dažniausiai atsiranda, kai paleidžiate pasirinktinį scenarijų kaip integruotą npm komandą. Įsitikinkite, kad naudojate npm paleisti arba npm paleisti scenarijų kai vykdomi pasirinktiniai scenarijai.
Aplinkos kintamųjų naudojimas npm scenarijuose
Aplinkos įvairovė leidžia perduoti informaciją jos sunkiai koduojant. Norėdami naudoti aplinkos kintamuosius npm scenarijuje, galite naudoti cross-env npm paketas. Šis įrankis padeda nustatyti aplinkos kintamąjį bet kurioje aplinkoje.
Pradėkite paleisdami šią komandą terminale, kad įdiegtumėte ją kaip kūrėjo priklausomybę:
npm i save -D kryžminis env
Tada naudokite jį savo scenarijuje taip:
{
"scenarijai": {
"statyti": "cross-env NODE_ENV=gamybos žiniatinklio paketas"
}
}
Čia cross-env nustato NODE_ENV kintamąjį į "gamyba".
Komandinės eilutės argumentų perdavimas scenarijams
Komandinės eilutės argumentus galite perduoti npm scenarijui naudodami du brūkšnius „--“ po scenarijaus pavadinimo. Pavyzdžiui, ši komanda paleidžia bandomąjį scenarijų su stebėjimo argumentu:
npm paleisties testas žiūrėti
Taip pat galite nusiųsti komandinės eilutės argumentą į npm scenarijų, pavyzdžiui:
npm paleisti my-port --PORT=3000
Tada pasiekite jį scenarijuje taip.
"scenarijai": {
"mano uostas": "aidas \\"Prievadas: $npm_config_PORT\\""
}
„Windows“ sistemoje naudokite:
"scenarijai": {
"mano uostas": "aidas \\"Prievadas: %npm_config_PORT%\\""
}
Kai paleidžiate scenarijų, jis turėtų išspausdinti „Port: 3000“.
Kodėl naudoti npm scenarijus?
Galite įtraukti scenarijus į paketą.json, paleisti juos komandinėje eilutėje, naudoti išankstinius ir paskelbtus kabliukus ir perduoti jiems eilutės argumentus bei aplinkos kintamuosius.
npm scenarijai yra galingas būdas automatizuoti užduotis „JavaScript“ projektuose. Jie gali pagerinti jūsų darbo eigą ir sutaupyti laiko suteikdami jums nuoseklias komandas kelioms užduotims vykdyti.
