当前位置：首页 > news >正文

Deno命令行工具开发：打造跨平台CLI应用的完整教程

news 2026/8/14 6:17:57

Deno命令行工具开发：打造跨平台CLI应用的完整教程

【免费下载链接】deno_note《Deno进阶开发笔记》 (不定时更新) 🌶🌶🌶项目地址: https://gitcode.com/gh_mirrors/de/deno_note

Deno作为现代JavaScript/TypeScript运行时，提供了强大的命令行工具开发能力，让开发者能够轻松构建跨平台的CLI应用。本教程将从基础原理到实际开发，带你掌握使用Deno开发专业CLI工具的核心技能，包括环境配置、功能实现和跨平台部署。

为什么选择Deno开发CLI工具？

Deno内置了诸多适合CLI开发的特性，使其成为构建命令行工具的理想选择：

原生TypeScript支持：无需额外配置即可使用强类型系统，减少运行时错误
安全的权限控制：通过--allow-*系列标志精确控制文件系统、网络等访问权限
跨平台兼容性：一次编写，可在Windows、macOS和Linux系统运行
内置工具链：包含格式化、测试、文档生成等工具，简化开发流程
单一可执行文件：支持编译为独立二进制文件，方便分发和安装

开发环境准备

安装Deno

首先确保系统已安装Deno运行时：

# 使用官方安装脚本（Linux/macOS） curl -fsSL https://deno.land/install.sh | sh # 或者使用Homebrew（macOS） brew install deno # 验证安装 deno --version

项目初始化

创建基础的CLI项目结构：

mkdir deno-cli-demo && cd deno-cli-demo touch mod.ts # 主程序入口 touch deno.json # 项目配置文件 mkdir src # 源代码目录 mkdir tests # 测试文件目录

Deno CLI开发核心技术

命令行参数解析

Deno提供了多种方式处理命令行参数，最常用的是Deno.args和第三方库：

基础参数读取：

// 直接访问命令行参数数组 console.log(Deno.args); // 输出: ["--name", "demo"] // 简单参数解析示例 const args = Deno.args; const nameIndex = args.indexOf("--name"); if (nameIndex > -1 && args.length > nameIndex + 1) { console.log(`Hello, ${args[nameIndex + 1]}!`); }

使用第三方库：对于复杂CLI应用，推荐使用成熟的参数解析库：

// 导入第三方参数解析库 import { parse } from "https://deno.land/std/flags/mod.ts"; const args = parse(Deno.args, { string: ["name"], boolean: ["help", "version"], alias: { h: "help", v: "version" }, default: { name: "Guest" } }); if (args.help) { console.log("Usage: deno run mod.ts [options]"); console.log(" --name Your name (default: Guest)"); console.log(" -h, --help Show help"); Deno.exit(0); } console.log(`Hello, ${args.name}!`);

文件系统交互

Deno的文件系统操作需要显式权限，常用API包括：

读取文件：

// 读取文本文件（需要--allow-read权限） const content = await Deno.readTextFile("./config.json"); const config = JSON.parse(content); // 读取二进制文件 const data = await Deno.readFile("./image.png");

写入文件：

// 写入文本文件（需要--allow-write权限） await Deno.writeTextFile("./output.txt", "Hello Deno CLI!"); // 写入二进制数据 const encoder = new TextEncoder(); await Deno.writeFile("./data.bin", encoder.encode("binary data"));

跨平台路径处理

使用Deno标准库处理不同操作系统的路径差异：

import * as path from "https://deno.land/std/path/mod.ts"; // 获取用户主目录 const homeDir = Deno.env.get("HOME") || Deno.env.get("USERPROFILE"); // 构建跨平台路径 const configPath = path.join(homeDir, ".deno-cli", "config.json"); console.log(configPath); // 在Linux/macOS输出: /home/user/.deno-cli/config.json

构建完整CLI工具实例

项目结构设计

我们将创建一个名为denocli的示例工具，项目结构如下：

deno-cli-demo/ ├── src/ │ └── denocli.ts # CLI核心逻辑 ├── mod.ts # 入口文件 ├── deno.json # 项目配置 └── install.ts # 安装脚本

核心功能实现

src/denocli.ts- 实现基本命令功能：

