2013-08-05 2 views
186

j'ai simple package.json:NPM - Comment réparer « Aucune donnée readme »

{ 
    "name": "camapaign", 
    "version": "0.0.1", 
    "scripts": { 
    "start": "node app.js" 
    }, 
    "engines": { 
    "node": "0.10.15", 
    "npm": "1.3.5" 
    }, 
    "repository": { 
    "type": "svn", 
    "url": "" 
    } 
} 

Quand j'execute « NPM installer » Je reçois l'avertissement suivant que je voudrais corriger:

"npm WARN package.json [email protected] No readme data." 

J'ai essayé d'ajouter "README.md" & "readme.txt" dans le même répertoire que le paquet mais sans joie. Qu'est-ce que je rate?

+0

Une réponse du support de NPM qui peut être pertinente pour certains: "C'était juste un retard dans le cache du site Web qui devait rattraper le temps de publication." –

Répondre

223

Il suffit d'ajouter un fichier README.md pour le corriger, vous devriez écrire quelque chose à l'intérieur; au moins le titre du projet et une brève description est bon pour les gens! Mais pour NPM, un octet peut suffire ...
Cela devrait arrêter de montrer les avertissements.

De même, lorsque vous lisez cet avertissement, assurez-vous que le problème n'est pas lié à un package tiers.

+1

ok cool, pas un mauvais appel que .. merci pour votre réponse, cela a fonctionné :-) – iancrowther

+17

J'ai ce problème et j'ai un fichier README non vide ...:/ – mgol

+1

Est-il 'README',' README .markdown' ou quoi? J'ai peur de dire que cela fonctionne seulement avec 'README.md' ... essayez-le! – gustavohenke

175

Juste défini comme privé)

{ 
    "name": "camapaign", 
    "version": "0.0.1", 
    "private": true, 
    "scripts": { 
    "start": "node app.js" 
    }, 
    "engines": { 
    "node": "0.10.15", 
    "npm": "1.3.5" 
    }, 
    "repository": { 
    "type": "svn", 
    "url": "" 
    } 
} 
+5

Il convient de noter que la propriété ' private' dit à npm que ce n'est pas un projet destiné à être disponible sur le dépôt npm. Vous pouvez voir que quelqu'un a déjà demandé à quoi sert cette propriété http://stackoverflow.com/a/7314961/1128216 –

+2

Si vous définissez "private": true dans votre package.json, alors npm refusera de le publier. ref: 'https: // www.npmjs.org/doc/files/package.json.html' – AlexStack

+3

En fait, dans les nouvelles versions de NPM, peu importe si le paquet est privé ou non. Vous devez avoir un fichier 'README.md'. réponse @gustavohenke convient mieux à chaque version. – ViniciusPires

1

Ajouter à package.json "readme": "README.md"

+6

l'ajout de cette propriété entraîne l'affichage de * README.md * * sur la page de détails sur npmjs.com. Évidemment, c'est pour la démarque brute et pas un nom de fichier. –

+0

Il supprime cependant l'avertissement npm - mais pas de la façon dont cette réponse implique. – rogersillito

+0

@code_monk afin que nous puissions écrire quelque chose comme « voir [README.md] (https://github.com/aloisdg/attrithub/blob/master/README.md) » – aloisdg

9

Ajout d'un README.md à la racine de votre projet est la réponse, mais je l'ai remarqué qu'il faut un court tandis que pour NPM pour ramasser à ce sujet. Peut-être quelques minutes?

+1

Il est vrai qu'après la publication, il faut un moment pour mettre à jour les listings de NPM. Voici une réponse du support de NPM: "C'était juste un retard dans le cache du site web qui devait rattraper le temps de publication." –

0

A ce jour, avril 2017, la mise juste au-dessous de package.json, fonctionne toujours très bien:

"private": true 

cela signifie son référentiel privé

même, avec le dernier NPM, il fonctionne très bien:

npm update -g npm 
> 3.10.8