npm-skriptid koondavad komplekti terminalikäske, mida saate kasutada JavaScripti projekti ülesannete automatiseerimiseks. Samuti pakuvad need järjekindlat viisi käskude käivitamiseks erinevates keskkondades.
Saate seadistada npm-skripte failis package.json, käivitada need käsureal ja kasutada nende käitumise konfigureerimiseks laia valikut valikuid.
Npm-skriptide seadistamine failis package.json
Tavaliselt määratlete npm-skriptid failis package.json, mis asub teie JavaScripti projekti juurtes. See ei ole kohustuslik, kuna saate käivitada skripte teistest failidest, kuid paketti.json muudab skriptidele juurdepääsu ja haldamise lihtsamaks.
Pange tähele, et teie arenduskeskkonda peavad olema installitud npm ja Node. Siin on mõned kasulikud artiklid:
- Kuidas installige Windowsi Node.js ja npm.
- Kuidas installige Ubuntule Node.js ja npm.
Npm-skripti seadistamiseks failis package.json järgige alltoodud samme.
- Liikuge oma projekti juureni.
- Käivitage terminalis npm init. Käsk esitab teile mõned küsimused teie projekti kohta. Vastake neile, et luua sobiv fail package.json.
npm init - Leidke failis package.json skriptide väli. Siin saate lisada skripti nime ja käsu, mida see peaks käivitama võtme/väärtuse paaridena. Näiteks allolev skript nimega hello-world prindib käivitamisel terminali "Tere maailm".
{
"skriptid": {
"Tere, Maailm": "kaja \\"Tere, Maailm\\""
}
}
Siin on mõned JavaScripti projektide levinumad skriptid:
- alustada: see skript käivitab arendusserveri. Näiteks Node projektis saab käivitage server nodemoni abil.
- ehitada: loob teie rakenduse jaoks tootmiskoodi ja võib koodi minimeerimiseks ja komplekteerimiseks kasutada sellist tööriista nagu veebipakett.
- test: see skript käivitab teie projektis määratletud testid. See võib käivitada testimisraamistiku nagu Jest.
- ebemed: Lint-skript käivitab linteerimistööriista, näiteks ESLint, et kontrollida koodi võimalike vigade suhtes.
- vaata: see skript jälgib lähtekoodi muudatusi ja käivitab seejärel käsu. See on kasulik testide taaskäivitamiseks või rakenduse koodi muutmisel uuesti ülesehitamiseks.
- kasutusele võtta: Käivitab käsu, mis juurutab rakenduse määratud keskkonda, näiteks tootmis- või lavastuskeskkonda.
Eel- ja järelskriptid
npm toetab eel- ja järelskripte. Eelskriptid jooksevad enne konkreetset skripti, postitusskriptid aga pärast seda. Saate luua eel- ja postiskripte mis tahes skripti jaoks, lisades oma skripti nimele lihtsalt "pre" või "post".
Näiteks allpool on eel- ja järeltesti skriptid, mis käitatakse vastavalt enne ja pärast testskripti.
{
"skriptid": {
"eeltestimine": "npm run lint",
"test": "nali",
"järeltest": "npm run build"
}
}
Npm-skriptide käitamine saidilt package.json
Kui olete faili package.json npm-skripti lisanud, saate selle käivitada käsu npmrun abil.
Siin on süntaks:
npm jooks
Näiteks varem määratletud käivitusskripti käivitamiseks kasutage järgmist:
npm jooksu algus
Saate käivitada käsu npmrun eraldi, et saada kõigi projektis saadaolevate skriptide loend. Siin on väljundi näide:
Skriptid on saadaval aadressil [email protected] npm run-scripti kaudu:
Tere, Maailm
kaja "Tere maailm"
See loetleb skripti nime ja selle käivitatava käsu.
Kiirkäskude kasutamine sisseehitatud skriptide käivitamiseks
npm toetab mitmeid sisseehitatud skripte, mida saate käivitada kiirkäskude abil. Näiteks npm-skripti nimega start käitamiseks võite kasutada npm start asemel käsku npm start.
See on mugavam ja kiirem kui täieliku käsu tippimine. Muud sisseehitatud skriptid, mida saate niimoodi käivitada, hõlmavad "test", "stopp" ja "restart".
Mitme npm-skripti käitamine
Mitut npm-skripti saate käitada kahel viisil.
- Järjestikku
- Paralleelselt
Kui kasutate Linuxi või mõnda muud Unixi sarnast süsteemi, saate kasutada standardit mitme käsu korraga käitamise meetodid.
Mitme npm-skripti järjestikuse käivitamiseks kasutage &&, näiteks:
npm käivitamine && npm test
Mitme npm-skripti paralleelseks käitamiseks kasutage näiteks &:
npm käivitusserver ja npm käivitusklient
Mitte-UNIX-i keskkondades saate kasutada käsku npm-run-all või samaaegselt npm paketti.
Funktsiooni npm-run-all kasutamine:
npm-run-all -- paralleelserveri klient
Samaaegne kasutamine failis package.json.
"skriptid": {
"dev": "samaaegselt \\"npm käivita server\\" \\"npm käivita klient\\"",
}
Pange tähele, et enne nende kasutamist peate installima paketid npm-run-all ja Concurrently.
Levinud Npm-skriptivigade tõrkeotsing
Allpool on toodud mõned levinumad vead, mis võivad tekkida npm-skriptide käitamisel.
- npm viga! puuduv skript — See tõrge ilmneb siis, kui te pole failis package.json määratlenud skripti, mida proovite käivitada. Veenduge, et kirjutaksite skripti nime õigesti ja et see oleks faili package.json skriptiväljal määratletud.
- Luba ei antud — See tõrge ilmneb siis, kui teil pole skripti käitamiseks luba, seega veenduge, et teil on õiged õigused.
- Puuduvad sõltuvused — See tõrge ilmneb siis, kui skript kasutab paketti, mis pole installitud. Kasutage sellist tööriista nagu depcheck et kontrollida, kas failist package.json puuduvad sõltuvused, seejärel installige need npm install abil.
- Tundmatu käsk — See tõrge ilmneb tavaliselt siis, kui käivitate kohandatud skripti sisseehitatud npm-käsuna. Kasutage kindlasti npm jooks või npm run-script kohandatud skriptide käitamisel.
Keskkonnamuutujate kasutamine npm-skriptides
Keskkonnamuutujad võimaldab teil edastada teavet ilma seda kõvasti kodeerimata. Keskkonnamuutujate kasutamiseks npm-skriptis saate kasutada cross-env npm pakett. See tööriist aitab teil määrata keskkonnamuutuja mis tahes keskkonnas.
Alustage selle käsu käivitamisega terminalis, et installida see arendaja sõltuvusena:
npm ma salvestan -D cross-env
Seejärel kasutage seda oma skriptis järgmiselt:
{
"skriptid": {
"ehitada": "cross-env NODE_ENV=tootmise veebipakett"
}
}
Siin määrab cross-env muutuja NODE_ENV väärtuseks "tootmine".
Käsurea argumentide edastamine skriptidele
Saate käsurea argumendid npm-skriptile edastada, kasutades skripti nime järel kahte kriipsu "--". Näiteks käivitab järgmine käsk testskripti jälgimisargumendiga:
npm jooksutest -- --vaata
Samuti saate npm-skriptile käsurea argumendi saata järgmiselt:
npm käivita my-port --PORT=3000
Seejärel avage see skriptis järgmiselt.
"skriptid": {
"minu sadam": "kaja \\"Port: $npm_config_PORT\\""
}
Windowsi süsteemis kasutage järgmist:
"skriptid": {
"minu sadam": "kaja \\"Port: %npm_config_PORT%\\""
}
Skript peaks selle käivitamisel printima "Port: 3000".
Miks kasutada npm-skripte?
Saate lisada faili package.json skripte, käivitada neid käsureal, kasutada eel- ja postikonkse ning edastada neile reaargumente ja keskkonnamuutujaid.
npm-skriptid on võimas viis ülesannete automatiseerimiseks JavaScripti projektides. Need võivad parandada teie töövoogu ja säästa teie aega, pakkudes teile järjekindlaid käske mitme ülesande käitamiseks.