import { parse } from "https://deno.land/std/flags/mod.ts"; async function main() { const args = parse(Deno.args, { string: ["input", "output"], boolean: ["help", "version"], alias: { h: "help", v: "version", i: "input", o: "output" }, }); // 处理帮助命令 if (args.help) { showHelp(); Deno.exit(0); } // 处理版本命令 if (args.version) { console.log("denocli v1.0.0"); Deno.exit(0); } // 处理文件转换命令 if (args.input && args.output) { try { const content = await Deno.readTextFile(args.input); // 简单转换：转为大写 const result = content.toUpperCase(); await Deno.writeTextFile(args.output, result); console.log(`✅ 成功转换文件: ${args.input} -> ${args.output}`); } catch (err) { console.error(`❌ 转换失败: ${err.message}`); Deno.exit(1); } } else { console.error("缺少必要参数，请使用--help查看用法"); Deno.exit(1); } } function showHelp() { console.log(`denocli - 文件转换工具 用法: denocli [选项] 选项: -i, --input 输入文件路径（必填） -o, --output 输出文件路径（必填） -h, --help 显示帮助信息 -v, --version 显示版本号 示例: denocli --input input.txt --output output.txt `); } main();

mod.ts- 应用入口：

import "./src/denocli.ts";

安装脚本实现

创建install.ts实现CLI工具的系统安装：

const encoder = new TextEncoder(); const decoder = new TextDecoder(); function readSrcFile(filePath: string): string { const buf = Deno.readFileSync(filePath); return decoder.decode(buf); } async function install() { // 获取用户主目录 const HOME = Deno.env.get("HOME") || Deno.env.get("USERPROFILE"); if (!HOME) { console.error("无法确定用户主目录"); Deno.exit(1); } // 定义安装路径 const cliBaseDir = path.join(HOME, ".deno_cli"); const cliBinDir = path.join(cliBaseDir, "bin"); const cliSrcDir = path.join(cliBaseDir, "src"); // 清理旧安装 try { Deno.removeSync(cliBaseDir, { recursive: true }); } catch (err) { // 忽略目录不存在的错误 } // 创建目录结构 Deno.mkdirSync(cliBaseDir, { recursive: true }); Deno.mkdirSync(cliBinDir, { recursive: true }); Deno.mkdirSync(cliSrcDir, { recursive: true }); // 复制源代码 const cliSource = readSrcFile("./src/denocli.ts"); const srcFilePath = path.join(cliSrcDir, "deno_cli.ts"); Deno.writeFileSync(srcFilePath, encoder.encode(cliSource)); // 创建可执行文件 const binFilePath = path.join(cliBinDir, Deno.build.os === "windows" ? "denocli.bat" : "denocli"); const cliBinContent = Deno.build.os === "windows" ? `@deno run --allow-read --allow-write ${srcFilePath} %*` : `#!/bin/sh\ndeno run --allow-read --allow-write ${srcFilePath} "$@"`; Deno.writeFileSync(binFilePath, encoder.encode(cliBinContent)); // 设置可执行权限（非Windows系统） if (Deno.build.os !== "windows") { const execAuth = Deno.run({ cmd: ["chmod", "+x", binFilePath] }); await execAuth.status(); execAuth.close(); } console.log("\n[INFO]: denocli 安装成功!\n"); // 显示环境变量配置提示 const pathConfig = Deno.build.os === "windows" ? `set PATH=%PATH%;${cliBinDir}\n` : `export PATH=$PATH:${cliBinDir} >> ~/.bash_profile\nsource ~/.bash_profile\n`; console.log("请执行以下命令配置环境变量:"); console.log(pathConfig); } install();

安装与测试

图：Deno CLI工具在Linux系统中的安装过程

执行安装脚本：

deno run --allow-all install.ts

按照提示配置环境变量后，即可在终端中使用：

# 查看帮助 denocli --help # 转换文件 denocli --input test.txt --output test_upper.txt

图：Deno CLI工具成功运行的效果展示

高级功能实现

交互式命令行

使用Deno标准库实现交互式输入：

import { prompt } from "https://deno.land/std/cli/prompt.ts"; const name = prompt("请输入您的名字:"); if (name) { console.log(`你好，${name}！`); }

进度条展示

实现命令行进度条：

import { ProgressBar } from "https://deno.land/x/progress@v1.2.4/mod.ts"; const progress = new ProgressBar({ total: 100, complete: "=", incomplete: " ", display: "进度: :percent [:bar] :time elapsed", }); for (let i = 0; i <= 100; i++) { progress.render(i); await new Promise(resolve => setTimeout(resolve, 50)); }

编译为独立可执行文件

Deno支持将应用编译为独立二进制文件，方便分发：

# 编译为当前平台可执行文件 deno compile --allow-read --allow-write --output denocli mod.ts # 跨平台编译（需要对应平台的Deno版本） deno compile --target x86_64-pc-windows-msvc --output denocli.exe mod.ts deno compile --target x86_64-apple-darwin --output denocli-macos mod.ts

测试与调试

单元测试

使用Deno内置测试框架编写测试：

// tests/denocli_test.ts import { assertEquals } from "https://deno.land/std/testing/asserts.ts"; import { parseArgs } from "../src/utils.ts"; Deno.test("parseArgs should handle name parameter", () => { const args = parseArgs(["--name", "test"]); assertEquals(args.name, "test"); });

运行测试：

deno test --allow-read tests/

调试技巧

图：在VS Code中配置Deno CLI调试环境

在VS Code中配置.vscode/launch.json：

{ "version": "0.2.0", "configurations": [ { "name": "denocli", "type": "node", "request": "launch", "cwd": "${workspaceFolder}", "runtimeExecutable": "deno", "runtimeArgs": ["run", "--inspect", "--allow-all", "mod.ts", "--input", "test.txt", "--output", "out.txt"], "port": 9229 } ] }

发布与分发

创建安装脚本

为不同平台创建安装脚本：

install.sh (Linux/macOS)：

#!/bin/sh curl -fsSL https://example.com/denocli/install.sh | sh

install.ps1 (Windows)：

iwr https://example.com/denocli/install.ps1 -useb | iex

版本控制与更新

实现版本检查功能：

async function checkUpdate(currentVersion: string) { try { const response = await fetch("https://example.com/denocli/latest-version.json"); const data = await response.json(); if (data.version > currentVersion) { console.log(`有新版本可用: ${data.version} (当前: ${currentVersion})`); console.log("使用 denocli update 命令更新"); } } catch (err) { // 忽略更新检查错误 } }