Mikä on package.json?

package.json-tiedosto on jokaisen Node.js-projektin keskeinen osa. Se toimii manifestina, joka määrittää projektin metatiedot, riippuvuudet, skriptit ja määritykset. Tämä JSON-tiedosto kertoo npm:lle (Node Package Managerille) ja muille työkaluille, miten projektia käsitellään, mitä paketteja asennetaan ja miten eri tehtäviä suoritetaan. Tiedosto vaaditaan pakettien julkaisemiseen npm:ään, ja se on ensimmäinen tiedosto, jonka kehittäjät yleensä tarkistavat tutustuessaan Node.js-projektiin.

Riippuvuuksien luettelemisen lisäksi package.json hallitsee semanttista versiointia, määrittää aloituspisteet, ilmoittaa yhteensopivat Node-versiot ja voi sisältää mukautettuja skriptejä sovellusten koontia, testausta ja käyttöönottoa varten. Kelvollinen ja hyvin jäsennelty package.json on olennaisen tärkeä projektin ylläpidettävyyden ja yhteistyön kannalta.

Työkalun kuvaus

Tämä online package.json -validaattori tarkistaa package.json-tiedostosi oikeellisuuden, yhteensopivuuden npm-määritysten kanssa ja hyvien käytäntöjen noudattamisen. Liitä package.json-tiedostosi sisältö saadaksesi välittömästi palautetta virheistä, varoituksista ja parannusehdotuksista.

Esimerkkejä

Virheellinen JSON-syntaksi:

{
  "name": "my-package",
  "version": "1.0.0" // Kommentit eivät ole sallittuja
}

Virhe: JSON ei tue kommentteja; tämä aiheuttaa jäsennysvirheen.

Pakollisia kenttiä puuttuu:

{
  "description": "Paketti ilman nimeä tai versiota"
}

Virhe: Pakolliset kentät "name" ja "version" puuttuvat.

Virheellinen version muoto:

{
  "name": "my-package",
  "version": "1.0"
}

Varoitus: Version tulee noudattaa semanttista versiointia (esimerkiksi "1.0.0").

Ominaisuudet

  • package.json-syntaksin ja rakenteen reaaliaikainen validointi
  • npm:n toiminnan estävien kriittisten virheiden tunnistaminen
  • Vanhentuneita kenttiä tai epästandardeja käytäntöjä koskevat varoitukset