使用Node.js构建交互式命令行工具

使用 Node.js 构建一个根据询问创建文件的命令行工具。

创新互联是一家专业提供海盐企业网站建设,专注与成都网站制作、成都网站设计、外贸营销网站建设、成都h5网站建设、小程序制作等业务。10年已为海盐众多企业、政府机构等服务。创新互联专业的建站公司优惠进行中。

当用于构建命令行界面（CLI）时，Node.js 十分有用。在这篇文章中，我将会教你如何使用 Node.js 来构建一个问一些问题并基于回答创建一个文件的命令行工具。

开始

首先，创建一个新的 npm 包（NPM 是 JavaScript 包管理器）。

  
 
 
 
    
   
  
  
  
  1. mkdir my-script
    2. 
   
  
  
  
  2. cd my-script
    3. 
   
  
  
  
  3. npm init
    4.

NPM 将会问一些问题。随后，我们需要安装一些包。

  
 
 
 
    
   
  
  
  
  1. npm install --save chalk figlet inquirer shelljs
    2.

这是我们需要的包：

  • Chalk：正确设定终端的字符样式
  • Figlet：使用普通字符制作大字母的程序（LCTT 译注：使用标准字符，拼凑出图片）
  • Inquirer：通用交互式命令行用户界面的集合
  • ShellJS：Node.js 版本的可移植 Unix Shell 命令行工具

创建一个 index.js 文件

现在我们要使用下述内容创建一个 index.js 文件。

  
 
 
 
    
   
  
  
  
  1. #!/usr/bin/env node
    2. 
   
  
  
  
  2.  
    3. 
   
  
  
  
  3. const inquirer = require("inquirer");
    4. 
   
  
  
  
  4. const chalk = require("chalk");
    5. 
   
  
  
  
  5. const figlet = require("figlet");
    6. 
   
  
  
  
  6. const shell = require("shelljs");
    7.

规划命令行工具

在我们写命令行工具所需的任何代码之前，做计划总是很棒的。这个命令行工具只做一件事：创建一个文件。

它将会问两个问题：文件名是什么以及文件后缀名是什么？然后创建文件，并展示一个包含了所创建文件路径的成功信息。

  
 
 
 
    
   
  
  
  
  1. // index.js
    2. 
   
  
  
  
  2.  
    3. 
   
  
  
  
  3. const run = async () => {
    4. 
   
  
  
  
  4.  // show script introduction
    5. 
   
  
  
  
  5.  // ask questions
    6. 
   
  
  
  
  6.  // create the file
    7. 
   
  
  
  
  7.  // show success message
    8. 
   
  
  
  
  8. };
    9. 
   
  
  
  
  9.  
    10. 
   
  
  
  
  10. run();
    11.

***个函数只是该脚本的介绍。让我们使用 chalk 和 figlet 来把它完成。

  
 
 
 
    
   
  
  
  
  1. const init = () => {
    2. 
   
  
  
  
  2.  console.log(
    3. 
   
  
  
  
  3.  chalk.green(
    4. 
   
  
  
  
  4.  figlet.textSync("Node JS CLI", {
    5. 
   
  
  
  
  5.  font: "Ghost",
    6. 
   
  
  
  
  6.  horizontalLayout: "default",
    7. 
   
  
  
  
  7.  verticalLayout: "default"
    8. 
   
  
  
  
  8.  })
    9. 
   
  
  
  
  9.  )
    10. 
   
  
  
  
  10.  );
    11. 
   
  
  
  
  11. }
    12. 
   
  
  
  
  12.  
    13. 
   
  
  
  
  13. const run = async () => {
    14. 
   
  
  
  
  14.  // show script introduction
    15. 
   
  
  
  
  15.  init();
    16. 
   
  
  
  
  16.  
    17. 
   
  
  
  
  17.  // ask questions
    18. 
   
  
  
  
  18.  // create the file
    19. 
   
  
  
  
  19.  // show success message
    20. 
   
  
  
  
  20. };
    21. 
   
  
  
  
  21.  
    22. 
   
  
  
  
  22. run();
    23.

