npmjs.org - 无法找到自述文件

Question

我是 npm 包 scramjet 的主要作者 - 自一个月以来，我对 npmjs 中 README.md 的可见性有疑问。

scramjet package in npm显示：

"Unable to find a readme for scramjet@4.33.2"

但同时 README.md 文件在那里并且 npm 命令不会抱怨任何信息。

我检查了这是否是由以下原因引起的：

• 外部图片
• 自述文件的长度
• 我再次尝试发布

README shows up nicely in github and the file is also added to package.json/files here.

我尝试了 npm 支持，但他们停止回复，所以也许这里有人有想法？

编辑： 我从 github 获得的 tarball 发布这个 - 所以 npm publish <url from gh>

Answer 1

您的 scramjet-4.33.2.tgz 存档，当前存在于 npm 注册表中，提取后会生成类似于以下目录结构的内容：

scramjet-4.33.2          <-----
├── CHANGELOG.md
├── CNAME
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
├── docs
│   └── ...
├── greenkeeper.json
├── gulpfile.js
├── jsconfig.json
├── jsdoc2md
│   └── ...
├── lib
│   └── ...
├── package-lock.json
├── package.json
└── ...

注意：根目录（如上所示）的名称当前为scramjet-4.33.2

NPM 期望根目录被命名为 package 因此它无法找到 README.md.

为了进一步说明，您的 .tgz 目录结构应如下所示：

package                  <----- Note: changed to `package`
├── CHANGELOG.md
├── CNAME
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
├── docs
│   └── ...
├── greenkeeper.json
├── gulpfile.js
├── jsconfig.json
├── jsdoc2md
│   └── ...
├── lib
│   └── ...
├── package-lock.json
├── package.json
└── ...

问题作者编辑：

另外一些背景 - 如果您尝试直接从以前工作的 github 版本发布包，就会发生上述情况，所以不要再这样做了：

npm publish https://github.com/anorg/arepo/archive/v1.2.3.tar.gz

而是使用 npm pack 创建一个 tarball 或只是 运行 npm publish 在你的工作副本中。