当前位置:首页 > 科技  > 软件

告别重复劳动:2024年学会用Node.js一键搞定CLI工具

来源: 责编: 时间:2024-04-12 17:33:40 269观看
导读在2024年,随着技术的不断发展和迭代,Node.js作为一个事件驱动且拥有丰富npm生态统的JavaScript运行环境,已经成为开发高效、可扩展命令行界面(CLI)工具的首选技术。这不仅仅因为其强大的性能,更因为它提供了大量专门设计来

81V28资讯网——每日最新资讯28at.com

在2024年,随着技术的不断发展和迭代,Node.js作为一个事件驱动且拥有丰富npm生态统的JavaScript运行环境,已经成为开发高效、可扩展命令行界面(CLI)工具的首选技术。这不仅仅因为其强大的性能,更因为它提供了大量专门设计来支持CLI开发的包和工具。那么,为什么我们要开发CLI工具呢?简单来说,CLI工具能够帮助我们自动化繁琐的任务,为开发者创建实用工具,以及与系统交互和管理工作流程。81V28资讯网——每日最新资讯28at.com

例如,我们可以创建了几个提供巨大价值的CLI工具:一个管理CI/CD流程中动态管道的CLI,它消除了手动配置的需要和流程之间的等待时间;一个设置和管理本地docker化开发环境的CLI;以及一个运行预定义迁移步骤的CLI。这些工具极大地提高了我们的工作效率和流程的自动化程度。81V28资讯网——每日最新资讯28at.com

现在,我将向你展示如何轻松构建自己的CLI工具。我们将从命令处理和用户提示开始,一步一步深入到提升用户体验,以及如何组织项目结构和文档编写。这个过程不仅仅是编码,更是一次深入理解Node.js强大功能的旅程。81V28资讯网——每日最新资讯28at.com

从零开始:打造你的Node.js命令行工具

接下来,我将引导你通过几个简单的步骤,从零开始打造一个属于自己的Node.js CLI工具。81V28资讯网——每日最新资讯28at.com

准备工作

首先,确保你的电脑上已经安装了Node.js。这是所有后续步骤的基础。81V28资讯网——每日最新资讯28at.com

第一步:初始化你的项目

创建一个新的文件夹来承载你的项目,并进入这个文件夹:81V28资讯网——每日最新资讯28at.com

mkdir my-node-clicd my-node-cli

然后,启动一个新的Node.js项目:81V28资讯网——每日最新资讯28at.com

npm init

按照提示完成项目的初始化。这一步会创建一个package.json文件,为你的项目记录重要的元数据和依赖关系。81V28资讯网——每日最新资讯28at.com

第二步:引入Commander.js

Commander.js是我们构建Node.js CLI工具的神器,它就像一个瑞士军刀,帮助我们解析输入、生成帮助文本和管理错误。81V28资讯网——每日最新资讯28at.com

npm install commander

通过这一步,你将Commander.js添加到了项目依赖中。81V28资讯网——每日最新资讯28at.com

第三步:打造CLI

在项目文件夹中创建一个名为index.js的文件,这将是我们CLI工具的起点。81V28资讯网——每日最新资讯28at.com

#!/usr/bin/env nodeimport { program } from "commander";program  .version('1.0.0')  .description('My Node CLI')  .option('-n, --name <type>', 'Add your name')  .action((options) => {    console.log(`Hey, ${options.name}!`);  });program.parse(process.argv);

这段代码定义了一个基础的CLI,它接受一个名字作为参数,并打印出一条欢迎信息。81V28资讯网——每日最新资讯28at.com

接下来,修改你的package.json来识别CLI命令,并设置为使用ES模块:81V28资讯网——每日最新资讯28at.com

"bin": {    "my-node-cli": "./index.js"},"type": "module"

通过全局链接你的项目:81V28资讯网——每日最新资讯28at.com

npm link

这样,my-node-cli就可以在终端上运行了!81V28资讯网——每日最新资讯28at.com

my-node-cli --name YourName

81V28资讯网——每日最新资讯28at.com

提升用户体验

通过在CLI中加入ora的加载动画,你不仅能提升用户体验,还能以一种优雅和友好的方式向用户展示程序的状态。这种视觉反馈是非常重要的,它能让用户知道程序正在正常工作,即使在后台执行一些复杂或耗时的任务时也是如此。81V28资讯网——每日最新资讯28at.com

记得探索ora的其他功能,比如自定义旋转器的样式、颜色和文本,这样你可以创建一个与你的CLI工具风格相匹配的加载动画。81V28资讯网——每日最新资讯28at.com

用ASCII艺术美化你的CLI

在命令行界面(CLI)工具中添加ASCII艺术是一个绝妙的方式,可以在用户使用你的工具时给他们留下深刻的第一印象。figlet.js是一个强大的库,它允许你在CLI中生成各种风格的ASCII艺术文字。通过使用figlet.js和chalk库,你可以以彩色的ASCII艺术形式展示你的CLI工具名称或其他任何文字,从而增加你的CLI工具的吸引力。81V28资讯网——每日最新资讯28at.com

引入figlet.js

首先,你需要将figlet.js添加到你的项目中:81V28资讯网——每日最新资讯28at.com

npm install figlet

这一步会把figlet.js作为依赖安装到你的项目里。81V28资讯网——每日最新资讯28at.com

在CLI中展示ASCII艺术

接下来,让我们将ASCII艺术添加到你的index.js文件中,以展示你CLI工具的名称:81V28资讯网——每日最新资讯28at.com

