在前端开发中，我们经常需要使用 Github 上的项目进行开发和协作。在这样的情况下，获取 Github 仓库的信息是非常重要的一步。而 github-url-to-object 是一个可以将 Github 仓库地址转换为对象格式的 npm 包，可以大大简化我们获取 Github 仓库信息的工作。
安装
首先，我们需要安装 github-url-to-object 包。在终端中输入以下命令即可：
--- ------- ------ --------------------
使用
安装完毕后，我们就可以在项目中引入 github-url-to-object 包了。接下来，让我们看看如何使用它来获取 Github 仓库的信息。
引入包
我们可以通过 require 或者 import 的方式引入 github-url-to-object 包：
-- ------- ----- ----- - -------------------------------- -- ------ ------ ----- ---- -----------------------
转换 Github 仓库地址
我们可以使用 parse 函数将 Github 仓库地址转换为对象格式。例如，我们想要获取 https://github.com/facebook/react 这个仓库的信息，我们可以使用以下代码：
----- --- - ------------------------------------ ----- ---- - ----------- ------------------
控制台将会输出以下信息：
- ----- ----------- ----- -------- ------- ----- --------- ----- ---------- ---------------------------------------- ------------ ------------------------------------------------------ ---------- ---------------------------------------- -------- ------------------------------------ --------- --------------------------- -
可以看到，parse 函数返回了一个包含 Github 仓库信息的对象，我们可以根据需要使用其中的属性。
获取分支和文件路径
在实际开发中，我们经常需要获取 Github 仓库的指定分支或者指定文件的信息。这时，我们可以在 Github 仓库地址后面添加 /tree/分支名 或者 /blob/分支名/文件路径 来获取指定分支或文件的信息。
例如，我们想要获取 https://github.com/facebook/react 这个仓库的 README.md 文件在 main 分支下的信息，我们可以使用以下代码：
----- --- - -------------------------------------------------------- ----- ---- - ----------- ------------------
控制台将会输出以下信息：
- ----- ----------- ----- -------- ------- ------- --------- ------------ ---------- ---------------------------------------- ------------ ----------------------------------------------------------- ---------- ---------------------------------------- -------- -------------------------------------------------------- --------- --------------------------- -
可以看到，parse 函数返回的对象中，branch 属性表示分支名，filepath 属性表示文件路径。
总结
使用 github-url-to-object 包可以方便地将 Github 仓库地址转换为对象格式，从而快速获取 Github 仓库的信息。在实际开发中，我们也经常需要获取指定分支或者指定文件的信息，这时可以通过在 Github 仓库地址后面添加 /tree/分支名 或者 /blob/分支名/文件路径 来获取。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/42399