DocOpt.Coffee: 命令行接口解析库 for Node.js

DocOpt.Coffee: 命令行接口解析库 for Node.js

去发现同类优质开源项目:https://gitcode.com/

是一个基于 JavaScript 的命令行接口解析库，适用于 Node.js 环境。

项目简介

DocOpt.Coffee 是一款轻量级的库，用于解析命令行参数。它采用了类似 Python 中的 Docopt 库的设计思想，并提供了简单的 API 和清晰明了的语法。

该项目的目标是为 Node.js 开发者提供一种简单而强大的方法来处理命令行输入，并将这些输入转换为易于使用的数据结构，以便在应用程序中进行进一步处理。

功能特性

• 支持自定义命令行参数和选项
• 提供简洁易懂的语法糖，便于编写命令行帮助文档
• 可以自动生成基于命令行帮助文档的参数解析规则
• 返回的结果是一个 JSON 对象，方便后续处理
• 兼容 POSIX 标准和 Windows 平台
• 良好的测试覆盖率和稳定性

1. 使用场景

DocOpt.Coffee 可以广泛应用于各种需要处理命令行参数的 Node.js 项目中，例如：

• CLI 工具开发
• 自动化脚本
• 配置文件管理工具

1. 快速上手

要开始使用 DocOpt.Coffee，您首先需要通过 npm 安装该库：

npm install docopt.coffee --save

然后，在您的 Node.js 应用程序中导入并使用 DocOpt.Coffee：

const docopt = require('docopt').docopt;

const usage = `
Usage:
  my-cli [options] <command> [<args>...]

Options:
  -h, --help            Show this help message and exit.
  -v, --version         Print version information and exit.

  --flag                Enable a feature flag.
`;

const options = docopt(usage);

console.log(options);

在这个例子中，我们定义了一个简单的命令行界面，包含一个主命令 <command>、可选的参数 <args> 以及两个选项 --flag 和 -h/--help。运行示例代码后，您可以根据所给的命令行帮助文档来调用此程序。

示例

下面是一些使用 DocOpt.Coffee 编写的命令行工具示例。

文件复制器

#!/usr/bin/env node
const fs = require('fs');
const path = require('path');
const docopt = require('docopt').docopt;

const usage = `
Usage:
  copy-file [options] <source> <destination>

Options:
  -h, --help     Show this help message and exit.
  -f, --force    Overwrite an existing destination file.
`;

const options = docopt(usage);

if (options['<source>'] && options['<destination>']) {
  const sourcePath = path.resolve(process.cwd(), options['<source>']);
  const destPath = path.resolve(process.cwd(), options['<destination>']);

  if (fs.existsSync(destPath)) {
    if (options['--force']) {
      fs.copyFileSync(sourcePath, destPath);
      console.log(`Copied ${sourcePath} to ${destPath}`);
    } else {
      console.error("Destination file already exists. Use '-f' or '--force' to overwrite.");
    }
  } else {
    fs.copyFileSync(sourcePath, destPath);
    console.log(`Copied ${sourcePath} to ${destPath}`);
  }
} else {
  console.log(docopt.usage);
}

在此示例中，我们创建了一个名为 copy-file 的简单文件复制器，支持 -h/--help 选项和 -f/--force 选项。

文本计数器

#!/usr/bin/env node
const docopt = require('docopt').docopt;

const usage = `
Usage:
  word-count [options] <filename>

Options:
  -h, --help       Show this help message and exit.
  -c, --chars      Count characters instead of words.
  -w, --words      Count words only (default).
  -l, --lines      Count lines only.
`;

const options = docopt(usage);

if (options['<filename>']) {
  const filePath = path.resolve(process.cwd(), options['<filename>']);
  let countType = 'words';

  if (options['--lines']) {
    countType = 'lines';
  } else if (options['--chars']) {
    countType = 'characters';
  }

  switch (countType) {
    case 'lines':
      console.log(`Line count:`, getLineCount(filePath));
      break;
    case 'characters':
      console.log(`Character count:`, getCharCount(filePath));
      break;
    default: // words
      console.log(`Word count:`, getWordCount(filePath));
      break;
  }
} else {
  console.log(docopt.usage);
}

function getLineCount(filePath) {
  return fs.readFileSync(filePath, 'utf-8').split('\n').length;
}

function getWordCount(filePath) {
  return fs.readFileSync(filePath, 'utf

去发现同类优质开源项目:https://gitcode.com/