然后，我们来写一个函数来问问题。

  
 
 
 
    
   
  
  
  
  1. const askQuestions = () => {
    2. 
   
  
  
  
  2.  const questions = [
    3. 
   
  
  
  
  3.  {
    4. 
   
  
  
  
  4.  name: "FILENAME",
    5. 
   
  
  
  
  5.  type: "input",
    6. 
   
  
  
  
  6.  message: "What is the name of the file without extension?"
    7. 
   
  
  
  
  7.  },
    8. 
   
  
  
  
  8.  {
    9. 
   
  
  
  
  9.  type: "list",
    10. 
   
  
  
  
  10.  name: "EXTENSION",
    11. 
   
  
  
  
  11.  message: "What is the file extension?",
    12. 
   
  
  
  
  12.  choices: [".rb", ".js", ".php", ".css"],
    13. 
   
  
  
  
  13.  filter: function(val) {
    14. 
   
  
  
  
  14.  return val.split(".")[1];
    15. 
   
  
  
  
  15.  }
    16. 
   
  
  
  
  16.  }
    17. 
   
  
  
  
  17.  ];
    18. 
   
  
  
  
  18.  return inquirer.prompt(questions);
    19. 
   
  
  
  
  19. };
    20. 
   
  
  
  
  20.  
    21. 
   
  
  
  
  21. // ...
    22. 
   
  
  
  
  22.  
    23. 
   
  
  
  
  23. const run = async () => {
    24. 
   
  
  
  
  24.  // show script introduction
    25. 
   
  
  
  
  25.  init();
    26. 
   
  
  
  
  26.  
    27. 
   
  
  
  
  27.  // ask questions
    28. 
   
  
  
  
  28.  const answers = await askQuestions();
    29. 
   
  
  
  
  29.  const { FILENAME, EXTENSION } = answers;
    30. 
   
  
  
  
  30.  
    31. 
   
  
  
  
  31.  // create the file
    32. 
   
  
  
  
  32.  // show success message
    33. 
   
  
  
  
  33. };
    34.

注意，常量 FILENAME 和 EXTENSIONS 来自 inquirer 包。

下一步将会创建文件。

  
 
 
 
    
   
  
  
  
  1. const createFile = (filename, extension) => {
    2. 
   
  
  
  
  2.  const filePath = `${process.cwd()}/${filename}.${extension}`
    3. 
   
  
  
  
  3.  shell.touch(filePath);
    4. 
   
  
  
  
  4.  return filePath;
    5. 
   
  
  
  
  5. };
    6. 
   
  
  
  
  6.  
    7. 
   
  
  
  
  7. // ...
    8. 
   
  
  
  
  8.  
    9. 
   
  
  
  
  9. const run = async () => {
    10. 
   
  
  
  
  10.  // show script introduction
    11. 
   
  
  
  
  11.  init();
    12. 
   
  
  
  
  12.  
    13. 
   
  
  
  
  13.  // ask questions
    14. 
   
  
  
  
  14.  const answers = await askQuestions();
    15. 
   
  
  
  
  15.  const { FILENAME, EXTENSION } = answers;
    16. 
   
  
  
  
  16.  
    17. 
   
  
  
  
  17.  // create the file
    18. 
   
  
  
  
  18.  const filePath = createFile(FILENAME, EXTENSION);
    19. 
   
  
  
  
  19.  
    20. 
   
  
  
  
  20.  // show success message
    21. 
   
  
  
  
  21. };
    22.

