杭州电子商务研究院

从 GitHub 安装 NPM 包

2020-11-09 08:00飞浪

介绍

NPM 是一个Node 包管理工具,用于通过npm 包注册表下载或发布 Node 包。它与node.js设置捆绑在一起。npmjs提供了许多开源包,例如 Lodash、React 和 Chalk,以加速开发过程。

通常,软件包不会发布在npmjs注册表上,但仍可以使用npm CLI 工具在节点项目中使用它们。本指南介绍了从 GitHub 安装公共和私有 NPM 软件包的详细信息。

从 Github 安装软件包

npm命令可以使用install命令从npmjs注册表安装公共包:

      npm install package-name package-name2
# or 
npm i package-name package-name2
    

有时软件包未在npmjs注册表上发布,但仍可以使用npm安装。npm工具可以从 GitHub 访问并安装任何公共节点项目作为依赖项:

npm命令将尝试使用git clone安装该包。npm命令还可以使用提交哈希值从不同的 GitHub 存储库状态安装包,该哈希值可用于安装具有提交 id 的包:

      npm install use_name/node_project#commit
    

注意:@符号代表npm范围,这是一种将用户或组织的所有依赖项分组到文件夹中的技术。没有@且带有name\name模式的软件包名称将被视为 GitHub 软件包存储库。

分支名称可用于将分支安装为包:

      npm install use_name/node_project#branch_name
    

类似地,标签或版本名称可用于安装 GitHub 包的特定版本:

      npm install use_name/node_project@tag #user_name/node_project@release
npm install use_name/node_project@version #user_name/node_project@1.0.0
    

还可以使用gist的 id 添加gist:

      npm install gist/gist_id
    

从 Github 安装私有软件包

可以使用 SSH 存储库链接从私有 GitHub 存储库安装npm包。SSH 链接仅供登录用户使用,可用于访问 GitHub 的私有存储库。SSH 协议使用公钥加密算法来验证访问 GitHub 存储库的命令,并且 [需要使用 SSH 密钥配置 GitHub 帐户]。可以使用 git +ssh作为协议安装私有 GitHub 存储库:

      npm install git+ssh://git@github.com:user_name/node_project.git
    

注意: GitHub 包必须有一个有意义的package.json文件才能作为包安装。

附加 NPM 安装标志

npm install命令还提供许多其他功能。例如,range可用于安装具有给定版本范围的包:

      npm install use_name/node_project">=1.0.0 <=2.0.0"
    

版本通常基于semver。--force将从远程软件包存储库安装软件包:

      npm install pacakge_name --force
    

全局包安装在全局 npm 包文件夹中,每个项目都可以访问该文件夹:

      npm install pacakge_name -global
    

--ignore-scripts标志用于跳过npm-scripts块的执行。最后,uninstall命令用于从本地项目中删除依赖项,-g标志用于删除全局依赖项。

尖端

  • 也可以使用以下方法安装特定分支:
  • 在使用任何依赖项之前,请仔细阅读存储库许可证。
  • 在npmtrends上查找有用的见解。
  • 使用Bit工具将项目中的组件作为独立包进行分发。
  • 使用简短的别名,例如npm i package-name和npm版本 5 或更高版本,不带--save选项。npm 5+ 将自动将该包添加为依赖项。

结论

GitHub 上的npm安装对于测试软件包非常有用。它还可以灵活地安装任何特定的分支、版本、标签等。祝您编码愉快!

了解更多

探索 Pluralsight 的这些 GitHub 课程以继续学习:

曝光33290浏览1738