Google zx 项目安装与配置完全指南

Google zx 项目安装与配置完全指南

zx A tool for writing better scripts 项目地址: https://gitcode.com/gh_mirrors/zx/zx

前言

Google zx 是一个强大的脚本工具，它让开发者能够使用现代 JavaScript 编写高效的命令行脚本。本文将详细介绍如何在不同环境中安装和配置 zx，帮助开发者快速上手这个实用工具。

系统要求

在开始安装之前，请确保您的系统满足以下基本要求：

1. 操作系统支持：

   • Linux
   • macOS
   • Windows

2. JavaScript 运行时环境（任选其一）：

   • Node.js 12.17.0 或更高版本
   • Bun 1.0.0 或更高版本
   • Deno 1.x 或 2.x 版本
   • GraalVM Node.js

3. Shell 环境：

   • Bash
   • PowerShell

安装方法

zx 提供了多种安装方式以适应不同的开发环境和需求：

1. 使用包管理器安装

# 使用 npm 安装（推荐）
npm install zx  # 添加 -g 参数可全局安装

# 使用 yarn 安装
yarn add zx

# 使用 pnpm 安装
pnpm add zx

# 使用 bun 安装
bun install zx

2. 无需安装直接运行

对于临时使用或测试场景，可以使用 npx 直接运行脚本而无需安装：

npx zx script.js  # 不安装 zx 包直接运行脚本
npx zx@8.5.0 script.js  # 指定特定版本的 zx

3. 使用 Homebrew 安装（macOS/Linux）

brew install zx

4. Deno 环境安装

deno install -A npm:zx

# 注意：zx 需要额外权限
# --allow-read --allow-sys --allow-env --allow-run

5. Docker 方式运行

# 拉取最新镜像
docker pull ghcr.io/google/zx:8.5.0

# 运行简单命令
docker run -t ghcr.io/google/zx:8.5.0 -e="await \$({verbose: true})\`echo foo\`"

# 挂载本地脚本运行
docker run -t -i -v ./:/script ghcr.io/google/zx:8.5.0 script/t.js

版本选择策略

zx 提供了多个版本通道，满足不同场景需求：

1. Lite 版本：仅包含核心功能

   npm i zx@lite
   

2. 开发版：包含最新特性（可能不稳定）

   npm i zx@dev
   

建议生产环境使用稳定版本，开发环境可以尝试开发版获取最新功能。

Shell 环境配置

zx 默认使用 Bash 作为执行环境，但也支持其他 Shell：

import { useBash, usePowerShell, usePwsh } from 'zx'

// 切换到 PowerShell
usePowerShell()  // 使用 PowerShell.exe
usePwsh()        // 使用 pwsh 二进制文件 (PowerShell v7+)

// 切换回 Bash
useBash()

对于 Windows 用户，建议安装 Windows Subsystem for Linux (WSL) 或 Git Bash 以获得最佳体验。

模块系统支持

zx 采用混合包设计，支持多种模块系统：

1. ES 模块：

   import { $ } from 'zx'
   

2. CommonJS 模块：

   const { $ } = require('zx')
   

3. TypeScript 支持： zx 内置 TypeScript 类型定义，但需要额外安装类型声明：

   npm i -D @types/fs-extra @types/node
   

   类型使用示例：

   import { type Options } from 'zx'
   
   const opts: Options = {
     quiet: true,
     timeout: '5s'
   }
   

高级功能入口

zx 提供了多个专用入口点：

1. 主入口 (zx)：提供完整功能
2. 全局作用域 (zx/global)：将 zx 函数注入全局作用域
3. 命令行接口 (zx/cli)：从命令行运行 zx 脚本
4. 核心功能 (zx/core)：作为第三方库的模板生成器

最佳实践建议

1. 版本控制：生产环境建议固定 zx 版本
2. 权限管理：特别是使用 Deno 时，注意权限控制
3. 环境隔离：考虑使用 Docker 容器确保环境一致性
4. 性能优化：对于大型项目，使用全局安装减少重复下载

通过本文的详细介绍，您应该已经掌握了在不同环境中安装和配置 Google zx 的方法。zx 的强大功能将帮助您更高效地编写和管理命令行脚本，提升开发效率。

zx A tool for writing better scripts 项目地址: https://gitcode.com/gh_mirrors/zx/zx