Node.js package.json是否需要位于存储库的根目录下?

时间:2015-02-26 21:20:45

标签: javascript node.js git github package.json

我有一个Node.js包,它当前位于GitHub存储库的子目录中。我现在可以在不设置存储库字段的情况下发布它,但随后我的用户将收到警告,并且Node Package Repository页面上的有用信息少于它们可能的信息(缺少问题和请求链接链接)。

如果我将repository中的package.json字段设置为指向父存储库,那会有效吗?有什么事情会因为package.json文件不在该存储库的根目录(尤其是npm)而中断吗?

1 个答案:

答案 0 :(得分:3)

  

如果我将package.json中的repository字段设置为指向父存储库,那会起作用吗?

是。任何关键的npm功能都不使用此字段。如果贡献者想要克隆一个回购,那么他们可以在项目上工作。

  

因为package.json文件不在该存储库的根目录(尤其是npm)会有什么问题吗?

没有。我不相信任何事情会破裂。

  • 您应该将repository字段设置为父项目的顶级.git路径。此字段的目的是让SCM(git等)能够克隆项目。在您的情况下,最接近的是父项目。这应该避免警告信息。
  • 您应该将bugs字段设置为问题页面。这应该出现在npm网站上。我不认为repositorybugs是直接相关的,或者是基于另一个npm的假设。
  • 如果您没有其他网站,可以将homepage设置为父级仓库中包含此npm模块的目录的github URL。在那里粘贴一个README.md文件,github将它呈现在目录内容下面。