NPM - Come risolvere "Nessun dato readme"


190

Ho un semplice 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": ""
  }
}

Quando eseguo "npm install" ricevo il seguente avviso che vorrei correggere:

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

Ho provato ad aggiungere "README.md" e "readme.txt" alla stessa directory del pacchetto, ma senza gioia. Cosa mi sto perdendo?


Una risposta dal supporto NPM che potrebbe essere rilevante per alcuni: "Era solo un ritardo nella cache del sito Web che doveva essere aggiornato."
Joshua Pinter

Risposte:


225

La semplice aggiunta di un README.mdfile non lo risolverà, dovresti scrivere qualcosa al suo interno; almeno il titolo del progetto e una breve descrizione fanno bene alle persone! Ma per NPM, un byte potrebbe essere sufficiente ...
In questo modo si dovrebbe smettere di mostrare gli avvisi.

Inoltre, quando leggi questo avviso, assicurati che il problema non sia correlato a un pacchetto di terze parti.


19
Ho questo problema e ho un file README non vuoto ...: /
mgol

3
Anch'io ho un README.mdfile con un sacco di roba nella stessa directory del mio package.json, e ancora ottengo questo (in relazione al karma-caffè-preprocessore)
Conan,

2
Sì, lo stesso di @Conan. README.mdfile, popolato, ancora visualizzato l'errore.
Nathan Hornby,

4
@gustavohenke Che sciocca da parte mia, hai ragione - l'avvertimento era per un pacchetto, non per la mia app
Nathan Hornby,

2
@NathanHornby visto che ti è stato utile, l'ho aggiunto nella risposta :)
gustavohenke,

178

Imposta come privato;)

{
  "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
Va notato che la proprietà privatedice a npm che questo non è un progetto destinato ad essere disponibile nel repository npm. Puoi vedere che qualcuno ha già chiesto qual è quella proprietà utilizzata per stackoverflow.com/a/7314961/1128216
Jonathan Morales Vélez,

2
Se imposti "private": true nel tuo package.json, allora npm rifiuterà di pubblicarlo. rif:https://www.npmjs.org/doc/files/package.json.html
AlexStack

3
In realtà, nelle versioni più recenti di NPM, non importa se il pacchetto è privato o meno. Devi avere un README.mdfile. La risposta di @gustavohenke si adatta meglio ad ogni versione.
ViniciusPires

Funziona bene se lo stai usando per generare del codice di output e non hai davvero bisogno di un pacchetto sorgente completo.
Neil Monroe,

Vorrei dire questa risposta in qualche modo: - Naturalmente, l'unica ragione per non avere un README.mdfile è che il tuo progetto è privato. Quindi scrivere un nome corretto README.md o impostare la bandiera privata.
Rustyx,

9

L'aggiunta di un file README.md alla radice del progetto è la risposta, ma ho notato che NPM impiega poco tempo a capire questo. Forse qualche minuto?


2
È vero che dopo la pubblicazione ci vuole un momento per aggiornare gli elenchi di NPM. Ecco una risposta dal supporto di NPM: "Era solo un ritardo nella cache del sito Web che doveva essere aggiornato."
Joshua Pinter

1

Aggiungi a package.json "readme": "README.md"


6
l'aggiunta di questa proprietà comporta la visualizzazione del testo "README.md" nella pagina dei dettagli su npmjs.com. Evidentemente, è per il markdown grezzo e non per un nome file.
code_monk,

Tuttavia rimuove l'avvertimento npm, ma non nel modo in cui questa risposta implica.
rogersillito,

@code_monk così potremmo scrivere qualcosa del tipo "vedi README.md "
aloisdg si trasferisce su codidact.com il

1
potresti, ma AFAIK semplicemente aggiungendo un README.md alla radice del tuo repository risolverà questo avviso; che è una buona idea e aiuterà i tuoi utenti a capire come funziona il tuo software
code_monk

0

Ad oggi, aprile 2017, appena impostato di seguito in package.json, funziona ancora bene:

"private": true

questo significa che è il tuo repository privato

anche, con gli ultimi npm, funziona bene:

npm update -g npm
> 3.10.8

0

la mia soluzione

  • npm show
  • npm dist-tag add

1.usare npm showcontrollare le informazioni di distribuzione del sito Web remoto.

ad es. dovrebbe essere così:

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]

e quindi aggiorna il laser 0.3.53-betaa0.3.61-beta

npm dist-tag add SOME_PACKAGE@0.3.61-beta

3. npm showcontrolla l'agin

uguale al passaggio 1

torna al sito del pacchetto npm, tutti aggiornati!


Desidero aiutare, grazie ~

[Un insegnamento cinese] 希望 对 您 有 帮助 , 谢谢 ~

Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.