浅析npm init、create、exec,npx。

npm-exec

npm exec

  • npm exec <pkg>

npm x

  • npm x <pkg>

npm官方文档中指出x,其实就是exec的别名,通俗来讲意思就是npm execnpm x,两个命令是完全等价的。

npm exec <pkg>的执行流程 - 在本地查找是否有<pkg>对应的npm包 - 若找到,则运行这个包的package.jsonbin字段对应的可执行文件 - 若未找到,在远程npm仓库查找是否有<pkg>对应的npm包 - 若找到,则提示是否下载到本地 - 下载完成后,再运行这个包package.jsonbin字段对应的可执行文件

同时,在执行bin字段有几点注意的 - 如果bin只有一个入口,那么可以执行 - 如果bin有多个入口,则寻找和包名一样的那个入口 - 如果没找到,则npm exec <pkg>报错

下面用create-vite这个npm包举个例子:

// 这是他的package.json中的字段,简单列举,省略很多
{
    "name": "create-vite"
    "bin": {
        "create-vite": "index.js",
        "cva": "index.js"
    }
    ...
}

执行npm exec crate-vite这条命令后 - 首先本地查找是否有create-vite这个npm包 - 找到,则运行create-vite这个npm包中的package.jsonbin字段对应的可执行文件,即index.js这个文件 - 若未找到,在远程npm仓库查找是否有create-vite这个包 - 若找到,则提示是否下载到本地 - 下载完成后,再运行这个包package.jsonbin字段对应的可执行文件,即index.js这个文件

看了bin字段的内容,我们不妨在执行一下npm exec cva这条命令,执行流程和上面的npm exec crate-vite也是一样的,但是执行后我们会发现,这个命令报错了,那么为什么呢?

那么我们来分析一下:执行npm exec cva这条命令后 - 首先本地查找是否有cva这个npm包 - 找到,则运行cva这个npm包中的package.jsonbin字段对应的可执行文件 - 若未找到,在远程npm仓库查找是否有cva这个包 - 若找到,则提示是否下载到本地 - 下载完成后,再运行这个包package.jsonbin字段对应的可执行文件

这样我们应该就明白了,执行npm exec cva这条命令后,我们其实是需要执行cva这个包中package.json文件中的bin字段,而不是create-vite这个包中的package.json文件中的bin字段。

说巧不巧,npm官方库中还真有cva这个包,他的package.json文件如下:

{
  "name": "cva",
  "version": "0.0.0",
  "description": "Awesome node module",
  "keywords": [
    "placeholder",
    "zce"
  ],
  "license": "MIT",
  "author": {
    "name": "zce",
    "email": "w@zce.me",
    "url": "https://zce.me"
  }
}

从上面我们可以看出,cva这个包的package.json中根本就没有bin字段,所以npm exec cva显然会报错。

npx

npm文档中提到:npx的二进制文件在npm v7.0.0中被重写,而独立的npx包在当时已弃用。npx使用npm exec命令,而不是单独的参数解析器和安装过程。并提供了一些支持,以保持与它在以前版本中接受的参数的向后兼容性。

因此我们姑且理解 npx = npm execnpm x

所以上面的npm exec create-vite我们也可以使用npx create-vite去执行

npm-init

npm init

  • npm init
  • npm init <initializer>

npm create

  • npm create
  • npm create <initializer>

npm innit

  • npm innit
  • npm innit <initializer>

npm官方文档中指出createinnit其实就是init的别名,通俗来讲意思就是,其实npm initnpm createnpm innit三个命令是完全等价的。

  • npm initnpm createnpm innit

这种后面没有<initializer>是用来创建package.json文件的

  • npm init <initializer>npm create <initializer>npm innit <initializer>

这里的npm init <initializer>实际会调用npm exec create-<initializer>, 也相当于npx create-<initializer>。 我们可以把这个<initializer>理解为 有特殊格式包名的包 的简称,它真正的包名为create-<initializer>,也只有符合这种特殊格式(create-<xxxx>)的包才可以执行这样的命令。

再用create-vite这个包举例,那么此时我们也可以通过执行npm create vitenpm init vitenpm innit vite这些命令来使用这个包了。

总结

综上,对于举例的create-vite这个包我们可以有多种方法使用:

npm init vite/ npm create vite/ npm innit vite

npm exec create-vite/ npm x create-vite

npx create-vite

类似的例如create-react-app这个包我们也可以有多种方法使用:

npm init react-app/ npm create react-app/ npm innit react-app

npm exec create-react-app/ npm x create-react-app

npx create-react-app

不过react的脚手架略有不同,当我们直接使用npx create-react-app的时候它会提示我们需要指定项目目录,即npx create-react-app <project-diretory>,我们只需要在npx create-react-app后加上一个项目名就行。

相同的create-nuxt-appcreate-next-app等等也是一样的原理。

 

轉載自: https://zhuanlan.zhihu.com/p/619991024

posted @ 2023-07-19 16:00  0龙行者0  阅读(176)  评论(0编辑  收藏  举报