怎么样写一个能告诉你npm包名字是否被占用的工具

2022-12-01,,,,

事情是这样的:

因为我经常会写一些npm包,但是有时候我写完一个包,npm publish 的时候却被提示说包名字被占用了,要不就改名字,要不就加scope,很无奈。
npm 命令行可以通过 npm view 的方式去得知一个包是否存在,但是无法批量得知,所以就想着写一个工具来批量选名:)

本教程的相关代码已经全上传到github: 源代码

NPM方式

在写工具之前,我们先看看怎么通过 npm 提供的命令来得知包名是否被占用。

npm view

通过 npm view -h 我们可以得知其用法:

npm view [<@scope>/]<pkg>[@<version>] [<field>[.subfield]...]

aliases: v, info, show

通过以上命令来看看 unused-npm-names 包:

```npm view unused-npm-names
# 或者
npm info unused-npm-names
```

会输出:


{ name: 'unused-npm-names',
'dist-tags': { latest: '1.1.1' },
versions: [ '1.0.0', '1.0.1', '1.1.0', '1.1.1' ],
time:
{ created: '2018-09-07T02:53:05.277Z',
'1.0.0': '2018-09-07T02:53:05.439Z',
modified: '2018-09-07T03:44:06.363Z',
'1.0.1': '2018-09-07T03:07:46.542Z',
'1.1.0': '2018-09-07T03:35:40.221Z',
'1.1.1': '2018-09-07T03:44:03.534Z' },
maintainers: [ 'pjy &lt;731401082@qq.com&gt;' ],
description: 'Find unused npm names',
homepage: 'https://github.com/PengJiyuan/unused-npm-names#readme',
keywords: [ 'npm', 'names', 'unused', 'find' ],
repository:
{ type: 'git',
url: 'git+https://github.com/PengJiyuan/unused-npm-names.git' },
author: 'PengJiyuan',
bugs:
{ url: 'https://github.com/PengJiyuan/unused-npm-names/issues' },
license: 'MIT',
readmeFilename: 'README.md',
version: '1.1.1',
main: 'index.js',
bin: { unn: 'cli.js' },
scripts: { test: 'echo "Error: no test specified" &amp;&amp; exit 1' },
dependencies: { axios: '^0.18.0', chalk: '^2.4.1', commander: '^2.17.1' },
gitHead: '818611db1c2baeb589cb3f639559ab6afc9f8e8f',
dist:
{ integrity: 'sha512-t9bCfY3qbeVY54QC6Cznn3YhM0jq6HX0fE0r5TMAq1IOzu+NQ/caA8tfj62pZtDuZKb9R29ne7UyPB+4zAAplw==',
shasum: '0b7c162f7656c0d74868bf567713150488f8c473',
tarball: 'https://registry.npmjs.org/unused-npm-names/-/unused-npm-names-1.1.1.tgz',
fileCount: 5,
unpackedSize: 4544,
'npm-signature': '-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbkfQDCRA9TVsSAnZWagAAwS4QAKFC1MnosxmJEws07U4O\ngfUPLP04ZLZqtW6nuB/29A72DE1+bh/TGsir83r/sYf1TAPSLOCRd3Nrky3A\n7+umUUOl5zGU5WyG86Fo2XOl5cYgXXWXU6LcZufG/cwM3Xi9MUfxnT7zCEWt\nQPAE8Oh9UhkWCnvFMBA6M6knqK9K08nQf0Ke55UoiuX+OqF8BUlNw8LqEwrI\nMTW8hpjKqsAdo3JhBu0ZkrfTRMq7cTawfjAg+qDs4SSTuWD9OJ9d/2y4OC/p\nX6+3I+Et+SqFJxjGDBounjF1GYYiH3dQPRN8UWL1p9Ypu6YsiZ7l8dp6RH15\nHFUv6lsCmZvhkKc1zO1pY67xUOA9VbLjhXtObwopFvCIehlv3cCw5FMwoa7x\nz+tou0J4II6n68cG6IfTt+9odi9abj7M2YxStW32Miu3efhpXiw2PpX3HWOW\njkY7IQryyxJbQIdKHJqJ59fADHLxpdmr6WADYWt8mKI+9TK9onpSgFgX4udw\ng7fXN3z/L6i7yY+0fvvX/b0jjVzVFNP5kFnUBSnWk/Hjm+h96QS+0xfRCRNv\n5CmVT2kbxYNAdFsFFoNCqHqE+uQoMrSwBw1SIJdybWjs84QrLOrDFjhKypev\nl6bzrgcyE0VWYY1A+zdyquL1cQ+xEJacsfN5NbicxTZhDU0enAtcxhKSe7bz\nJ9CP\r\n=t8xy\r\n-----END PGP SIGNATURE-----\r\n' },
directories: {} }

这样的输出太长了,我们可以只看 unused-npm-names 最近的版本号:

```npm view unused-npm-names version
```

会输出:


1.1.1

当然,如果这个包不存在的话,就会报 404 的错误,我们也就知道这个包名是否被占用了。

