了解可执行的NPM包
npm
是node.js
的包管理工具,随着node.js
的出现,以及前端开发开始使用gulp
、webpack
、rollup
以及其他各种优秀的编译打包工具(大多数采用node.js
来实现),大家都开始接触到一些node.js
,发现了使用npm
来管理一些第三方模块会很方便。
大家搬砖的模式也是从之前的去插件官网下载xxx.min.js
改为了npm install xxx
,然后在项目中require
或者import
。
当然,npm
上边不仅仅存在一些用来打包、引用的第三方模块,还有很多优秀的工具(包括部分打包工具),他们与上边提到的模块的区别在于,使用npm install xxx
以后,是可以直接运行的。
常见的那些包
可以回想一下,webpack
官网中是否有过这样的字样:
> npm install webpack -g > webpack
当然,现在是不推荐使用全局安装模式的,具体原因会在下边提到
以及非全局的安装使用步骤:
> npm install webpack
然后编辑你的package.json
文件:
{ "scripts": { + "webpack": "webpack" } }
再使用npm run
就可以调用了:
> npm run webpack
以上非全局的方案是比较推荐的做法
不过还可以顺带一提的是在npm 5.x
更新的一个新的工具,叫做npx
,并不打算细说它,但它确实是一个很方便的小工具,在webpack
官网中也提到了简单的使用方法
就像上边所提到的修改package.json
,添加scripts
然后再执行的方式,可以很简单的使用npx webpack
来完成相同的效果,不必再去修改额外的文件。(当然,npx
可以做更多的事情,在这里先认为它是./node_modules/webpack/bin/webpack.js
的简写就好了)
包括其他常用的一些,像n
、create-react-app
、vue-cli
这些工具,都会直接提供一个命令让你可以进行操作。
自己造一个简易的工具
最近面试的时候,有同学的回答让人哭笑不得:
q:你们前端开发完成后是怎样打包的呢?
a:npm run build
。
[黑人问号脸.png]。经过再三确认后,该同学表示并没有研究过具体是什么,只知道执行完这个命令以后就可以了。
我本以为这仅仅是网上的一个段子,但没想到真的被我碰到了。也不知道是好事儿还是坏事儿。。
从我个人的角度考虑,还是建议了解下你所使用的工具。至少看下scripts
里边究竟写的是什么咯 :)
p.s. npm scripts
中不仅仅可以执行npm
模块,普通的shell
命令都是支持的
创建工程
首先的第一步,就是你需要有一个文件夹来存放你的npm
包,因为是一个简单的示例,所以不会真实的进行上传,会使用npm ln
来代替npm publish
+ npm install
。
随便创建一个文件夹即可,文件夹的名字也并不会产生太大的影响。
然后需要创建一个package.json
文件,可以通过npm init
来快速的生成,我个人更喜欢添加-y
标识来跳过一些非必填的字段。
> mkdir test-util > cd test-util > npm init -y
创建执行文件
因为我们这个模块就是用来执行使用的,所以有没有入口文件实际上是没有必要的,我们仅仅需要创建对应的执行文件即可,需要注意的一点是:与普通的js
文件区别在于头部一定要写上#!/usr/bin/env node
#!/usr/bin/env node // index.js console.log('first util')
注册执行命令
然后就是修改package.json
来告诉npm
我们的执行文件在哪:
{ + "bin": "./index.js" }
在只有一个bin
,且要注册的命令与package.json
中的name
字段相同时,则可以写成上边那种形式,如果要注册多个可执行命令,那么就可以写成一个k/v
结构的参数:
{ "bin": { "command1": "./command1.js", "command2": "./command2.js" } }
调用时就是 command1 | command2
模拟执行
接下来我们去找另一个文件夹模拟安装npm
模块,再执行npm ln
就可以了,再执行对应的命令以后你应该会看到上边的log
输出了:
> cd .. && mkdir fake-repo && cd fake-repo > npm ln ../test-util > test-util # global first util > npx test-util # local first util
这样一个最简易的可执行包就创建完成了。
npm ln 为 npm link 的简写
npm ln 相当于 cd && npm ln + npm ln
要注意是 模块名,而非文件夹名, 模块名 为package.json
中所填写的name
字段模块名>模块路径>模块路径>
global 与 local 的区别
因为npm link
执行的,会将global
+local
的依赖都进行安装,所以在使用上不太好体现出两者的差异,所以我们决定将代码直接拷贝到node_modules
下:
> npm unlink --no-save test-util # 仅移除 local 的依赖 > cp -r ../test-util ./node_modules/ > npm rebuild
因为绕过了npm
的安装步骤,一定要记得npm rebuild
来让npm
知道我们的包注册了bin
这时候我们修改脚本文件,在脚本中添加当前执行目录的输出
#!/usr/bin/env node - console.log('first util') + console.log(process.execpath) // 返回js文件上层文件夹的完整路径
这时再次执行两种命令,就可以看到区别了。
之所以要提到global
与local
,是因为在开发的过程中可能会不经意的在这里踩坑。
比如说我们在开发node
项目时,经常会用到nodemon
来帮助在开发期间监听文件变化并自动重启。
为了使用方便,很可能会将预定的一个启动命令放到npm scripts
中去,类似这样的:
{ "script": { "start": "nodemon ./server.js" } }
两者混用会带来的问题
这样的项目在你本地使用是完全没有问题的,但是如果有其他的同事需要运行你的这个项目,在第一步执行npm start
时就会出异常,因为他本地可能并没有安装nodemon
。
以及这样的做法很可能会导致一些其它包引用的问题。
比如说,webpack
实际上是支持多种语言编写config
配置文件的,就拿typescript
举例吧,最近也一直在用这个。
> webpack --config webpack.config.ts
这样的命令是完全有效的,webpack 会使用 ts 的解释器去执行对应的配置文件
因为webpack
不仅仅支持这一种解释器,有很多种,类似coffeescript
也是支持的。
所以webpack
肯定不能够将各种语言的解释器依赖都放到自身的依赖模块中去,而是会根据传入config
的文件后缀名来动态的判断应该添加哪些解释器,这些在webpack
的源码中很容易找到:
根据webpack
动态获取解释器的模块来看,.ts
类型的文件会引入这些模块:['ts-node/register', 'typescript-node/register', 'typescript-register', 'typescript-require']
,但是在webpack
的依赖中你是找不到这些的。
在源码中也可以看到,webpack
在执行config
之前动态的引入了这些解释器模块。
这里也可以稍微提一下node
中引入全局模块的一些事儿,我们都知道,通过npm install
安装的模块,都可以通过require('xxx')
来直接引用,如果一些第三方模块需要引入某些其他的模块,那么这个模块也需要存在于它所处目录下的node_modules
文件夹中才能够正确的引入。
首先有一点大家应该都知道的,目前版本的npm
,不会再有黑洞那样深的node_modules
了,而是会将依赖平铺放在node_modules
文件夹下。比如说你引入的模块a
,a
的内部引用了模块b
,那么你也可以直接引用模块b
,因为a
和b
都存在于node_modules
下。
还是拿我们刚才做的那个小工具来实验,我们在fake-repo
中添加express
的依赖,然后在test-util
中添加koa
的依赖,并在test-util/index.js
中require
上述的两个模块。
你会发现,npx test-util
运行正确,而test-util
却直接报错了,提示express
不存在。
我们可以通过npm
的一个命令来解释这个原因:
> npm root <current>/node_modules > npm root -g <global>/node_modules
这样输出两个路径应该就能看的比较明白了,koa
模块是没有问题的,因为都是存在于这些路径下的node_modules
,而express
则只存在于<current>/node_modules/test-util/node_modules
下,全局调用下,require
是找不到express
的。
# global 下的结构 . ├── /usr/local/lib/node_modules # npm root 的位置 │ ├── koa │ └── test-util # 执行脚本所处的位置 └── <workspace> # 本地的项目 ├── node_modules │ └── express └── . # local 下的结构 └── <workspace> # 本地的项目 ├── node_modules # npm root 的位置 │ ├── koa │ ├── test-util # 执行脚本所处的位置 │ └── express └── .
所以这也从侧面说明了为什么webpack
可以直接在自己的文件中引用并不存在于自己模块下的依赖。
因为webpack
认为如果你要使用typescript
,那么一定会有对应的依赖,这个模块就是与webpack
同级的依赖,也就是说webpack
可以放心的进行require
,大致这样的结构:
├── node_modules # npm root 的位置 │ ├── webpack │ └── typescript └── . # 在这里执行脚本
以及一个相反的栗子
下一篇: 年夜饭都有什么寓意