输入npm run xxx后执行原理深入解析

输入npm run xxx后执行原理深入解析

1. npm run xxx的作用

npm run xxx是用来执行在项目package.json文件中scripts字段中定义的脚本命令xxx。

例如在package.json文件中，定义了以下脚本：

"scripts": {
  "start": "node app.js",
  "dev": "nodemon app.js"
}

那么，通过执行npm run start，就可以通过命令行启动一个node应用，执行npm run dev，则可以使用nodemon热加载工具启动应用。

2. npm run xxx的执行原理解析

当我们在命令行中输入npm run xxx时，发生了以下几个动作：

• npm首先会查找node_modules/.bin目录下，是否存在与xxx同名的命令行执行文件。
• 如果存在，则执行该命令行执行文件；如果不存在，则继续查找项目根目录下的node_modules/.bin目录，是否存在与xxx同名的命令行执行文件。
• 如果存在，则执行该命令行执行文件；如果仍然不存在，则抛出异常，并提示找不到该命令。

举个例子，假设在项目根目录下，存在一个名为eslint的命令行工具，并在package.json文件中定义了如下脚本：

"scripts": {
  "lint": "eslint src/**/*.js"
}

那么，通过执行npm run lint，npm会查找node_modules/.bin目录下是否存在eslint命令行执行文件，如果找到，则执行eslint命令，否则会继续查找项目根目录下的node_modules/.bin目录中是否存在eslint命令行执行文件，直到找到为止。

3. npm run xxx的常用小技巧

3.1 在脚本中使用变量

在package.json文件中的脚本命令中也可以使用变量。举个例子：

"scripts": {
  "build": "NODE_ENV=production webpack"
}

在上面的脚本命令中，NODE_ENV是一个环境变量，它被定义为production。在执行npm run build命令时，webpack会在构建时使用这个环境变量。

3.2 使用npm内置变量

另外，npm还提供了一些内置变量，可以在脚本中使用，比如npm_package_name、npm_config_port等。

例如，在package.json文件中定义了如下脚本：

"scripts": {
  "start": "node app.js --port $npm_config_port",
}

在执行npm run start --port 8080时，$npm_config_port将会被替换为8080。

总之，npm run xxx能够非常方便地定义和执行各种脚本命令，是我们开发过程中非常有用的一个工具。