node.js 명령줄 도구를 올바르게 사용하는 방법

이번에는 node.js 명령줄 도구를 올바르게 사용하는 방법과 node.js 명령줄 도구를 사용하는 방법에 대한 참고사항을 보여드리겠습니다. 다음은 실제 사례입니다.

1. 먼저 package.json을 이해하세요

각 프로젝트의 루트 디렉터리에는 이 프로젝트뿐만 아니라 프로젝트에 필요한 다양한 모듈을 정의하는 package.json 파일이 있습니다. 구성 정보는 다음과 같습니다. package.json 文件，定义了这个项目所需要的各种模块，以及项目的配置信息,下面是一个比较完整的package.json文件

{
 "name": "vue-cli",
 "version": "2.9.3",
 "description": "A simple CLI for scaffolding Vue.js projects.",
 "preferGlobal": true,
 "bin": {
 "vue": "bin/vue",
 "vue-init": "bin/vue-init",
 "vue-list": "bin/vue-list"
 },
 "repository": {
 "type": "",
 "url": ""
 },
 "keywords": [
 ],
 "author": "litongqian",
 "license": "MIT",
 "bugs": {
 "url": ""
 },
 "homepage": "",
 "scripts": {
 "test": "npm run lint && npm run e2e",
 "start": "node index.js"
 },
 "dependencies": {
 "async": "^2.4.0",
 "chalk": "^2.1.0",
 },
 "devDependencies": {
 "chai": "^4.1.2",
 "eslint": "^3.19.0",
 },
 "engines": {
 "node": ">=6.0.0"
 }
}

1. 其中scripts字段

指定了运行脚本命令的npm命令行缩写，比如start指定了运行 npm run start 时，所要执行的命令。

2. bin字段

bin项用来指定各个内部命令对应的可执行文件的位置

"bin": {
 "vue": "bin/vue",
 "vue-init": "bin/vue-init",
 "vue-list": "bin/vue-list"
 },

上面代码指定， vue 命令对应的可执行文件为 bin 子目录下的 vue 。

3. npm link

开发NPM模块的时候，有时我们会希望，边开发边试用，比如本地调试的时候， <a href="http://www.php.cn/wiki/136.html" target="_blank">require</a>('myModule') 会自动加载本机开发中的模块。Node规定，使用一个模块时，需要将其安装到全局的或项目的 node_modules 目录之中。对于开发中的模块，解决方法就是在全局的 node_modules 目录之中，生成一个符号链接，指向模块的本地目录。

npm link 就能起到这个作用，会自动建立这个符号链接。

请设想这样一个场景，你开发了一个模块 myModule ，目录为 src/myModule ，你自己的项目 myProject 要用到这个模块，项目目录为 src/myProject 。首先，在模块目录（ src/myModule ）下运行 npm link 命令。

src/myModule$ npm link

上面的命令会在NPM的全局模块目录内，生成一个符号链接文件，该文件的名字就是 package.json 文件中指定的模块名。

/path/to/global/node_modules/myModule -> src/myModule

这个时候，已经可以全局调用 myModule 模块了。但是，如果我们要让这个模块安装在项目内，还要进行下面的步骤。

切换到项目目录，再次运行 npm link 命令，并指定模块名。

src/myProject$ npm link myModule

上面命令等同于生成了本地模块的符号链接。

复制代码 代码如下:

src/myProject/node_modules/myModule -> /path/to/global/node_modules/myModule

然后，就可以在你的项目中，加载该模块了。

var myModule = require('myModule');

这样一来， myModule 的任何变化，都可以直接反映在 myProject 项目之中。但是，这样也出现了风险，任何在 myProject 目录中对 myModule 的修改，都会反映到模块的源码中。

如果你的项目不再需要该模块，可以在项目目录内使用 npm unlink 命令，删除符号链接。

src/myProject$ npm unlink myModule

二. 可执行脚本

写一个简单的脚本hello

$ mkdir hello #创建一个文件夹

$ cd hello && touch hello #创建命令文件

#!/usr/bin/env node
console.log('hello world');

1 스크립트 필드

는 스크립트 명령 실행을 위한 npm 명령줄 약어를 지정합니다. 예를 들어 start는 npm run start를 실행하도록 지정합니다. code>, 실행할 명령입니다.

2. bin 필드

bin 항목은 각 내부 명령에 해당하는 실행 파일의 위치를 ​​지정하는 데 사용됩니다

$ chmod 755 hello
$./hello

위 코드는 vue 명령에 해당하는 실행 파일이 bin 하위 디렉터리에 있음을 지정합니다. .