***，重要的是，我们将展示成功信息以及文件路径。

  
 
 
 
    
   
  
  
  
  1. const success = (filepath) => {
    2. 
   
  
  
  
  2.  console.log(
    3. 
   
  
  
  
  3.  chalk.white.bgGreen.bold(`Done! File created at ${filepath}`)
    4. 
   
  
  
  
  4.  );
    5. 
   
  
  
  
  5. };
    6. 
   
  
  
  
  6.  
    7. 
   
  
  
  
  7. // ...
    8. 
   
  
  
  
  8.  
    9. 
   
  
  
  
  9. const run = async () => {
    10. 
   
  
  
  
  10.  // show script introduction
    11. 
   
  
  
  
  11.  init();
    12. 
   
  
  
  
  12.  
    13. 
   
  
  
  
  13.  // ask questions
    14. 
   
  
  
  
  14.  const answers = await askQuestions();
    15. 
   
  
  
  
  15.  const { FILENAME, EXTENSION } = answers;
    16. 
   
  
  
  
  16.  
    17. 
   
  
  
  
  17.  // create the file
    18. 
   
  
  
  
  18.  const filePath = createFile(FILENAME, EXTENSION);
    19. 
   
  
  
  
  19.  
    20. 
   
  
  
  
  20.  // show success message
    21. 
   
  
  
  
  21.  success(filePath);
    22. 
   
  
  
  
  22. };
    23.

来让我们通过运行 node index.js 来测试这个脚本，这是我们得到的：

完整代码

下述代码为完整代码：

  
 
 
 
    
   
  
  
  
  1. #!/usr/bin/env node
    2. 
   
  
  
  
  2.  
    3. 
   
  
  
  
  3. const inquirer = require("inquirer");
    4. 
   
  
  
  
  4. const chalk = require("chalk");
    5. 
   
  
  
  
  5. const figlet = require("figlet");
    6. 
   
  
  
  
  6. const shell = require("shelljs");
    7. 
   
  
  
  
  7.  
    8. 
   
  
  
  
  8. const init = () => {
    9. 
   
  
  
  
  9.  console.log(
    10. 
   
  
  
  
  10.  chalk.green(
    11. 
   
  
  
  
  11.  figlet.textSync("Node JS CLI", {
    12. 
   
  
  
  
  12.  font: "Ghost",
    13. 
   
  
  
  
  13.  horizontalLayout: "default",
    14. 
   
  
  
  
  14.  verticalLayout: "default"
    15. 
   
  
  
  
  15.  })
    16. 
   
  
  
  
  16.  )
    17. 
   
  
  
  
  17.  );
    18. 
   
  
  
  
  18. };
    19. 
   
  
  
  
  19.  
    20. 
   
  
  
  
  20. const askQuestions = () => {
    21. 
   
  
  
  
  21.  const questions = [
    22. 
   
  
  
  
  22.  {
    23. 
   
  
  
  
  23.  name: "FILENAME",
    24. 
   
  
  
  
  24.  type: "input",
    25. 
   
  
  
  
  25.  message: "What is the name of the file without extension?"
    26. 
   
  
  
  
  26.  },
    27. 
   
  
  
  
  27.  {
    28. 
   
  
  
  
  28.  type: "list",
    29. 
   
  
  
  
  29.  name: "EXTENSION",
    30. 
   
  
  
  
  30.  message: "What is the file extension?",
    31. 
   
  
  
  
  31.  choices: [".rb", ".js", ".php", ".css"],
    32. 
   
  
  
  
  32.  filter: function(val) {
    33. 
   
  
  
  
  33.  return val.split(".")[1];
    34. 
   
  
  
  
  34.  }
    35. 
   
  
  
  
  35.  }
    36. 
   
  
  
  
  36.  ];
    37. 
   
  
  
  
  37.  return inquirer.prompt(questions);
    38. 
   
  
  
  
  38. };
    39. 
   
  
  
  
  39.  
    40. 
   
  
  
  
  40. const createFile = (filename, extension) => {
    41. 
   
  
  
  
  41.  const filePath = `${process.cwd()}/${filename}.${extension}`
    42. 
   
  
  
  
  42.  shell.touch(filePath);
    43. 
   
  
  
  
  43.  return filePath;
    44. 
   
  
  
  
  44. };
    45. 
   
  
  
  
  45.  
    46. 
   
  
  
  
  46. const success = filepath => {
    47. 
   
  
  
  
  47.  console.log(
    48. 
   
  
  
  
  48.  chalk.white.bgGreen.bold(`Done! File created at ${filepath}`)
    49. 
   
  
  
  
  49.  );
    50. 
   
  
  
  
  50. };
    51. 
   
  
  
  
  51.  
    52. 
   
  
  
  
  52. const run = async () => {
    53. 
   
  
  
  
  53.  // show script introduction
    54. 
   
  
  
  
  54.  init();
    55. 
   
  
  
  
  55.  
    56. 
   
  
  
  
  56.  // ask questions
    57. 
   
  
  
  
  57.  const answers = await askQuestions();
    58. 
   
  
  
  
  58.  const { FILENAME, EXTENSION } = answers;
    59. 
   
  
  
  
  59.  
    60. 
   
  
  
  
  60.  // create the file
    61. 
   
  
  
  
  61.  const filePath = createFile(FILENAME, EXTENSION);
    62. 
   
  
  
  
  62.  
    63. 
   
  
  
  
  63.  // show success message
    64. 
   
  
  
  
  64.  success(filePath);
    65. 
   
  
  
  
  65. };
    66. 
   
  
  
  
  66.  
    67. 
   
  
  
  
  67. run();
    68.

