Comment ajouter des commentaires à la package.json pour NGP installer ?

Question

J’ai un fichier package.json simple et je veux ajouter un commentaire. Y a-t-il un moyen de le faire, ou y a-t-il des hacks pour que cela fonctionne ?

Le commentaire de l’exemple ci-dessus ne fonctionne pas comme les sauts de la NGP. J’ai aussi essayé / / style de commentaires.

Answer 1

Cela a récemment été examinée par la liste de diffusion de node.js.

Selon Isaac Schlueter qui dirige le développement du nœud et nommé NGP :

... le « / / » clé sera jamais utilisée par npm pour n’importe quel but et est réservée aux commentaires... Si vous souhaitez utiliser un commentaire de lignes multiples, vous pouvez utiliser un tableau ou multiple « / / » clés.

Answer 2

Voici un autre hack pour ajouter des commentaires dans JSON. Depuis :

Équivaut à

Vous pouvez faire quelque chose comme :

}

Answer 3

Vous pouvez toujours l'abus de la fait le double des clés sont écrasés. C'est ce que je viens d'écrire:

"dependencies": {
  "grunt": "...",
  "grunt-cli": "...",

  "api-easy": "# Here is the pull request: https://github.com/...",
  "api-easy": "git://..."

  "grunt-vows": "...",
  "vows": "..."
}

Cependant, il n'est pas clair si JSON permet dupliqué clés (voir Ne JSON syntaxe permet la duplication de clés dans un objet?. Il semble fonctionner avec npm, donc je prends le risque.

Le recommened hack est d'utiliser "//" clés (à partir de la nodejs liste de diffusion). Quand je l'ai testé, il ne fonctionne pas avec des "dépendances" sections. Aussi, l'exemple de la poste utilise plusieurs "//" clés, ce qui implique que les mnp ne pas rejeter des fichiers JSON ayant les mêmes touches. En d'autres termes, le hack ci-dessus doivent toujours être fine.

Mise à jour: Un ennuyeux inconvénient de la copie de clés hack est qu' npm install --save silencieusement élimine tous les doublons. Malheureusement, il est très facile de l'ignorer et de votre bien-intentionnés, les commentaires sont allés.

L' "//" hack est encore le plus sûr qu'il y paraît. Cependant, les commentaires multi-lignes seront supprimées par l' npm install --save, trop.