写个命令行工具

上面的方式是可以得到我们想要的结果,可是如果我想从一批名字中选一个可用的,就没有那么方便了,就要一个一个试了。

如果有一个工具可以像这样使用:

```unn react react-router react-dom react-pp react-fdasf
```

能一步鉴别所有的包,那就太方便了。

所以,我们一步一步来看一下应该怎么实现这个功能。

一、看npm如何做的

我们通过 npm view 可以查看一个包的信息,那么在走这个命令的时候,npm 肯定是发了一个请求去拿到的这个包的数据,那么我们怎么知道 npm 发的什么请求呢?

```# 加 --verbose 后缀来看详细的输出
npm view unused-npm-names --verbose
```

会输出:


... npm http request GET https://registry.npmjs.org/unused-npm-names ... npm info ok

我们在其中发现,npm 发了个 GET 请求,请求的url是 https://registry.npmjs.org/unused-npm-names

哦,那知道了,我们可以请求 https://registry.npmjs.org/${packageName} 来获取名为 packageName 的包信息。当然,在npm的官方仓库也能找到相关api的用法:package-metadata。

二、开始写工具

之前有一篇文章,讲了怎么写一个命令行工具,见这里:手把手教你写命令行工具。这篇文章就不从怎么从零开始构建一个命令行工具开始了,我们直接来代码:

文件目录大概是这样:


unused-npm-names
├── node_modules
├── package.json
├── cli.js (bin)
└── index.js (main)

package.json:


{
"name": "unused-npm-names",
"version": "1.0.0",
"description": "Find unused npm names",
"main": "index.js",
"bin": {
"unn": "cli.js"
},
"scripts": {
"test": "echo \"Error: no test specified\" &amp;&amp; exit 1"
},
"license": "MIT",
"dependencies": {
"axios": "^0.18.0",
"chalk": "^2.4.1",
"commander": "^2.17.1"
}
}

通过 package.json 中设置 bin 字段,我们将命令的名字设置为 unn,比较简短,方便实用。

我们把查询的主逻辑放到 index.js 中,把命令行逻辑放到 cli.js 中,这样的话我们既可以通过 cli 的方式去使用,也可以通过 require 的方式在 nodejs 脚本中使用。


// index.js
const axios = require('axios'); // 用于发送 http 请求
const chalk = require('chalk'); // 终端输出带颜色的文本

// search方法的参数是一个数组,存放着需要查询的包的名字
// 比如我们要查询 react和react-dom,那么search(['react', 'react-dom'])
function search(pkgs = []) {
if (!Array.isArray(pkgs)) {
throw 'Param should be an array.';
}

console.log();
pkgs.forEach((pkg) =&gt; {
axios.get(`https://registry.npmjs.org/${pkg}`)
.then((res) =&gt; {
// 如果请求成功,说明包存在,那么名字被占用。
console.log(`${chalk.cyan(pkg)}: ${chalk.red('Used ❌')}`);
})
.catch((err) =&gt; {
// 如果请求失败,并且是因为404报错,那么证明包不存在,名字可用。
if (err.stack &amp;&amp; /Request failed with status code 404/.test(err.stack)) {
console.log(`${chalk.cyan(pkg)}: ${chalk.green('Unused ✅')}`);
} else {
// 处理未知情况
console.log(`${chalk.cyan(pkg)}: ${chalk.gray('Unknown

怎么样写一个能告诉你npm包名字是否被占用的工具的相关教程结束。

  • 开发者必备实用工具

    工欲善其事必先利其器,今天给大家推荐一些程序员(开发者)用得上的实用开发工具,部分下载地址已经在链接中,需要的话可以自取。 1、文本编辑器——Notepad++ 相信绝大部分程序员用上它都会爱得死去活来。Notepa...

  • Java编码辅助工具Mapstruct用法详解

    前言 项目开发中,业务分层会涉及不同类型的Bean之间需要相互转换,如PO与DTO之间,PO与VO之间等。手动编码setter/getter各个对应属性,会显得臃肿繁琐。通过Mapstruct框架可简单方便地完成这一工作。 如何引入:...

  • vue之npm install报错问题如何解决

    这篇“vue之npm install报错问题如何解决”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看...

  • 使用Atom的一些心得

    1.关于主题:           1) LightStyle:: UI : One Light Syntax : Base16 Tommorrow Light           2) BlackStyle:: Atom Dark(推荐)     &nb...

  • Bootstrap 标签页和工具提示插件

    一.标签页 标签页也就是通常所说的选项卡功能。 //基本用法 <ul class="nav nav-tabs"> <li class="active"><a href="#html5" data-toggle="tab">HTML5</a></li> <li><a...

  • 基于打包工具Webpack进行项目开发实例

    一. 常见打包工具的介绍 在打包工具中,常见的有RequireJS,browserify,webpack,其中RequireJS是一个JavaScript模块加载器,基予ADM(async module define)规范实现,browserify是一个以在浏览器中使用Node.js模块为出...