在前端开发中，我们通常会使用 GitHub 来托管我们的代码库，从而实现版本控制。GitHub 中的项目都有一个唯一的链接地址（URL），通常称之为 GitHub 仓库地址。但是，假如我们使用 Git 协议或者 SSH 协议来访问 GitHub 的代码库，这时候的 URL 是完全不同的。因此，我们需要一个工具来将该地址统一转换成唯一的 GitHub 仓库地址，这就是 npm 包 @types/github-url-from-git 的作用。
什么是 @types/github-url-from-git？
@types/github-url-from-git 是一个 TypeScript 类型定义文件的 npm 包，提供了从 Git 或 SSH URL 获取 GitHub URL 的功能。如果你想在 TypeScript 项目中使用 github-url-from-git 包，那么你需要使用 @types/github-url-from-git 这个类型定义文件。
如何使用 @types/github-url-from-git？
在你的项目中使用 @types/github-url-from-git，需要进行以下步骤。
步骤一：安装 @types/github-url-from-git
在你的 TypeScript 项目中，在终端中运行以下命令：
--- ------- ---------- --------------------------
步骤二：引入 @types/github-url-from-git
安装完毕后，在你的 TypeScript 代码文件中，引入 githubUrlFromGit 方法：
------ ---------------- ---- ----------------------
步骤三：使用 github-url-from-git 获取 GitHub 仓库地址
使用 github-url-from-git 方法来获取 Github 仓库地址，传入 Git 或 SSH URL，即可得到 GitHub 仓库地址：
----- ------------- - --------------------------------------------------- --------------------------- -- ----------------------------
示例代码
下面是一个完整使用示例的 TypeScript 代码：
------ ---------------- ---- ---------------------- ----- ------ - --------------------------------- ----- ------------- - ------------------------- -------------------- ------------ --------------------------- -------------------
运行结果：
------- ------------------------------ -------------- ----------------------------
总结
@types/github-url-from-git 是一个非常方便的 npm 包，可以在 TypeScript 项目中方便地获取 GitHub 仓库地址。在实际项目中，我们可以根据需求将该方法封装在自己的工具类中，以方便自己的开发。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/5f7078efa9b7065299ccbb00