npm 包 git-url-uglify 使用教程

简介

在前端开发中，我们经常需要从 GitHub 上获取代码库。通常情况下，在网页上直接复制代码仓库的地址是非常难看的，往往不可能在项目中使用它。为了解决这个问题，有一个的 npm 包 git-url-uglify，可以将 GitHub 仓库的网址缩短成简洁的格式，使得这些地址可以更方便地嵌入项目中。

安装

使用 npm 安装 git-url-uglify：

npm install git-url-uglify

如果需要全局安装这个包：

npm install -g git-url-uglify

使用

git-url-uglify 提供了一个非常简单的 API，只需要提供仓库地址，就可以得到缩短的仓库地址。

const gitUrlUglify = require('git-url-uglify');

const url = 'https://github.com/facebook/create-react-app.git';

gitUrlUglify(url).then(res => {
  console.log(res);
  // => 'facebook/create-react-app'
});

不仅如此，在命令行中也可以使用这个 npm 包，一行命令就可以得到缩短的仓库地址：

npx git-url-uglify https://github.com/facebook/create-react-app.git
# => facebook/create-react-app

甚至可以自己编写脚本，自动将缩短后的网址嵌入到项目中。

应用示例

当使用 git-url-uglify 后，我们就可以将简化后的地址嵌入到项目中，以进行相关操作 - 比如下载某个包或者克隆代码仓库。

在 package.json 中，如果需要引用某个 GitHub 上托管的包，例如 gitbook-plugin-fontsettings，我们可以使用如下格式：

{
  "name": "my-awesome-npm-package",
  "dependencies": {
    "gitbook-plugin-fontsettings": "git://github.com/GitbookIO/plugin-fontsettings.git#v1.1.0"
  }
}

这个地址太长了，很难用于其他用途。使用 git-url-uglify 可以将以上代码改写成：

{
  "name": "my-awesome-npm-package",
  "dependencies": {
    "gitbook-plugin-fontsettings": "git+https://github.com/GitbookIO/plugin-fontsettings.git#v1.1.0"
  }
}

这个地址更简洁，可以很方便地嵌入项目中。

结束语

git-url-uglify 是一个非常好用的 npm 包，它可以让我们在前端开发时更加方便的获取到 GitHub 上各种仓库地址，对于快速引用某些包或者模块都非常有用。希望这篇文章能为你提供帮助，让你的项目更加简洁而易懂。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055cb781e8991b448da3cb