【问题标题】:how to add link of my github repo to npm package?如何将我的 github 存储库的链接添加到 npm 包?
【发布时间】:2018-01-22 18:30:51
【问题描述】:

我需要将我的github 存储库的链接添加到我的npm 包中。我还没有在npm 文档中找到解决方案。

【问题讨论】:

    标签: github npm


    【解决方案1】:

    您在 package.json 中有一个名为 repository 的字段。如果没有,你可以自己做。在此处添加 GitHub 存储库 URL:

    "repository": {
      "type": "git",
      "url": "https://github.com/your-user/repo-url.git"
    },
    

    确保将 git 指定为类型,并且 URL 指向实际的存储库,而不是 HTML 页面。所以 URL 必须以 .git 结尾。您可以复制/粘贴在 GitHub 上单击克隆或下载按钮时找到的 URL。

    还有一个名为 homepage 的字段,您可以使用它来指向存储库登录页面。

    顺便说一下,文档是here

    【讨论】:

    • 你真的需要最后的.git吗?
    • "repository": "github:user/repo" 见:docs.npmjs.com/files/package.json#repository
    • 是否可以在子文件夹上设置 npm 点?例如,我有 "url" 指向 repo 本身,还有一个 "directory" 字段指向 repo 内的包本身。但是 npm 仍然指向根存储库,而不是将目录添加到链接中。
    • @Alendorff 这似乎是可能的:docs 说“如果你的包的 package.json 不在根目录中(例如,如果它是 monorepo 的一部分),你可以使用repository 对象的directory 属性指定它所在的目录。
    猜你喜欢
    • 2013-07-01
    • 2021-08-31
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2017-08-29
    • 2021-08-03
    • 2019-03-06
    • 2022-11-29
    相关资源
    最近更新 更多