超实用Node工具shelljs：让Windows也能流畅运行Unix命令
项目地址: https://gitcode.com/gh_mirrors/sh/shelljs 你是否曾在Windows系统开发时因命令行工具差异而头疼？想运行ls、cp等Unix命令却只能使用冗长的dir、copy？ShellJS（GitHub 加速计划 / sh / shelljs）正是为解决这一痛点而生的跨平台Node.js工具库。本文将带你快速掌握这个让Windows开发者也能享受Unix命令体验的实用工具。
什么是ShellJS？
ShellJS是一个在Node.js环境下实现的Unix命令行工具集，它将ls、cd、cp等常用Unix命令封装为JavaScript API，使开发者能在Windows、Linux和macOS等不同操作系统上使用统一的命令语法。项目核心目标是消除Node.js脚本对特定操作系统的依赖，同时保留Unix命令的强大功能和熟悉语法。
作为GitHub上星标过万的开源项目，ShellJS已被众多知名工具采用，包括Firebug调试器、JSHint/ESLint代码检查工具、Yeoman前端脚手架等。通过src/目录下的模块化实现，ShellJS提供了近30种常用Unix命令的跨平台支持，完整命令列表可查看README.md的"Command reference"章节。
快速开始：5分钟上手ShellJS
安装与引入
使用npm即可完成ShellJS的安装，支持全局或本地项目安装：
# 本地安装（推荐）
npm install shelljs
# 全局安装（用于命令行工具）
npm install -g shelljs
在Node.js脚本中引入ShellJS有两种方式，推荐使用命名空间方式引入以避免全局污染：
// 推荐：命名空间引入
const shell = require('shelljs');
// 不推荐：全局引入（会污染全局命名空间）
require('shelljs/global');
基础命令示例
以下是几个常用命令的基本用法，所有命令均返回ShellString对象，该对象同时包含命令执行结果、状态码等信息：
// 检查是否安装了git
if (!shell.which('git')) {
shell.echo('⚠️ 此脚本需要git，请先安装');
shell.exit(1);
}
// 创建并进入临时目录
shell.mkdir('-p', 'temp/project');
shell.cd('temp/project');
// 文件操作示例
shell.touch('index.js');
shell.echo('console.log("Hello ShellJS")').to('index.js');
// 目录操作示例
shell.ls().forEach(file => {
shell.echo(`📄 ${file}`);
});
// 返回上一级目录并清理
shell.cd('..');
shell.rm('-rf', 'project');
核心功能解析
文件系统操作
ShellJS提供了完整的文件系统操作API，所有命令均支持跨平台运行。以下是几个最常用的文件操作命令：
复制文件/目录：使用cp命令，支持递归复制目录（-R参数）和强制覆盖（-f参数）：
// 递归复制目录
shell.cp('-R', 'src/', 'dist/');
// 复制多个文件到目标目录
shell.cp('*.js', '*.json', 'backup/');
移动/重命名：使用mv命令，支持批量操作：
// 重命名文件
shell.mv('oldname.txt', 'newname.txt');
// 移动多个文件到目录
shell.mv(['a.js', 'b.json'], 'scripts/');
目录导航：cd命令会更改脚本执行的当前工作目录，pwd命令返回当前路径：
const originalDir = shell.pwd(); // 保存当前目录
shell.cd('src/utils'); // 进入子目录
// 执行操作...
shell.cd(originalDir); // 恢复原目录
完整的文件系统命令实现可查看src/cp.js（复制）、src/mv.js（移动）和src/cd.js（目录切换）等源码文件。
命令执行与流程控制
ShellJS不仅提供文件操作命令，还支持执行外部命令和流程控制，使脚本编写更加灵活。
执行外部命令：exec方法可执行系统命令，支持同步和异步两种模式：
// 同步执行并获取输出
const nodeVersion = shell.exec('node --version', { silent: true }).stdout;
console.log(`Node.js版本: ${nodeVersion}`);
// 异步执行带回调
shell.exec('npm install', { async: true }, (code, stdout, stderr) => {
if (code !== 0) {
console.error(`安装失败: ${stderr}`);
return;
}
console.log('依赖安装完成');
});
条件判断：test命令提供文件类型检测功能，相当于Unix的[ ]或test命令：
// 检查文件是否存在
if (shell.test('-f', 'package.json')) {
console.log('项目配置文件存在');
}
// 检查目录是否存在
if (shell.test('-d', 'node_modules')) {
console.log('依赖目录已存在');
}
错误处理：通过设置config.fatal为true，可让ShellJS在命令执行失败时抛出异常，便于错误捕获：
shell.config.fatal = true; // 开启错误致命模式
try {
shell.cp('不存在的文件', '目标'); // 此命令会失败
} catch (e) {
console.error(`操作失败: ${e.message}`);
}
高级功能与最佳实践
管道操作
ShellJS支持命令间的管道操作，类似于Unix的|操作符，可将一个命令的输出作为另一个命令的输入：
// 查找包含"ERROR"的日志行并统计出现次数
const errorCount = shell.cat('app.log')
.grep('ERROR')
.wc('-l')
.stdout;
console.log(`错误总数: ${errorCount}`);
// 将处理结果写入文件
shell.ls('src/*.js')
.grep('-v', 'test') // 排除测试文件
.sed(/var/, 'const') // 替换关键字
.to('modified_files.txt');
目录栈管理
对于需要频繁切换目录的场景，ShellJS提供了pushd、popd和dirs命令管理目录栈，类似Unix的目录栈功能：
// 保存当前目录并进入子目录
shell.pushd('docs');
// 执行文档相关操作...
// 切换到之前保存的目录
shell.popd();
// 查看目录栈
console.log('目录栈:', shell.dirs());
配置选项
通过config对象可自定义ShellJS的行为，常用配置包括：
// 配置示例
const shell = require('shelljs');
// 静默模式：不输出命令执行结果
shell.config.silent = true;
// 致命错误：命令失败时抛出异常
shell.config.fatal = true;
// 详细模式：输出所有执行的命令
shell.config.verbose = true;
更多配置选项可参考README.md的"Configuration"章节。
实战案例：跨平台构建脚本
下面是一个使用ShellJS编写的前端项目构建脚本示例，展示了如何结合多种命令实现跨平台的项目构建流程：
const shell = require('shelljs');
const path = require('path');
// 配置ShellJS
shell.config.fatal = true; // 命令失败时终止
shell.config.silent = false; // 输出执行过程
try {
// 1. 清理旧构建目录
console.log('🔧 清理旧构建...');
shell.rm('-rf', 'dist');
shell.mkdir('-p', 'dist/js', 'dist/css', 'dist/images');
// 2. 检查依赖
console.log('🔧 检查构建依赖...');
if (!shell.which('node') || !shell.which('npm')) {
throw new Error('需要Node.js和npm环境');
}
// 3. 安装依赖
console.log('🔧 安装依赖...');
shell.exec('npm install');
// 4. 编译JS
console.log('🔧 编译JavaScript...');
shell.exec('npx babel src/js --out-dir dist/js');
// 5. 编译CSS
console.log('🔧 编译CSS...');
shell.exec('npx sass src/scss:dist/css');
// 6. 复制静态资源
console.log('🔧 复制静态资源...');
shell.cp('-R', 'src/images/*', 'dist/images/');
// 7. 生成版本信息
const version = shell.exec('git rev-parse --short HEAD', { silent: true }).stdout.trim();
shell.echo(`export const VERSION = '${version}';`).to('dist/js/version.js');
console.log('✅ 构建完成！输出目录: dist/');
} catch (e) {
console.error(`❌ 构建失败: ${e.message}`);
shell.exit(1);
}
这个脚本实现了从清理旧文件、检查环境、安装依赖到编译代码、复制资源的完整构建流程，通过ShellJS的跨平台特性，可在Windows、macOS和Linux系统上无缝运行，无需修改命令语法。
常见问题与解决方案
路径处理注意事项
Windows系统使用反斜杠\作为路径分隔符，而Unix系统使用正斜杠/。为确保跨平台兼容性，建议使用Node.js的path模块处理路径：
const path = require('path');
// 错误：硬编码路径分隔符
shell.cd('src\\utils'); // Windows专用，在Linux/macOS会失败
// 正确：使用path模块
shell.cd(path.join('src', 'utils')); // 跨平台兼容
命令参数差异
虽然ShellJS尽力模拟Unix命令行为，但部分命令参数存在细微差异。例如ls -l在ShellJS中返回的是结构化对象而非字符串：
// 获取文件详细信息
const fileInfo = shell.ls('-l', 'package.json');
console.log('文件大小:', fileInfo.size);
console.log('修改时间:', new Date(fileInfo.mtime));
完整的参数差异说明可参考README.md中的"Command reference"部分。
性能考量
对于处理大量文件或大型目录的场景，建议使用异步操作并添加进度提示：
// 异步处理大量文件
async function processLargeDirectory() {
const files = shell.find('large_dir').filter(file => file.endsWith('.txt'));
console.log(`找到${files.length}个文件需要处理`);
for (const [index, file] of files.entries()) {
// 显示进度
if (index % 10 === 0) console.log(`处理中: ${index}/${files.length}`);
// 异步处理单个文件
await new Promise(resolve => {
shell.sed('-i', 'old', 'new', file, () => resolve());
});
}
}
总结与扩展
ShellJS通过将Unix命令封装为Node.js API，有效解决了跨平台命令行操作的兼容性问题，使开发者能够使用熟悉的Unix命令语法编写可在Windows、Linux和macOS上运行的脚本。无论是简单的文件操作还是复杂的构建流程，ShellJS都能提供简洁而强大的API支持。
项目的模块化设计（src/目录下每个命令一个文件）和完善的测试覆盖（test/目录）确保了代码质量和功能稳定性。如果需要扩展ShellJS功能，可参考wiki文档开发自定义插件。
对于命令行直接使用场景，ShellJS团队还提供了配套项目shelljs/shx，可直接在终端中使用ShellJS命令。
通过掌握ShellJS，开发者可以告别批处理文件和PowerShell脚本，用JavaScript编写真正跨平台的系统工具，大幅提升开发效率和脚本可维护性。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
