NPM - Як виправити "Немає даних readme"


190

У мене простий 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": ""
  }
}

Коли я виконую "npm install", я отримую таке попередження, яке я хотів би виправити:

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

Я спробував додати "README.md" & "readme.txt" до того ж режиму, що і пакет, але без радості. Що я пропускаю?


Відповідь підтримки НПМ, яка може бути актуальною для деяких: "Це була лише затримка кешу веб-сайту, яка потребує донесення публікації".
Джошуа Пінтер

Відповіді:


225

Просто додавання README.mdфайла не виправить це, ви повинні написати щось всередині нього; принаймні назва проекту та короткий опис корисні для людей! Але для NPM, одного байта може бути достатньо ...
Якщо це зробити, слід перестати показувати попередження.

Також, читаючи це попередження, переконайтеся, що проблема не пов’язана з стороннім пакетом.


19
У мене ця проблема, і у мене є не порожній файл README ...: /
mgol

3
У мене теж є README.mdфайл із цілою купою речей у тому самому каталозі package.json, що і мій , і досі отримую це (стосовно карми-кави-препроцесора)
Конан,

2
Так, як і @Conan. README.mdфайл, заповнений, все ще отримує помилку.
Натан Хорнбі

4
@gustavohenke Як нерозумно зі мною, ти маєш рацію - попередження було про пакет, а не про мою програму
Nathan Hornby

2
@NathanHornby як це було вам корисно, я додав це у відповідь :)
gustavohenke

178

Просто встановіть як приватне;)

{
  "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
Слід зазначити, що властивість privateповідомляє npm, що це не проект, призначений бути доступним у сховищі npm. Ви можете бачити, що хтось уже запитав, що ця власність використовується для stackoverflow.com/a/7314961/1128216
Джонатан Моралес Велес

2
Якщо ви встановите "private": true у своєму package.json, то npm відмовиться публікувати його. ref:https://www.npmjs.org/doc/files/package.json.html
AlexStack

3
Насправді, у нових версіях NPM не має значення, приватний пакет чи ні. Ви повинні мати README.mdфайл. Відповідь @gustavohenke краще підходить для кожної версії.
ViniciusPires

Це працює добре, якщо ви просто використовуєте його для створення деякого вихідного коду і насправді не потрібен повний вихідний пакет.
Ніл Монро

Я б сказав цю відповідь приблизно так - Звичайно, єдиною причиною не мати README.mdфайлу є те, що ваш проект приватний. Тож або напишіть належну README.md або встановіть приватний прапор.
rustyx

9

Додавання README.md до кореня проекту - це відповідь, але я помітив, що NPM забирає це короткий час. Може, кілька хвилин?


2
Це правда, що після публікації потрібен момент для оновлення списків NPM. Ось відповідь від підтримки НПМ: "Це була лише затримка кешу веб-сайту, необхідна для публікації публікації".
Джошуа Пінтер

1

Додати в package.json "readme": "README.md"


6
додавання цього властивості призводить до того, що текст "README.md" відображатиметься на сторінці деталей на npmjs.com. Очевидно, що це для необмеженої розмітки, а не для імені файлу.
code_monk

Однак воно не знімає попередження npm - просто не так, як передбачає ця відповідь.
rogersillito

@code_monk, щоб ми могли написати щось на кшталт "див README.md "
aloisdg переходить на codidact.com

1
Ви можете, але AFAIK просто додавши README.md у корені репо, виправить це попередження; що є хорошою ідеєю, і допоможе вашим користувачам зрозуміти, як працює ваше програмне забезпечення
code_monk

0

На сьогоднішній день квітня 2017 року, лише встановлений нижче в package.json, все ще працює добре:

"private": true

це означає, що ваш приватний сховище

навіть, з останніми npm, він працює добре:

npm update -g npm
> 3.10.8

0

моє рішення

  • npm show
  • npm dist-tag add

1.використовуйте npm showперевірку інформації про розгорнуті веб-сайти

Наприклад, слід так:

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]

а потім оновити laserst 0.3.53-betaдо0.3.61-beta

npm dist-tag add SOME_PACKAGE@0.3.61-beta

3. npm showперевірити agin

те саме для кроку 1

поверніться на сайт пакету npm, усі оновились!


Бажаю допомогти, дякую ~

[Один китайський учитель] 希望 对 您 有 帮助 , 谢谢 ~

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.