🎜3.npm link🎜🎜🎜NPM 모듈을 개발할 때 로컬에서 디버깅할 때와 같이 개발 중에 사용해 보고 싶을 때가 있습니다. <a href="http://www.php.cn/%20wiki%20/136.html" target="_blank">require🎜('myModule')</a>은네이티브 개발에서 🎜모듈을 자동으로 로드합니다. Node에서는 모듈을 사용할 때 전역 또는 프로젝트 node_modules 디렉터리에 설치해야 한다고 규정합니다. 개발 중인 모듈의 경우 해결 방법은 모듈의 로컬 디렉터리를 가리키는 전역 node_modules 디렉터리에 기호 링크를 생성하는 것입니다. 🎜🎜npm link가 이 역할을 할 수 있으며 심볼릭 링크가 자동으로 생성됩니다. 🎜🎜모듈 myModule을 개발하고 디렉터리가 src/myModule이고 자신의 프로젝트 myProject가 이를 사용해야 하는 시나리오를 상상해 보세요. 이 모듈의 경우 프로젝트 디렉터리는 src/myProject입니다. 먼저, 모듈 디렉터리( src/myModule )에서 npm link 명령을 실행하세요. 🎜

{
 "name": "hello",
 "bin": {
 "hello": "./hello"
 }
}

🎜위 명령은 NPM의 전역 모듈 디렉터리에 심볼릭 링크 파일을 생성합니다. 파일 이름은 package.json 파일에 지정된 모듈 이름입니다. 🎜

$ npm link

🎜이때 myModule 모듈을 전역적으로 호출할 수 있습니다. 하지만 이 모듈을 프로젝트에 설치하려면 다음 단계를 수행해야 합니다. 🎜🎜프로젝트 디렉터리로 전환하고 npm link 명령을 다시 실행한 후 모듈 이름을 지정하세요. 🎜

#!/usr/bin/env node
console.log('hello ', process.argv);

🎜위 명령은 로컬 모듈에 대한 심볼릭 링크를 생성하는 것과 동일합니다. 🎜🎜코드를 복사하세요🎜 코드는 다음과 같습니다:🎜🎜src/myProject/node_modules/myModule -> /path/to/global/node_modules/myModule🎜🎜그러면 , 프로젝트에서 모듈이 로드됩니다. 🎜

#!/usr/bin/env node
var name = process.argv[2];
var exec = require('child_process').exec;
var child = exec('echo hello ' + name, function(err, stdout, stderr) {
 if (err) throw err;
 console.log(stdout);
});

🎜이런 방식으로 myModule에 대한 모든 변경 사항이 myProject 프로젝트에 직접 반영될 수 있습니다. 그러나 이는 위험을 초래하기도 합니다. myProject 디렉터리의 myModule을 수정하면 모듈의 소스 코드에 반영됩니다. 🎜🎜프로젝트에 더 이상 이 모듈이 필요하지 않은 경우 프로젝트 디렉터리에서 npm unlink 명령을 사용하여 심볼릭 링크를 삭제할 수 있습니다. 🎜

var name = process.argv[2];
var exec = require('child_process').exec;
var child = exec(name, function(err, stdout, stderr) {
 if (err) throw err;
 console.log(stdout);
});

🎜2. 실행 가능한 스크립트🎜🎜간단한 스크립트 작성 hello🎜🎜$ mkdir hello #폴더 생성🎜🎜$ cd hello && touch hello #명령 파일 생성 code >🎜

npm install --save shelljs

🎜파일 헤드에 #!/usr/bin/env node 줄을 추가해야 합니다. 이는 node를 스크립트의 해석기로 사용한다는 의미이며, 이는 불일치를 방지할 수 있습니다. 노드 설치 경로 문제. 🎜🎜🎜/usr/bin/env를 열면 PATH를 볼 수 있으며 운영 체제는 경로를 통해 노드를 찾습니다🎜🎜🎜🎜🎜🎜그런 다음 hello의 권한을 수정합니다. 🎜

#!/usr/bin/env node
var name = process.argv[2];
var shell = require("shelljs");
shell.exec("echo hello " + name);

🎜🎜🎜

如果想把 hello 前面的路径去除，可以将 hello 的路径加入环境变量 PATH。但是，另一种更好的做法，是在当前目录下新建 package.json ，写入下面的内容。

{
 "name": "hello",
 "bin": {
 "hello": "./hello"
 }
}

然后执行 npm link 命令。不明白的看上面

$ npm link

执行后会产生一个全局的映射关系,就可以全局使用hello命令了

三.命令行参数

命令行参数可以用系统变量 process.argv 获取。

修改hello脚本

#!/usr/bin/env node
console.log('hello ', process.argv);

其中process为node进程中的全局变量，process.argv为一数组，数组内存储着命令行的各个部分，argv[0]为node的安装路径，argv[1]为主模块文件路劲，剩下为子命令或参数，如下：

$ hello a b c

# process.argv的值为[ '/usr/local/bin/node', '/usr/local/bin/hello', 'a', 'b', 'c' ]

脚本可以通过 child_process 模块新建子进程，从而执行 Unix 系统命令,修改hello

exec 方法用于执行bash命令, exec 方法最多可以接受两个参数，第一个参数是所要执行的shell命令，第二个参数是回调函数，该函数接受三个参数，分别是发生的错误、标准输出的显示结果、标准错误的显示结果。

#!/usr/bin/env node
var name = process.argv[2];
var exec = require('child_process').exec;
var child = exec('echo hello ' + name, function(err, stdout, stderr) {
 if (err) throw err;
 console.log(stdout);
});

