cash-pwd 源码解析：用纯 ES6 跨平台实现 Unix pwd 命令

pwd 是 Unix/Linux 中最基础也最高频的命令之一，用于打印当前工作目录的绝对路径。本文围绕 Cash 开源项目中的 packages/pwd/README.md 展开，深入讲解 cash-pwd 这个独立 npm 子包的定位、安装方式、命令行用法，并结合 src/commands/pwd.js 等源码揭示其在 Node.js 中仅用标准库实现跨平台目录输出的原理。读完本文，你将掌握 cash-pwd 的全局安装与三种调用方式，并理解它如何以十几行代码复刻 Unix pwd 的核心行为，以及它在 Windows / macOS / Linux 之间保持一致的输出策略。

cash-pwd 是什么：一份 100% ES6 的跨平台实现

按照 packages/pwd/README.md 的定位，cash-pwd 是 Unix pwd 命令的跨平台、100% ES6 实现。它与 Cash 主项目的描述完全一致——Cash 的目标是“用纯 ES6 实现 Unix shell 命令，无原生编译、无外部依赖”，让 Windows 用户也能体验到 Linux 风格的命令行工具。

从包结构看，cash-pwd 的独立性体现在 packages/pwd/package.json：

• 包名 cash-pwd，main 指向 ./dist/commands/pwd.js；
• bin 字段将 pwd 命令映射到 ./bin/pwd.js，这是全局安装后系统路径中可直接调用的入口；
• dependencies 仅声明 vorpal（命令交互框架），没有文件操作类第三方依赖；
• engines 声明 node >= 0.11.16、iojs >= 1.0.0。

这一点也可以在 commands.json 的构建配置中得到印证：pwd 子包运行时依赖为空数组，随包分发的源码文件只有 ./dist/util/interfacer.js 一个公共工具，说明它的实现相当轻量，几乎完全依赖 Node 内置能力。

安装与全局使用

原文档给出的安装方式非常简洁，这也是该子包的核心使用路径：

npm install cash-pwd -g

-g 参数表示全局安装。安装完成后，pwd 会被放进系统 PATH（文档原文："This will install pwd globally in your system path"），此后你可以在任意终端直接敲出：

pwd

这条命令的底层入口链是：全局 bin 脚本 bin/pwd.js → bin/parser.js 的参数分发逻辑 → 加载 dist/commands/pwd.js 并执行。从 bin/parser.js 的源码结构看，当 pwd 不带任何参数时，解析器会走“最快路径”：直接 require 命令模块并调用其 exec，连 Vorpal 交互层都不加载；只有带参数或需要管道时才加载完整命令框架。这也是为什么独立安装的 cash-pwd 仍然保持了接近原生命令的轻快体验。

安装后如需查看命令说明，按文档提示输入：

pwd --help

命令帮助与退出状态

pwd --help 输出的帮助文本定义在 src/help/pwd.js 中，与 Unix 标准工具的风貌一致：

Usage: pwd [-LP]
Print the name of the current working directory.

      --help        display this help and exit

Exit status:
  0   if OK,
  1   if an invalid option is given or the current directory
      cannot be read.

其中 -L 与 -P 是 POSIX 规范中的两个经典选项：-L（逻辑路径）保留符号链接，-P（物理路径）解析出链接背后的真实目录。帮助文本完整继承了这一语义说明。需要特别说明的是：从当前源码看，cash-pwd 的 exec() 实现并不实际解析这两个选项（见下一节），帮助文本提供的是标准语义的参考，使用时不应假设选项会对输出产生差异。

核心实现源码解析：只有四行的 exec

cash-pwd 的全部核心逻辑集中在 src/commands/pwd.js：

'use strict';

const path = require('path');

const interfacer = require('./../util/interfacer');

const pwd = {
  exec() {
    this.log(path.resolve(process.cwd()).replace(/\\/g, '/'));
    return 0;
  }
};

逐行拆解其原理：

1. process.cwd()：Node 内置方法，返回进程当前工作目录的绝对路径。这是整个命令的数据来源，等价于 Unix 内核眼中的“当前目录”。
2. path.resolve(...)：对路径做标准化处理，将其解析为规范的绝对路径，消除 ..、. 等冗余片段。对绝大多数场景而言，process.cwd() 本身就是绝对路径，path.resolve 在这里起“规范化兜底”的作用。
3. .replace(/\\/g, '/')：这是跨平台的关键一行。在 Windows 上，路径分隔符是反斜杠 \，而 Unix 约定使用正斜杠 /。这行正则把所有反斜杠统一替换为正斜杠，从而保证无论运行在哪个操作系统，pwd 的输出格式都与 Unix 风格一致。这正是“cross-platform”承诺的具体落点。
4. return 0：遵循 Unix 退出码约定，成功时返回 0（与帮助文本中 Exit status: 0 if OK 对应）。

