CAC.js 使用指南

项目介绍

CAC 是一个简洁而强大的用于构建命令行应用程序的框架。它设计得轻量级且易于学习，仅需掌握四个核心API即可快速上手创建简单的CLI工具。尽管其接口简约，CAC 却支持诸如默认命令、Git风格子命令、参数和选项的验证、变长参数、嵌套选项等高级特性，并自动生成帮助信息。此框架采用TypeScript编写，对开发者友好。

项目快速启动

要开始使用CAC，首先你需要安装它。在你的项目目录下，执行以下命令：

yarn add cac

或者如果你偏好npm：

npm install cac

然后，你可以创建一个简单的CLI应用。下面是一个基本示例：

// cli.js
const cli = require('cac')();

cli.option('--type <type>', '选择项目类型', { default: 'node' });
const parsed = cli.parse();

console.log(JSON.stringify(parsed, null, 2));

通过运行 node cli.js --type web，你将看到选择的类型被打印出来。

应用案例与最佳实践

显示帮助信息与版本号

集成显示帮助消息和版本号，增加可交互性：

const cli = require('cac')();
cli.version('0.0.0');
cli.help();

cli.option('--verbose', '启用详细模式');
cli.parse();

if (cli.flags.verbose) {
    console.log("已启用详细模式");
}

处理命令与子命令

为了展示更复杂的用法，我们可以添加一个子命令来处理特定任务：

cli.command('lint [files]')
   .action((files, options) => {
       console.log(`正在检查文件: ${files.join(', ')}`);
   });

cli.parse();

这样，运行 node cli.js lint file1.js file2.js 就会触发对应的逻辑。

典型生态项目

CAC因其灵活性和易用性，在多个项目中得到了应用，例如：

• VuePress: 📝 基于Vue的静态站点生成器，利用CAC打造其命令行工具。
• SAO: ⚔️ 一个面向未来的快速生成器框架，以CAC作为命令行交互的核心。
• DocPad: 🏹 强大的静态站点生成工具，展示了如何结合CAC进行复杂配置的处理。
• Poi: ⚡️ 网页开发的轻量工具，通过CAC提供定制化命令。

这些项目成功地运用了CAC提供的功能来增强它们的命令行体验，从基础的参数解析到复杂的命令结构，证明了CAC作为一个CLI框架的强大和适用性。

---

以上就是使用CAC的基本教程，从快速入门到一些实践案例的简述，让你能够迅速上手并开始构建自己的命令行工具。随着你深入探索，CAC还有更多高级特性和技巧等待发现。