执行$ hello litongqian

如果我们想查看所有文件,修改hello

var name = process.argv[2];
var exec = require('child_process').exec;
var child = exec(name, function(err, stdout, stderr) {
 if (err) throw err;
 console.log(stdout);
});

执行$ hello ls 

hello目录下有三个文件

四、shelljs 模块

shell.js 模块重新包装了 child_process，调用系统命令更加方便。它需要安装后使用。

npm install --save shelljs

然后，改写脚本。

#!/usr/bin/env node
var name = process.argv[2];
var shell = require("shelljs");
shell.exec("echo hello " + name);

五、yargs 模块

shelljs 只解决了如何调用 shell 命令，而 yargs 模块能够解决如何处理命令行参数。它也需要安装。

$ npm install --save yargs

yargs 模块提供 argv 对象，用来读取命令行参数。请看改写后的 hello 。

#!/usr/bin/env node
var argv = require('yargs').argv;
console.log('hello ', argv.name);

使用时，下面两种用法都可以。

$ hello --name=tom
hello tom
$ hello --name tom
hello tom

也就是说，process.argv 的原始返回值如下。

$ node hello --name=tom
[ 'node',
 '/usr/local/bin/hell',
 '--name=tom' ]

yargs 可以上面的结果改为一个对象，每个参数项就是一个键值对。

六.发布命令包

通过npm publish进行发布，前提是有npm帐号。如何操作可以查看npm 官方文档。

本文是通过原生node.js来开发命令工具，而vue-cli是采用commander.js来简化命令工具开发,

了解了执行流程,去学习对应的模块,就很好知道原理了!,本文抛个砖头

 

最后:有时我们用到的命令行不是全局安装的,而是本地安装的

1. package.json bin字段

bin项用来指定各个内部命令对应的可执行文件的位置。

"name":"someTool",
"bin": {
 "someTool": "./bin/someTool.js"
}

上面代码指定，someTool 命令对应的可执行文件为 bin 子目录下的 someTool.js。

当一个项目依赖上面的someTool工具时,同时只是本地安装

{
 "name": "myproject",
 "devDependencies": {
 "someTool": "latest"
 },
 "scripts": {
 start: 'someTool build' //等同于start: './node_modules/someTool/someTool.js build'
 }
}

npm会寻找这个文件，在 node_modules/.bin/ 目录下建立符号链接。在上面的例子中，someTool.js会建立符号链接 npm_modules/.bin/someTool 。由于 node_modules/.bin/ 目录会在运行时加入系统的PATH变量，因此在运行npm时，就可以不带路径，直接通过命令来调用这些脚本。

因此，像上面这样的写法可以采用简写。

scripts: { 
 start: './node_modules/someTool/someTool.js build'
}
// 简写为
scripts: { 
 start: 'someTool build'
}

所有 node_modules/.bin/ 目录下的命令，都可以用 npm run [命令] 的格式运行。在命令行下，键入 npm run ，然后按tab键，就会显示所有可以使用的命令。

1. npm run

上面代码中， scripts 字段指定了两项命令 start ，输入 npm run-script start 或者 npm run start ，就会执行  someTool build 。 npm run 是 npm run-script 的缩写，一般都使用前者，但是后者可以更好地反应这个命令的本质。

npm run 命令会自动在环境变量 $PATH 添加 node_modules/.bin 目录，所以 scripts 字段里面调用命令时不用加上路径，这就避免了全局安装NPM模块。

npm run 如果不加任何参数，直接运行，会列出 package.json 里面所有可以执行的脚本命令。

npm内置了两个命令简写， npm test 等同于执行 npm run test ， npm start 等同于执行 npm run start 。

npm run 会创建一个Shell，执行指定的命令，并临时将 node_modules/.bin 加入PATH变量，这意味着本地模块可以直接运行。

举例来说，你执行ESLint的安装命令。

$ npm i eslint --save-dev

运行上面的命令以后，会产生两个结果。首先，ESLint被安装到当前目录的 node_modules 子目录；其次， node_modules/.bin 目录会生成一个符号链接 node_modules/.bin/eslint ，指向ESLint模块的可执行脚本。

然后，你就可以在 package.json 的 script 属性里面，不带路径的引用 eslint 这个脚本。

{
 "name": "Test Project",
 "devDependencies": {
 "eslint": "^1.10.3"
 },
 "scripts": {
 "lint": "eslint ."
 }
}

等到运行 npm run lint 的时候，它会自动执行 ./node_modules/.bin/eslint . 。

如果直接运行 npm run 不给出任何参数，就会列出 scripts 属性下所有命令。

$ npm run
Available scripts in the user-service package:
 lint
  jshint **.js
 test
 mocha test/

相信看了本文案例你已经掌握了方法，更多精彩请关注php中文网其它相关文章！

推荐阅读：

React怎样在react-router路由实现登陆验证控制

Angular路由内路由守卫该如何使用

위 내용은 node.js 명령줄 도구를 올바르게 사용하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!