import figlet from "figlet";import chalk from "chalk";console.log(  chalk.yellow(figlet.textSync("My Node CLI", { horizontalLayout: "full" })));

这段代码使用了figlet的textSync方法来生成“My Node CLI”这个文本的ASCII艺术表示,并通过chalk.yellow将其设置为黄色,从而在程序开始时以一种醒目和创意的方式欢迎用户。81V28资讯网——每日最新资讯28at.com

81V28资讯网——每日最新资讯28at.com

在你开始着手实际的命令行界面(CLI)逻辑之前,我强烈建议你参考Liran Tal的这个仓库。这个仓库收获了超过3000颗星,涵盖了我能想到的以及更多的最佳实践。81V28资讯网——每日最新资讯28at.com

仓库链接:
nodejs-cli-apps-best-practices
81V28资讯网——每日最新资讯28at.com

https://github.com/lirantal/nodejs-cli-apps-best-practices81V28资讯网——每日最新资讯28at.com

例如,为了避免用户在每次调用命令时重复提供相同的信息,你可以提供一个有状态的体验。使用conf这样的库来保存像用户名、电子邮件或API令牌这样的数据,就可以优化用户的体验。81V28资讯网——每日最新资讯28at.com

以下是一些可能会在该仓库中找到的最佳实践:81V28资讯网——每日最新资讯28at.com

  • 结构化项目文件夹:保持代码的组织性,如将命令、实用工具、库函数和其他配置分别放在不同的文件夹中。
  • 使用.env文件或类似机制来管理敏感配置:例如API密钥或数据库凭证,不应直接硬编码在代码中。
  • 编写单元测试:确保你的CLI工具的每个部分都通过自动化测试,以防止未来的更改破坏现有功能。
  • 持续集成(CI):设置CI流程,以自动运行测试和其他检查,确保代码的质量。
  • 文档化:为你的CLI工具编写清晰的README.md文件,包括安装指南、使用方式、命令列表以及如何贡献。
  • 优化命令行输出:使用像chalk、ora或figlet这样的库来增强CLI的用户体验。
  • 处理异常和错误:合理处理可能发生的错误,并向用户提供有用的反馈。
  • 发布和版本控制:使用semver进行版本控制,并适当地标记你的GitHub发布。

这些最佳实践将帮助你构建一个健壮、可维护且用户友好的CLI工具。记得定期回顾和更新你的实践,以保持与时俱进。81V28资讯网——每日最新资讯28at.com

本文链接:http://www.28at.com/showinfo-26-83284-0.html告别重复劳动:2024年学会用Node.js一键搞定CLI工具

声明:本网页内容旨在传播知识,若有侵权等问题请及时与本网联系,我们将在第一时间删除处理。邮件:2376512515@qq.com

上一篇: Thread.onSpinWait()有什么作用?为什么要睡眠0毫秒?

下一篇: 蚂蚁数科加速布局东南亚,招聘本地员工

标签:
  • 热门焦点
  • 从 Pulsar Client 的原理到它的监控面板

    背景前段时间业务团队偶尔会碰到一些 Pulsar 使用的问题,比如消息阻塞不消费了、生产者消息发送缓慢等各种问题。虽然我们有个监控页面可以根据 topic 维度查看他的发送状态,
  • Java NIO内存映射文件:提高文件读写效率的优秀实践!

    Java的NIO库提供了内存映射文件的支持,它可以将文件映射到内存中,从而可以更快地读取和写入文件数据。本文将对Java内存映射文件进行详细的介绍和演示。内存映射文件概述内存
  • 共享单车的故事讲到哪了?

    来源丨海克财经与共享充电宝相差不多,共享单车已很久没有被国内热点新闻关照到了。除了一再涨价和用户直呼用不起了。近日多家媒体再发报道称,成都、天津、郑州等地多个共享单
  • 大厂卷向扁平化

    来源:新熵作者丨南枝 编辑丨月见大厂职级不香了。俗话说,兵无常势,水无常形,互联网企业调整职级体系并不稀奇。7月13日,淘宝天猫集团启动了近年来最大的人力制度改革,目前已形成一
  • iQOO Neo8系列今日官宣:首发天玑9200+ 全球安卓最强芯!

    在昨日举行的的联发科新一代旗舰芯片天玑9200+的发布会上,iQOO官方也正式宣布,全新的iQOO Neo8系列新品将全球首发搭载这款当前性能最强大的移动平台
  • iQOO Neo8 Pro真机谍照曝光:天玑9200+和V1+旗舰双芯加持

    去年10月,iQOO推出了iQOO Neo7系列机型,不仅搭载了天玑9000+,而且是同价位唯一一款天玑9000+直屏旗舰,一经上市便受到了用户的广泛关注。在时隔半年后,
  • Windows 11发布,微软一改往常对老机型开放的态度

    距离 Windows 11 发布已经过去一周,在过去一周里,很多数码爱好者围绕其对 Android 应用的支持、对老机型的升级问题展开了激烈讨论。与以往不同的是,在这次大
  • 苹果140W USB-C充电器:采用氮化镓技术

    据10 月 30 日 9to5 Mac 消息报道,当苹果推出新的 MacBook Pro 2021 时,该公司还推出了新的 140W USB-C 充电器,附赠在 MacBook Pro 16 英寸机型的盒子里,也支
  • 三翼鸟智能家居亮相电博会,让用户体验更真实

    2021电博会在青岛国际会展中心开幕中,三翼鸟直接把“家”搬到了现场,成为了展会的一大看点。这也是三翼鸟继9月9日发布了行业首个一站式定制智慧家平台后的
Top