使用这个脚本

想要在其它地方执行这个脚本，在你的 package.json 文件中添加一个 bin 部分，并执行 npm link：

  
 
 
 
    
   
  
  
  
  1. {
    2. 
   
  
  
  
  2.  "name": "creator",
    3. 
   
  
  
  
  3.  "version": "1.0.0",
    4. 
   
  
  
  
  4.  "description": "",
    5. 
   
  
  
  
  5.  "main": "index.js",
    6. 
   
  
  
  
  6.  "scripts": {
    7. 
   
  
  
  
  7.  "test": "echo \"Error: no test specified\" && exit 1",
    8. 
   
  
  
  
  8.  "start": "node index.js"
    9. 
   
  
  
  
  9.  },
    10. 
   
  
  
  
  10.  "author": "",
    11. 
   
  
  
  
  11.  "license": "ISC",
    12. 
   
  
  
  
  12.  "dependencies": {
    13. 
   
  
  
  
  13.  "chalk": "^2.4.1",
    14. 
   
  
  
  
  14.  "figlet": "^1.2.0",
    15. 
   
  
  
  
  15.  "inquirer": "^6.0.0",
    16. 
   
  
  
  
  16.  "shelljs": "^0.8.2"
    17. 
   
  
  
  
  17.  },
    18. 
   
  
  
  
  18.  "bin": {
    19. 
   
  
  
  
  19.  "creator": "./index.js"
    20. 
   
  
  
  
  20.  }
    21. 
   
  
  
  
  21. }
    22.

执行 npm link 使得这个脚本可以在任何地方调用。

这就是是当你运行这个命令时的结果。

  
 
 
 
    
   
  
  
  
  1. /usr/bin/creator -> /usr/lib/node_modules/creator/index.js
    2. 
   
  
  
  
  2. /usr/lib/node_modules/creator -> /home/hugo/code/creator
    3.

这会连接 index.js 作为一个可执行文件。这是完全可能的，因为这个 CLI 脚本的***行是 #!/usr/bin/env node。

现在我们可以通过执行如下命令来调用。

  
 
 
 
    
   
  
  
  
  1. $ creator
    2.

总结

正如你所看到的，Node.js 使得构建一个好的命令行工具变得非常简单。如果你希望了解更多内容，查看下列包。

  • meow：一个简单的命令行助手工具
  • yargs：一个命令行参数解析工具
  • pkg：将你的 Node.js 程序包装在一个可执行文件中。

在评论中留下你关于构建命令行工具的经验吧！ 

网站名称：使用Node.js构建交互式命令行工具
本文地址：http://www.36103.cn/qtweb/news49/9749.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联

猜你还喜欢下面的内容

自适应网站知识

同城分类信息

成都网站建设　　 　微信公众号开发　　 　成都主机托管　　 　成都铺面装修　　 　成都app开发　　 　重庆企业网站建设　　 　注册域名　　 　宜宾网站营销推广　　 　响应式网站　　 　重庆主机托管　　 　做网站价格　　 　关键词排名优化　　 　外贸营销网站建设　　 　免备案虚拟主机空间　　 　四川平武网站建设　　 　成都移动服务器托管　　 　成都酒店服定制　　 　手机网站制作　　 　高端定制网站设计　　 　成都橡塑保温管