NPM-如何修复“无自述数据”


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”添加到与包相同的目录中,但没有任何乐趣。我想念什么?


NPM支持人员给出的答案可能与某些情况有关:“这只是网站缓存的延迟,需要赶上发布。”
Joshua Pinter

Answers:


225

仅仅添加一个README.md文件并不能解决问题,您应该在其中写一些东西。至少项目名称和简短描述对人们有好处!但是对于NPM,一个字节可能就足够了……
这样做应该停止显示警告。

另外,当您阅读该警告时,请确保该问题与第三方包装无关。


19
我遇到了这个问题,并且我有一个非空的自述文件...:/
mgol 2014年

3
README.md在与我的目录相同的目录中也有一个包含一堆东西的文件package.json,并且仍然得到了这个文件(与karma-coffee-preprocessor有关)
Conan 2014年

2
是的,和@Conan一样。README.md文件,填充后,仍然出现错误。
内森·霍恩比

4
@gustavohenke我真是愚蠢,你是对的-警告是针对一个软件包,而不是我的应用
Nathan Hornby 2014年

2
@NathanHornby,因为它对您有用,我在答案中添加了它:)
gustavohenke 2014年

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
如果您在package.json中设置“ private”:true,则npm将拒绝发布它。参考:https://www.npmjs.org/doc/files/package.json.html
AlexStack 2014年

3
实际上,在较新版本的NPM中,软件包是否为私有都无关紧要。您必须有一个README.md文件。@gustavohenke答案更适合每个版本。
ViniciusPires 2014年

如果您只是用它来生成一些输出代码,而实际上并不需要完整的源代码包,那么这行得通。
尼尔·梦露

我会用类似的措辞来回答这个问题-当然,没有README.md文件的唯一原因是您的项目是私有的。因此,要么写一个适当的标志,README.md 要么设置私有标志。
rustyx

9

答案是将README.md添加到您的项目根目录,但是我注意到NPM花了很短的时间。也许几分钟?


2
的确,发布后,花一点时间更新NPM的列表。这是NPM支持的回应:“这只是网站缓存中的延迟,需要赶上发布。”
约书亚·品特

1

添加到package.json "readme": "README.md"


6
添加此属性将导致文本 “ README.md”显示在npmjs.com的详细信息页面上。显然,它是用于原始降价而不是文件名。
code_monk 2015年

但是,它确实删除了npm警告-只是不像此答案所暗示的那样。
rogersillito 2015年

@code_monk,以便我们可以编写类似“请参阅README.md ”的内容
aloisdg移至codidact.com,2016年

1
您可以,但是AFAIK只需在仓库的根目录添加README.md即可解决此警告;这是一个好主意,它将帮助您的用户理解您的软件如何工作
code_monk '16

0

截至今天,2017年4月,只需在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]

然后更新0.3.53-beta为最新0.3.61-beta

npm dist-tag add SOME_PACKAGE@0.3.61-beta

3. npm show检查agin

与步骤1相同

回到您的npm软件包站点,一切都刷新了!


希望对您有所帮助,谢谢〜

[中文教学]希望对您有帮助,谢谢〜

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.