muliminty note

奇技淫巧：ZX 库介绍与使用笔记

7分钟阅读

ZX 库介绍与使用笔记

ZX 是由 Google 开发的一个 Node.js 库，用于简化命令行操作，并提供更为简洁和易用的 API。它让你能够轻松在 JavaScript/TypeScript 中执行 shell 命令，同时支持变量替换、错误处理、异步操作等功能，非常适合自动化任务、脚本编写和日常开发工作中与终端交互的需求。

1. 什么是 ZX？

ZX 库的目标是通过简化 shell 命令的执行，使 Node.js 脚本编写更加直观，避免了回调地狱和繁琐的错误处理。通过提供类似模板字符串的语法，ZX 让你能够像写 JavaScript 一样编写命令行脚本。

核心特性：

  • 简洁的命令执行语法。
  • 支持异步命令，支持 await 语法。
  • 轻松处理命令输出和错误。
  • 可以执行本地或远程命令。

2. 安装 ZX

首先需要安装 ZX 库，使用 npm 或 yarn 进行安装：

npm install zx

或者使用 yarn：

yarn add zx

3. 基本使用

在 ZX 中，你可以使用 await $ 来执行 shell 命令。与传统的 child_process 模块相比，ZX 提供了更简洁、更易于理解的语法。

示例：运行一个简单的命令

import { $ } from 'zx';
 
async function runCommand() {
  await $`echo Hello, World!`;
}
 
runCommand();

该命令会在终端输出 Hello, World!。

示例：获取命令输出

import { $ } from 'zx';
 
async function getDate() {
  const result = await $`date`;
  console.log(result.stdout);  // 输出当前日期
}
 
getDate();

4. 支持模板字符串

ZX 支持通过模板字符串传递参数，这让命令的书写更加直观，避免了手动拼接字符串。

import { $ } from 'zx';
 
async function getDiskUsage() {
  const directory = '/home/user';
  const result = await $`du -sh ${directory}`;
  console.log(result.stdout);  // 输出指定目录的磁盘使用情况
}
 
getDiskUsage();

在上面的示例中，ZX 自动处理模板字符串中的变量替换。

5. 错误处理

默认情况下，ZX 会在命令失败时抛出异常。你可以使用 try...catch 来捕获这些异常，并进行相应的错误处理。

import { $ } from 'zx';
 
async function runCommand() {
  try {
    await $`invalid_command`;  // 运行一个无效的命令
  } catch (error) {
    console.error('命令执行失败:', error.message);
  }
}
 
runCommand();

6. 并发执行多个命令

ZX 允许你并行执行多个命令，而不会阻塞程序的执行。这对于一些需要并发执行的任务非常有用。

import { $ } from 'zx';
 
async function runMultipleCommands() {
  const [output1, output2] = await Promise.all([
    $`echo Command 1`,
    $`echo Command 2`
  ]);
  console.log(output1.stdout);
  console.log(output2.stdout);
}
 
runMultipleCommands();

通过 Promise.all() 可以并行执行多个命令，这样可以提高执行效率。

7. 处理命令输出

通过 ZX 的 API，可以轻松获取命令的标准输出和标准错误输出。返回值包括 stdout 和 stderr，分别代表命令的标准输出和标准错误输出。

import { $ } from 'zx';
 
async function runCommand() {
  const result = await $`ls -l`;
  console.log('命令输出:', result.stdout);  // 输出文件列表
  console.log('错误输出:', result.stderr);  // 输出错误信息（如果有）
}
 
runCommand();

8. 高级功能：错误码处理

ZX 允许你通过 exitCode 属性来处理命令的退出状态码。如果需要对退出状态码进行更细粒度的控制，可以使用该属性。

import { $ } from 'zx';
 
async function runCommand() {
  const result = await $`ls /nonexistent`;
  
  if (result.exitCode !== 0) {
    console.error('命令执行失败，错误码:', result.exitCode);
  }
}
 
runCommand();

9. 实用的小功能与技巧

以下是一些基于 ZX 的实用小功能：

自动化文件备份

import { $ } from 'zx';
 
async function backupFiles() {
  const timestamp = new Date().toISOString().split('T')[0];
  const backupFolder = `backup-${timestamp}`;
  
  await $`mkdir ${backupFolder}`;
  await $`cp -r ./important-folder/* ${backupFolder}`;
  
  console.log('备份完成！');
}
 
backupFiles();

批量安装 npm 包

import { $ } from 'zx';
 
async function installPackages() {
  const packages = ['lodash', 'axios', 'react', 'express'];
 
  for (const pkg of packages) {
    try {
      console.log(`正在安装 ${pkg}...`);
      await $`npm install ${pkg}`;
      console.log(`${pkg} 安装成功`);
    } catch (error) {
      console.error(`${pkg} 安装失败:`, error);
    }
  }
}
 
installPackages();

自动化 Git 提交和推送

import { $ } from 'zx';
 
async function gitCommitAndPush() {
  const commitMessage = '自动提交: ' + new Date().toISOString();
  
  await $`git add .`;
  await $`git commit -m ${commitMessage}`;
  await $`git push`;
  
  console.log('代码已提交并推送至远程仓库');
}
 
gitCommitAndPush();

批量重命名文件

import { $ } from 'zx';
 
async function renameFiles() {
  const files = await $`ls ./files`;
  
  for (const file of files.stdout.split('\n')) {
    const newName = file.replace('old', 'new');
    await $`mv ./files/${file} ./files/${newName}`;
    console.log(`${file} 重命名为 ${newName}`);
  }
}
 
renameFiles();

10. 总结

ZX 是一个非常强大且易用的工具，能够帮助开发者简化命令行操作并提高开发效率。它通过模板字符串、自动错误处理、异步执行、并发控制等特性，让命令行脚本变得更加简洁和高效。适用于自动化构建、部署、文件管理、批量操作等场景，是一个非常适合开发者日常使用的工具。

如果你常常需要写一些与命令行交互的脚本，ZX 无疑是一个非常值得尝试的工具。

关系图谱