GitUrl 是一个 Node.js 模块,用于从 Git URL 中提取有关仓库的信息。 它可用于构建各种自动化工具和脚本,例如自动版本控制、自动发布等。
安装
可以使用 npm
来安装 GitUrl:
npm install giturl --save
用法
const GitUrl = require('giturl'); const url = 'https://github.com/npm/giturl.git'; const gitUrlObj = new GitUrl(url); console.log(gitUrlObj);
输出结果:
-- -------------------- ---- ------- - ---------- ---------- --------- -------- ----- ----- --------- ------------- ----- ----- --------- ------------------ ----- --- ------- --- ----- ------------------------------------ ------ ----- ------------- ---------- -------- -------- ------- -
API 参考
new GitUrl(url)
参数:
url
<string> - Git URL 字符串。
返回值:
- <GitUrl> - GitUrl 对象实例。
方法
.protocols
类型: Array<string>
返回一个数组,包含 Git URL 的协议列表。
.protocol
类型: string
返回 Git URL 的主要协议。
.port
类型: number|null
返回 Git URL 的端口号(如果存在)。
.resource
类型: string
返回 Git URL 的资源名称。
.user
类型: string|null
返回 Git URL 中的用户名(如果存在)。
.pathname
类型: string
返回 Git URL 中的路径名(不包括协议、主机和端口号部分)。
.hash
类型: string
返回 Git URL 的哈希值(如果存在)。
.search
类型: string
返回 Git URL 的查询字符串(如果存在)。
.href
类型: string
返回 Git URL 的完整 URL 地址。
.token
类型: string|null
返回 Git URL 中的访问令牌(如果存在)。
.protocolLong
类型: string
返回 Git URL 的协议全称。
示例代码
-- -------------------- ---- ------- ----- ------ - ------------------ ----- --- - ------------------------------------ ----- --------- - --- ------------ ------------------ ------------------------- ------------------ ------------------------ ----------------- -------------------- ------------------ ------------------------ ----------------- -------------------- ----------------- ------------------------ ----------------- -------------------- ------------------- ---------------------- --------------- --- --- -------------------- ------------------ --------------------- ------------------ ----------------------------
输出结果:
-- -------------------- ---- ------- ----- ----- ----- ----- ---- ---- ----- ---------- ---- ---- ---- --------------- ---- ------ -- --- --- --------------------------------- ----- ---- ----- --------- -------- -------- ------
结论
通过使用 GitUrl 模块,我们可以轻松地从 Git URL 中提取有关仓库的各种信息。 这种工具非常有用,因为它可以被用于构建各种自动化工具和脚本,例如自动版本控制、自动发布等。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/44590