模块导出的函数体还承担了命令注册工作：

module.exports = function (vorpal) {
  if (vorpal === undefined) {
    return pwd;
  }
  vorpal.api.pwd = pwd;
  vorpal
    .command('pwd [files...]')
    .action(function (args, callback) {
      args.options = args.options || {};
      return interfacer.call(this, {
        command: pwd,
        args: args.files,
        options: args.options,
        callback
      });
    });
};

• 当以独立模块（无 vorpal 参数）调用时，直接返回 pwd 对象，供 bin 脚本快速执行；
• 在 Cash 主程序内则把 pwd 挂到 vorpal.api.pwd，并通过 interfacer 统一封装输出与回调。interfacer 会把 exec 返回的 0 归一为退出状态，并把 this.log 的每次输出累积为最终 stdout 字符串——这意味着同一份 pwd 实现可以被 Vorpal 交互 shell、全局命令行和程序化 API 三种入口复用。

测试用例如何验证行为

test/pwd.js 用 Mocha + should 覆盖了三条核心断言：

1. 存在性：cash.pwd 存在且是函数；
2. 输出当前目录：调用 cash.pwd() 的输出字符串应包含 cash（即项目仓库路径关键字）；
3. 随目录切换而变：先确认当前输出不含 node_modules，再通过 shelljs 的 $.cd('./node_modules') 切换工作目录，此时 cash.pwd() 的输出应包含 node_modules，最后 $.cd('..') 切回。

第三条用例直接验证了 pwd 的语义本质——输出始终跟随进程当前工作目录实时变化，而非缓存路径。这为“目录切换后 pwd 立即反映新目录”的行为提供了可复现的证据。

三种调用方式：全局、交互 shell 与程序化 API

cash-pwd 作为 Cash 生态的一部分，除了全局安装后独立使用外，还有两种典型的程序化用法（对应 Cash 主项目 README.md 的使用说明）：

方式一：在主项目内作为 API 调用

const $ = require('cash');
const out = $.pwd();   // 输出当前工作目录字符串

Cash 主项目加载命令时，会把每个 vorpal.api 上的命令包装成导出函数（见 src/index.js），并默认以 silent: true 静默模式执行、通过回调返回 stdout。测试用例正是以这种方式运行的。

方式二：以字符串执行整条命令

const out = $('pwd');  // 等价于在 shell 里敲 pwd

此外，如果你安装了完整的 cash 主包（bin 为 cash / $），进入交互式 shell 后同样可以直接输入 pwd。三种入口最终都汇聚到 src/commands/pwd.js 同一份实现，这正是 interfacer 抽象的价值所在。

与 Cash 生态及构建流程的关系

cash-pwd 不是孤立发布的：它是 Cash 项目“一命令一子包”发布策略的一部分。gulpfile.js 中的 packages 任务会为每个命令自动生成独立的 npm 子包目录（packages/pwd），并拷贝对应的 dist/commands/pwd.js、dist/help/pwd.js、bin/pwd.js 与解析器，最后依据 commands.json 中 packages.pwd 的配置写出子包 package.json。也就是说，packages/pwd/README.md 本身也由 packages/template.README.md 模板批量生成，cash-pwd 与 cash-ls、cash-rm、cash-cat 等其他十余个命令共享同一套结构（参见 packages 目录）。

这种“主仓库开发 → Babel 编译到 dist → 按命令拆分发布”的流程，让用户既可以 npm install cash 获得完整 shell，也可以只装 cash-pwd 一个命令，做到按需取用。

使用注意事项与边界

结合源码可以总结出几点实际使用中值得留意的边界：

• 选项处理为空：尽管帮助文本声明了 [-LP]，但 exec() 不接受参数也不解析选项（注册的 pwd [files...] 只是 Vorpal 的命令骨架），传入 -L/-P 不会改变输出。若项目后续需要严格的 POSIX 行为，这一差异是需要关注的点（从源码结构推断，非文档声明事实）。
• 符号链接语义：process.cwd() 在多数 Node 版本下返回的是物理路径，不会保留 shell 层 cd 建立的符号链接语义；这与 -L 的“逻辑路径”期望存在差异。
• 输出格式统一为正斜杠：/ 分隔符在 Windows 上同样可被 Node 与大多数工具正确解析，这是有意为之的跨平台设计。

总体而言，cash-pwd 用极简的代码实现了 pwd 的核心价值——实时、准确、跨平台地输出当前工作目录，并在安装、帮助、退出码与测试等方面保持了与 Unix 原生命令一致的体验，是理解“如何用 JavaScript 复刻 Unix 命令”时值得精读的轻量样例。