繁体   English   中英

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

[英]Does a Node.js package.json need to be at the root of the repository?

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

如果我将package.jsonrepository字段设置为指向父存储库,那会起作用吗? 有什么东西会破坏因为package.json文件不在那个存储库的根目录下(尤其是npm)?

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

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

有什么东西会破坏,因为package.json文件不在该存储库的根目录下(尤其是npm)?

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

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

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM