NPM - 如何修复"无自述数据"

ian*_*her 188 npm

我有一个简单的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": ""
  }
}
Run Code Online (Sandbox Code Playgroud)

当我执行"npm install"时,我得到以下警告,我想修复它:

"npm WARN package.json camapaign@0.0.1 No readme data."
Run Code Online (Sandbox Code Playgroud)

我尝试将"README.md"和"readme.txt"添加到与包相同的目录中,但没有任何乐趣.我错过了什么?

gus*_*nke 225

简单地添加README.md文件不会修复它,你应该在里面写一些东西; 至少项目名称和简要说明对人们有好处!但对于NPM,一个字节可能就够了......
这样做应该停止显示警告.

此外,当您阅读该警告时,请确保该问题与第三方软件包无关.

  • 我有这个问题,我有一个非空的README文件......:/ (19认同)
  • @gustavohenke我是多么愚蠢,你是对的 - 警告是针对一个包,而不是我的应用程序 (4认同)
  • 我也有一个`README.md`文件,里面有一大堆东西和我的`package.json`在同一个目录里,但仍然得到这个(与karma-coffee-preprocessor有关) (3认同)
  • 是的,和@Conan一样.填充了`README.md`文件,仍然收到错误. (2认同)
  • @NathanHornby因为它对你有用,我在答案中加了:) (2认同)

小智 176

只需设为私人;)

{
  "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": ""
  }
}
Run Code Online (Sandbox Code Playgroud)

  • 应该注意的是,属性`private`告诉npm这不是一个打算在npm存储库上可用的项目.您可以看到有人已经询问该属性用于什么http://stackoverflow.com/a/7314961/1128216 (5认同)
  • 实际上,在较新版本的NPM中,无论包装是否私密都无关紧要.你必须有一个`README.md`文件.@gustavohenke回答每个版本更适合. (3认同)
  • 如果你在package.json中设置"private":true,那么npm将拒绝发布它.ref:`https:// www.npmjs.org/doc/files/package.json.html` (2认同)

Ric*_*nho 9

将README.md添加到项目根目录就是答案,但我注意到NPM需要一段时间来接受它.也许几分钟?

  • 确实,在您发布之后需要花一点时间来更新NPM的列表.以下是NPM支持的回复:"这只是网站缓存需要赶上发布的延迟." (2认同)