wrench.js 技术文档

1. 安装指南

由于 wrench.js 项目已经过时且不再维护，建议使用 fs-extra 作为替代方案。如果你仍然需要使用 wrench.js，可以通过以下命令进行安装：

npm install wrench

2. 项目的使用说明

wrench.js 是一个用于在 Node.js 中执行递归文件操作的库。它提供了同步和异步的文件操作方法，包括创建目录、删除目录、复制目录、读取目录内容等。

2.1 同步操作

以下是一些常用的同步操作示例：

• 递归创建目录：

  wrench.mkdirSyncRecursive('my_directory_name', 0777);
  

• 递归删除目录：

  wrench.rmdirSyncRecursive('my_directory_name', false);
  

• 递归读取目录内容：

  wrench.readdirSyncRecursive('my_directory_name');
  

• 递归修改文件权限：

  wrench.chmodSyncRecursive('my_directory_name', 0755);
  

• 递归修改文件所有者：

  wrench.chownSyncRecursive('my_directory_name', uid, gid);
  

• 递归复制目录：

  wrench.copyDirSyncRecursive('source_directory', 'destination_directory', {
      forceDelete: true,
      excludeHiddenUnix: false,
      preserveFiles: true,
      preserveTimestamps: true,
      inflateSymlinks: false,
      filter: /\.txt$/,
      whitelist: false,
      include: /\.js$/,
      exclude: /\.log$/
  });
  

• 逐行读取文件：

  var f = new wrench.LineReader('file.txt');
  while(f.hasNextLine()) {
      console.log(f.getNextLine());
  }
  f.close();
  

2.2 异步操作

以下是一些常用的异步操作示例：

• 递归读取目录内容：

  wrench.readdirRecursive('my_directory_name', function(error, files) {
      if (error) {
          console.error(error);
      } else {
          console.log(files);
      }
  });
  

• 递归复制目录：

  wrench.copyDirRecursive('source_directory', 'destination_directory', {forceDelete: true}, function(error) {
      if (error) {
          console.error(error);
      } else {
          console.log('Directory copied successfully');
      }
  });
  

3. 项目API使用文档

3.1 同步API

• mkdirSyncRecursive(dir, mode)：递归创建目录。
• rmdirSyncRecursive(dir, failSilently)：递归删除目录及其子树。
• readdirSyncRecursive(dir)：递归读取目录内容。
• chmodSyncRecursive(dir, mode)：递归修改目录及其子树的文件权限。
• chownSyncRecursive(dir, uid, gid)：递归修改目录及其子树的文件所有者。
• copyDirSyncRecursive(srcDir, newDir, options)：递归复制目录。
• LineReader(filename)：逐行读取文件。

3.2 异步API

• readdirRecursive(dir, callback)：递归读取目录内容。
• copyDirRecursive(srcDir, newDir, options, callback)：递归复制目录。

4. 项目安装方式

如前所述，wrench.js 已经过时，建议使用 fs-extra 作为替代方案。如果你仍然需要安装 wrench.js，可以使用以下命令：

npm install wrench

---

注意：由于 wrench.js 不再维护，建议迁移到 fs-extra 以获得更好的支持和功能。