NPM - Comment réparer "Aucune donnée readme"


190

J'ai un simple package.json:

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

Lorsque j'exécute "npm install", je reçois l'avertissement suivant que je voudrais corriger:

"npm WARN package.json camapaign@0.0.1 No readme data."

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


Une réponse du support NPM qui peut être pertinente pour certains: "C'était juste un retard dans le cache du site Web devant rattraper la publication."
Joshua Pinter

Réponses:


225

L'ajout d'un README.mdfichier ne résoudra pas le problème, vous devriez écrire quelque chose à l'intérieur; au moins le titre du projet et une brève description sont bons pour les gens! Mais pour NPM, un octet peut suffire ...
Cela devrait arrêter d'afficher les avertissements.

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


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

3
J'ai aussi un README.mdfichier avec tout un tas de choses dans le même répertoire que le mien package.json, et je le reçois toujours (par rapport à karma-coffee-preprocessor)
Conan

2
Ouais, même chose que @Conan. README.mdfichier, rempli, obtenant toujours l'erreur.
Nathan Hornby

4
@gustavohenke Comme c'est idiot de ma part, vous avez raison - l'avertissement était pour un paquet, pas pour mon application
Nathan Hornby

2
@NathanHornby comme cela vous a été utile, je l'ai ajouté dans la réponse :)
gustavohenke

178

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": ""
  }
}

6
Il convient de noter que la propriété privateindique à npm qu'il ne s'agit pas d'un projet destiné à être disponible sur le référentiel npm. Vous pouvez voir que quelqu'un a déjà demandé quelle est cette propriété utilisée pour stackoverflow.com/a/7314961/1128216
Jonathan Morales Vélez

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 package est privé ou non. Vous devez avoir un README.mdfichier. La réponse @gustavohenke convient mieux à chaque version.
ViniciusPires

Cela fonctionne bien si vous l'utilisez simplement pour générer du code de sortie et que vous n'avez pas vraiment besoin d'un paquet source complet.
Neil Monroe

Je voudrais formuler cette réponse quelque chose comme - Bien sûr, la seule raison de ne pas avoir de README.mdfichier est que votre projet est privé. Alors écrivez un propre README.md ou définissez l'indicateur privé.
rustyx

9

L'ajout d'un README.md à la racine de votre projet est la réponse, mais j'ai remarqué que NPM prend un peu de temps pour comprendre cela. Peut-être quelques minutes?


2
Il est vrai qu'après la publication, la mise à jour des listes de NPM prend un certain temps. Voici une réponse du support de NPM: "C'était juste un retard dans le cache du site Web devant rattraper la publication."
Joshua Pinter

1

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


6
l'ajout de cette propriété entraîne l' affichage du texte "README.md" sur la page de détail de npmjs.com. Évidemment, c'est pour le démarquage brut et non pour un nom de fichier.
code_monk

Il supprime cependant l'avertissement npm - mais pas de la manière dont cette réponse l'indique.
rogersillito

@code_monk pour que nous puissions écrire quelque chose comme "voir README.md "
aloisdg se déplaçant vers codidact.com le

1
vous pourriez, mais AFAIK simplement ajouter un README.md à la racine de votre dépôt corrigera cet avertissement; qui est une bonne idée, et aidera vos utilisateurs à comprendre comment votre logiciel fonctionne
code_monk

0

À partir d'aujourd'hui, avril 2017, juste en dessous dans package.json, fonctionne toujours bien:

"private": true

cela signifie que c'est votre référentiel privé

même, avec le dernier npm, cela fonctionne bien:

npm update -g npm
> 3.10.8

0

ma solution

  • npm show
  • npm dist-tag add

1. utiliser npm show vérifier les informations de déploiement du site Web distant.

par exemple, devrait aimer ceci:

SOME_PACKAGEs@0.3.60-beta | Proprietary | deps: 14 | versions: 289
<span style="color:red;">最新日志倒序在这里增加,注明作者+日期+功能</span>

dist
.tarball: https://registry.npmjs.org/xxx/-/xxx-0.3.60-beta.tgz
.shasum: 021e30640a62f13905b1e2b7a4facd169df46a1d
.integrity: sha512-9N4pUwwoYGNek34fCCCjURuQdx1K5VBlCWl4t1sy8wi3xul/N/TiDvjmUBF24t2Dg2fX6cFM9on+tftnVaEr7A==
.unpackedSize: 114.5 kB

dependencies:
@hanyk/rc-viewer: ^0.0.3        crypto-js: ^3.1.9-1             moment: ^2.25.3                 react-dom: ^16.12.0             uuid: ^3.3.3                    
axios: ^0.19.0                  dirty-json-ie11: ^0.0.2         query-string: ^6.9.0            react-quill: ^1.3.3             yqquill-image-drop-module: ^0.0 
cookie-universal: ^2.0.16       md5: ^2.2.1                     quill-delta-to-html: ^0.11.0    react-resizable: ^1.10.1        

maintainers:
- jyjin <jyjin@qq.com>
- jyjin1 <jyjin1@163.com>
- jyjin2 <jyjin2@163.com>

dist-tags:
beta: 0.3.61-beta    latest: 0.3.53-beta  

published 26 minutes ago by jyjin1 <jyjin1@163.com>

2.npm dist-tag add [PACKAGE_NAME]@[VERSION]

puis mettez 0.3.53-betaà jour lasest pour0.3.61-beta

npm dist-tag add SOME_PACKAGE@0.3.61-beta

3.npm show vérifier à nouveau

même à l'étape 1

retournez sur votre site de paquets npm, tous ont été rafraîchis!


Souhaite aider, merci ~

[Un enseignement chinois] 希望 对 您 有 帮助 , 谢谢 ~

En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.