30

npx 使用教程

 5 years ago
source link: http://www.ruanyifeng.com/blog/2019/02/npx.html?amp%3Butm_medium=referral
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

npm 从5.2版开始,增加了 npx 命令。它有很多用处,本文介绍该命令的主要使用场景。

zIf6vei.jpg!web

Node 自带 npm 模块,所以可以直接使用 npx 命令。万一不能用,就要手动安装一下。

$ npm install -g npx

调用项目安装的模块

npx 想要解决的主要问题,就是调用项目内部安装的模块。比如,项目内部安装了测试工具Mocha。

$ npm install -D mocha

一般来说,调用 Mocha ,只能在项目脚本和 package.json 的 scripts 字段里面, 如果想在命令行下调用,必须像下面这样。

# 项目的根目录下执行
$ node-modules/.bin/mocha --version

npx 就是想解决这个问题,让项目内部安装的模块用起来更方便,只要像下面这样调用就行了。

$ npx mocha --version

npx 的原理很简单,就是运行的时候,会到 node_modules/.bin 路径和环境变量 $PATH 里面,检查命令是否存在。

由于 npx 会检查环境变量 $PATH ,所以系统命令也可以调用。

# 等同于 ls
$ npx ls

注意,Bash 内置的命令不在 $PATH 里面,所以不能用。比如, cd 是 Bash 命令,因此就不能用 npx cd

避免全局安装模块

除了调用项目内部模块,npx 还能避免全局安装的模块。比如, create-react-app 这个模块是全局安装,npx 可以运行它,而且不进行全局安装。

$ npx create-react-app my-react-app

上面代码运行时,npx 将 create-react-app 下载到一个临时目录,使用以后再删除。所以,以后再次执行上面的命令,会重新下载 create-react-app

下载全局模块时,npx 允许指定版本。

$ npx [email protected] main.js -o ./dist/main.js

上面代码指定使用 3.1.0 版本的 uglify-js 压缩脚本。

注意,只要 npx 后面的模块无法在本地发现,就会下载同名模块。比如,本地没有安装 http-server 模块,下面的命令会自动下载该模块,在当前目录启动一个 Web 服务。

$ npx http-server

--no-install 参数和 --ignore-existing 参数

如果想让 npx 强制使用本地模块,不下载远程模块,可以使用 --no-install 参数。如果本地不存在该模块,就会报错。

$ npx --no-install http-server

反过来,如果忽略本地的同名模块,强制安装使用远程模块,可以使用 --ignore-existing 参数。比如,本地已经全局安装了 create-react-app ,但还是想使用远程模块,就用这个参数。

$ npx --ignore-existing create-react-app my-react-app

使用不同版本的 node

利用 npx 可以下载模块这个特点,可以指定某个版本的 Node 运行脚本。它的窍门就是使用 npm 的 node 模块

$ npx [email protected] -v
v0.12.8

上面命令会使用 0.12.8 版本的 Node 执行脚本。原理是从 npm 下载这个版本的 node,使用后再删掉。

某些场景下,这个方法用来切换 Node 版本,要比 nvm 那样的版本管理器方便一些。

-p 参数

-p 参数用于指定 npx 所要安装的模块,所以上一节的命令可以写成下面这样。

$ npx -p [email protected] node -v 
v0.12.8

上面命令先指定安装 [email protected] ,然后再执行 node -v 命令。

-p 参数对于需要安装多个模块的场景很有用。

$ npx -p lolcatjs -p cowsay [command]

-c 参数

如果 npx 安装多个模块,默认情况下,所执行的命令之中,只有第一个可执行项会使用 npx 安装的模块,后面的可执行项还是会交给 Shell 解释。

$ npx -p lolcatjs -p cowsay 'cowsay hello | lolcatjs'
# 报错

上面代码中, cowsay hello | lolcatjs 执行时会报错,原因是第一项 cowsay 由 npx 解释,而第二项命令 localcatjs 由 Shell 解释,但是 lolcatjs 并没有全局安装,所以报错。

-c 参数可以将所有命令都用 npx 解释。有了它,下面代码就可以正常执行了。

$ npx -p lolcatjs -p cowsay -c 'cowsay hello | lolcatjs'

-c 参数的另一个作用,是将环境变量带入所要执行的命令。举例来说,npm 提供当前项目的一些环境变量,可以用下面的命令查看。

$ npm run env | grep npm_

-c 参数可以把这些 npm 的环境变量带入 npx 命令。

$ npx -c 'echo "$npm_package_name"'

上面代码会输出当前项目的项目名。

执行 GitHub 源码

npx 还可以执行 GitHub 上面的模块源码。

# 执行 Gist 代码
$ npx https://gist.github.com/zkat/4bc19503fe9e9309e2bfaa2c58074d32

# 执行仓库代码
$ npx github:piuccio/cowsay hello

注意,远程代码必须是一个模块,即必须包含 package.json 和入口脚本。

参考链接

(完)


Recommend

  • 2
    • zhuanlan.zhihu.com 2 years ago
    • Cache

    记录一下 npx 的使用场景

    记录一下 npx 的使用场景中国科学院大学 计算机应用技术硕士npm 从5.2.0版本开始,开始增加了 npx 命令。简单来说,npx 是一个旨在帮助开发者更方便的使用 npm 模块的...

  • 8
    • www.wenyuanblog.com 2 years ago
    • Cache

    npm 和 npx 的区别

    npm 和 npx 的区别 npm:Node Package(包)Manager(管理器)npx :Node Package(包)Execute(执行) 众所周知,npm 是 Node.js 的软件包管理器,其目标是自动化的依赖性和软件包管理。 这意味着...

  • 4

    npx使用教程今晚在学习vue-Cli时, 由于突发奇想想试试最新的@4.x.x版本, 但是本地全局安装的脚手架版本是@2.x.x的, 因为不想污染全局于是就想到用npx命令, 一路上踩坑不断, 为了以后能够更好的使用npx并区...

  • 4

  • 5
    • kenanbek.medium.com 1 year ago
    • Cache

    How To Upgrade NVM, NPM, Node, and NPX

    How To Upgrade NVM, NPM, Node, and NPXAs a “backender” in the world of ̶J̶a̶v̶a̶S̶c̶r̶i̶p̶t̶ frontend, I was looking for commands and options on keeping versions of core components consistent. That’s mainly about NVM, NPM,...

  • 2

    npm,pnpm,yarn,npx的那些事儿更新日期: 2022-09-18阅读: 9标签: npm分享

  • 3
    • rubyweekly.com 1 year ago
    • Cache

    RubyGems' answer to npx

    Ruby Weekly Issue 644 Easy to unsubscribe at any time. Your e-mail address is safe — here's

  • 86
    • yalishizhude.github.io 6 years ago
    • Cache

    RxWX使用教程

    之前写过一个开源项目RxWX,将RxJS移植到微信小程序(以下简称”小程序“)中。 RxWX项目地址和介绍:https://github.co...

  • 61
    • 掘金 juejin.im 6 years ago
    • Cache

    cmake使用教程(七)-流程和循环

    【cmake系列使用教程】 cmake使用教程(一)-起步 cmake使用教程(二)-添加库 cmake使用教程(三)-安装、测试、系统自检 cmake使用教程(四)-文件生成器 cmake使用教程(五)-cpack生成安装包 cmake使用教程(六)-蛋疼的

  • 60

    安装完之后, 先开始一个案例, 熟悉一下mycat中间件。

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK