Execa 项目技术文档

Execa 项目技术文档

execa Process execution for humans 项目地址: https://gitcode.com/gh_mirrors/ex/execa

1. 安装指南

1.1 安装环境要求

• Node.js 版本 >= 12.20.0
• npm 或 yarn 包管理器

1.2 安装步骤

1. 打开终端或命令行工具。
2. 运行以下命令安装 execa：

npm install execa

或者使用 yarn：

yarn add execa

2. 项目使用说明

2.1 基本使用

execa 是一个用于在脚本、应用程序或库中执行命令的工具。它基于 Node.js 的 child_process 模块，并进行了优化，使其更适合程序化使用。

2.2 示例代码

2.2.1 简单语法

import {execa} from 'execa';

const {stdout} = await execa`npm run build`;
console.log(stdout);

2.2.2 脚本接口

import {$} from 'execa';

const {stdout: name} = await $`cat package.json`.pipe`grep name`;
console.log(name);

const branch = await $`git branch --show-current`;
await $`dep deploy --branch=${branch}`;

2.2.3 本地二进制文件

await execa({preferLocal: true})`eslint`;

3. 项目API使用文档

3.1 基本执行

3.1.1 简单语法

import {execa} from 'execa';

const {stdout} = await execa`npm run build`;
console.log(stdout);

3.1.2 脚本接口

import {$} from 'execa';

const {stdout: name} = await $`cat package.json`.pipe`grep name`;
console.log(name);

3.2 输入/输出

3.2.1 交错输出

const {all} = await execa({all: true})`npm run build`;
console.log(all);

3.2.2 程序化 + 终端输出

const {stdout} = await execa({stdout: ['pipe', 'inherit']})`npm run build`;
console.log(stdout);

3.3 高级用法

3.3.1 管道多个子进程

const {stdout, pipedFrom} = await execa`npm run build`
	.pipe`sort`
	.pipe`head -n 2`;

console.log(stdout);
console.log(pipedFrom[0].stdout);
console.log(pipedFrom[0].pipedFrom[0].stdout);

3.3.2 流处理

for await (const line of execa`npm run build`) {
	if (line.includes('WARN')) {
		console.warn(line);
	}
}

4. 项目安装方式

4.1 使用 npm 安装

npm install execa

4.2 使用 yarn 安装

yarn add execa

通过以上步骤，您可以轻松安装并使用 execa 项目。详细的 API 文档和示例代码可以帮助您更好地理解和使用该工具。

execa Process execution for humans 项目地址: https://gitcode.com/gh_mirrors/ex/execa