Paramètres du fichier package.json en JavaScript
Lorsqu'un programmeur souhaite rendre
sa bibliothèque accessible à tous,
il doit la publier dans le registre
(c'est-à-dire le dépôt) npm. Pour cela, il doit
configurer le fichier package.json de cette bibliothèque
d'une manière spécifique, en ajoutant certaines
paramètres importants.
Ces paramètres concernent spécifiquement les bibliothèques publiques que vous téléchargez depuis npm. Dans vos projets à usage privé, vous pouvez ne pas les définir.
Voici donc une liste des paramètres les plus populaires :
| Valeur | Description |
|---|---|
name |
le nom du projet, doit être écrit en minuscules |
version |
le numéro de version, selon le versionnage sémantique |
description |
la description du projet |
main |
le fichier d'entrée du projet |
keywords |
c'est un tableau, aidant à trouver le module dans le registre npm |
author |
ce champ accepte un objet avec les clés name, email et url,
ce qui permet aux gens de contacter facilement l'auteur du projet.
|
license |
accepte le nom de la licence en utilisant l'identifiant SPDX. Par défaut, la licence ISC est appliquée, un autre choix populaire est MIT. Vous pouvez également utiliser UNLICENSED pour les projets privés et les projets à code source fermé. |
private |
si cette clé est définie sur true, le projet ne pourra pas être public dans le registre npm. Cela permet d'éviter une publication accidentelle du projet. |
homepage |
L'URL de la page d'accueil du projet |
bugs |
L'URL où signaler les problèmes et les erreurs. Souvent, c'est l'adresse de la page du projet sur Github. |
Installez la bibliothèque jQuery.
Recherchez dans node_modules le dossier de la bibliothèque,
et dedans - le fichier package.json. Étudiez-le.
Installez la bibliothèque underscorejs.
Recherchez dans node_modules le dossier de la bibliothèque,
et dedans - le fichier package.json. Étudiez-le.
Étudiez les paramètres du fichier package.json
dans la documentation officielle.