NPM - Cara memperbaiki "Tidak ada data readme"

190

Saya punya package.json sederhana:

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

Ketika saya menjalankan "npm install" saya mendapatkan peringatan berikut yang ingin saya perbaiki:

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

Saya telah mencoba menambahkan "README.md" & "readme.txt" ke direktori yang sama dengan paket tetapi tanpa sukacita. Apa yang saya lewatkan?

npm iancrowther
sumber
Sebuah jawaban dari dukungan NPM yang mungkin relevan untuk beberapa: "Itu hanya penundaan dalam cache situs web yang perlu mengejar ketinggalan untuk mempublikasikan."
Joshua Pinter

Jawaban:

225

Cukup menambahkan README.mdfile tidak akan memperbaikinya, Anda harus menulis sesuatu di dalamnya; setidaknya judul proyek dan deskripsi singkatnya bagus untuk orang-orang! Tetapi untuk NPM, satu byte mungkin cukup ...
Melakukan hal itu seharusnya berhenti menunjukkan peringatan.

Juga, ketika Anda membaca peringatan itu, pastikan bahwa masalahnya tidak terkait dengan paket pihak ke-3.

gustavohenke
sumber
19
Saya memiliki masalah ini dan saya memiliki file README tidak kosong ...: /
mgol
3
Saya juga punya README.mdfile dengan banyak barang di dalamnya di direktori yang sama dengan saya package.json, dan masih mendapatkan ini (sehubungan dengan karma-kopi-preprosesor)
Conan
2
Yup, sama dengan @Conan. README.mdfile, diisi, masih mendapatkan kesalahan.
Nathan Hornby
4
@gustavohenke Betapa bodohnya saya, Anda benar - peringatan itu untuk sebuah paket, bukan aplikasi saya
Nathan Hornby
2
@NathanHornby karena berguna bagi Anda, saya menambahkannya dalam jawaban :)
gustavohenke
178

Jadikan sebagai pribadi;)

{
  "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": ""
  }
}
Klayton Faria
sumber
6
Perlu dicatat bahwa properti privatememberi tahu npm bahwa ini bukan proyek yang dimaksudkan untuk tersedia di repositori npm. Anda dapat melihat bahwa seseorang telah menanyakan properti apa yang digunakan untuk stackoverflow.com/a/7314961/1128216
Jonathan Morales Vélez
2
Jika Anda mengeset "private": true di package.json Anda, maka npm akan menolak untuk mempublikasikannya. ref:https://www.npmjs.org/doc/files/package.json.html
AlexStack
3
Sebenarnya, dalam versi NPM yang lebih baru, tidak masalah apakah paket itu pribadi atau tidak. Anda harus memiliki README.mdfile. jawaban @gustavohenke lebih cocok untuk setiap versi.
ViniciusPires
Ini berfungsi baik jika Anda hanya menggunakannya untuk menghasilkan beberapa kode keluaran dan tidak benar-benar membutuhkan paket sumber lengkap.
Neil Monroe
Saya akan mengatakan jawaban seperti ini - Tentu saja, satu-satunya alasan untuk tidak memiliki README.mdfile adalah bahwa proyek Anda pribadi. Jadi baik menulis yang tepat README.md atau atur bendera pribadi.
rustyx
9

Menambahkan README.md ke root proyek Anda adalah jawabannya, tetapi saya perhatikan bahwa perlu beberapa saat bagi NPM untuk mengambil ini. Mungkin beberapa menit?

Richardinho
sumber
2
Memang benar bahwa setelah Anda mempublikasikan dibutuhkan waktu untuk memperbarui daftar NPM. Berikut respons dari dukungan NPM: "Itu hanya penundaan dalam cache situs web yang perlu mengejar publikasi."
Joshua Pinter
1

Tambahkan ke package.json "readme": "README.md"

Сергей Сыркин
sumber
6
menambahkan properti ini menghasilkan teks "README.md" yang ditampilkan pada halaman detail di npmjs.com. Jelas, itu untuk penurunan harga mentah dan bukan nama file.
code_monk
Namun itu menghapus peringatan npm - hanya saja tidak seperti jawaban ini menyiratkan.
rogersillito
@code_monk sehingga kita bisa menulis sesuatu seperti "lihat README.md "
aloisdg pindah ke codidact.com
1
Anda bisa, tetapi AFAIK hanya menambahkan README.md di root repo Anda akan memperbaiki peringatan ini; yang merupakan Ide Bagus, dan akan membantu pengguna Anda memahami cara kerja perangkat lunak Anda
code_monk
0

Mulai hari ini, Apr 2017, hanya pengaturan di bawah ini di package.json, masih berfungsi dengan baik:

"private": true

ini berarti ini adalah repositori pribadi Anda

bahkan, dengan npm terbaru, ini berfungsi dengan baik: 

npm update -g npm
> 3.10.8
Manohar Reddy Poreddy
sumber
0

solusi saya

  • npm show
  • npm dist-tag add

1. gunakan npm showperiksa info penyebaran situs web jarak jauh.

mis. harus seperti ini:

[email protected] | 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 <[email protected]>
- jyjin1 <[email protected]>
- jyjin2 <[email protected]>

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

published 26 minutes ago by jyjin1 <[email protected]>

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

dan kemudian perbarui lasest 0.3.53-betake0.3.61-beta

npm dist-tag add [email protected]

3. npm showperiksa agin

sama dengan langkah 1

kembali ke situs paket npm Anda, semua telah di-refresh!

Ingin membantu, terima kasih ~

[One Chinese Teach] 希望 对 您 有 帮助 ， 谢谢 ~

jyjin
sumber