基于Regex递归地重命名文件和文件夹

Question

我有此文件结构：

FolderName/
    [NAME]/
        [NAME].controller.js
        [NAME].html

使用node.js我想用变量替换[名称]。

这是我尝试的：

const shell = require("shelljs");
shell.ls('-Rl', '.').forEach(entry => {
  if (entry.name.includes(`[NAME]`)) {
    let newName = entry.name.replace(/[NAME]/, "Test");
    shell.mv(entry.name, newName);
  }
});

这只会将文件夹[NAME]重命名为 Test，然后将文件不触及。并输出此：

mv: no such file or directory: FolderName/[NAME]/[NAME].controller.js
mv: no such file or directory: FolderName/[NAME]/[NAME].html

Answer 1

问题

在示例的上下文中运行shell.mv(entry.name, newName);时，它试图移动/更改不再存在的路径，因为它在循环的前一回合中已更改。这导致错误：

mv: no such file or directory: FolderName/[NAME]/[NAME].controller.js

mv: no such file or directory: FolderName/[NAME]/[NAME].html

---

解决方案

避免错误尝试以下方法：

1. 利用shelljs查找命令获得路径而不是LS。这将确保所得路径包括基本目录。
2. 迭代每条路径，filter排除了资产不包含要查找的字符串的任何路径（例如[NAME]。还排除任何隐藏的资产（即以DOT .开头的名称）
3. 按照降序的深度对路径的数组进行排序。
4. 仅替换每个路径中的替换字符串（例如TEST）的字符串的最后一个实例（例如[NAME]）。然后最终使用shelljs MV命令应用新路径。

注意：作为保障（步骤4），仅在尚未采用新的结果路径时，资产/路径才会重命名。如果新路径确实存在，则报告那些不应重命名的路径。例如，为了更好地理解这一点，让我们假设我们的初始目录构成如下：

初始目录结构。

.
└── [NAME]
    ├── [NAME].controller.js
    ├── [NAME].html
    └── TEST.html

...如果我们运行脚本以搜索字符串[NAME]以被字符串TEST替换 - 那么我们有潜在的问题。如果要将[NAME].html重命名为TEST.html，我们将覆盖现有的TEST.html。我们的结果目录的结构如下：

潜在的结果目录结构。

.
└── TEST
    ├── TEST.controller.js
    └── TEST.html

仅通过重命名资产，如果尚未采用新的结果路径，我们避免了丢失数据的潜在有害情况。

实际结果目录结构。

.
└── TEST
    ├── TEST.controller.js
    ├── [NAME].html
    └── TEST.html

当不应重命名资产（因为这将导致数据丢失）时，脚本当前报告了这些实例。给定初始目录结构（上）将记录到您的控制台：

1 path(s) not renamed. Name is already taken:

+ FolderName/TEST/[NAME].js --> FolderName/TEST/TEST.js

以下要点使用上述方法。该解决方案是在ES5中撰写的，因此它可以与 nodejs 的较旧版本一起使用，但是可以简单地修改使用ES6语法。

示例节点脚本1

var shell = require('shelljs');
var ROOT_DIR = './FolderName/'; // <-- Directory to search in relative to cwd.
var FIND_STR = '[NAME]';        // <-- String to find
var REPLACE_STR = 'TEST';       // <-- Replacement string
var issues = [];
// 1. Obtain all paths in the root directory.
shell.find(ROOT_DIR)
  // 2. Exclude:
  //    - hidden files/folders (i.e. assets names starting with a dot)
  //    - Assets (i.e. at the end of the path) that do not contain `FIND_STR`
  .filter(function(_path) {
    var isVisible = _path.split('/').pop().indexOf('.', 0) !== 0,
      assetHasFindStr = _path.split('/').pop().indexOf(FIND_STR) > -1;
    return (assetHasFindStr && isVisible);
  })
  // 3. Sort paths by its depth in descending order.
  .sort(function(a, b) {
    return (b.split('/') || []).length - (a.split('/') || []).length;
  })
  // 4. Replace last instance of string to find with replace string and rename.
  .forEach(function (_path) {
    var firstPart = _path.substring(0, _path.lastIndexOf(FIND_STR)),
      lastPart = _path.substring(_path.lastIndexOf(FIND_STR, _path.length)),
      newPath = firstPart + lastPart.replace(FIND_STR, REPLACE_STR);
    // Only rename if `newPath` is not already taken otherwise log them.
    if (!shell.test('-e', newPath)) {
      shell.mv(_path, newPath);
    } else {
      issues.push(_path + ' --> ' + newPath);
    }
  });
// 5. Log any paths that were not renamed because its name is already taken.
if (issues.length) {
  shell.echo(issues.length + ' path(s) not renamed. Name is already taken:');
  issues.forEach(function(issue) {
    shell.echo('+ ' + issue);
  });
}

---

解决方案B

也可以通过安装和使用Renamer来实现您的要求。

$ npm i -D renamer

然后使用shelljs调用 renamer命令。

---

示例节点脚本2

const shell = require("shelljs");
shell.exec('node_modules/.bin/renamer --find "[NAME]" --replace "TEST" "FolderName/**"', { silent:true });

---

示例节点脚本3

如果您需要一些 little 更多Terse，（尽管它会产生额外的依赖性），则可以使用Shelljs-Nodecli：

$ npm i -D shelljs-nodecli

然后调用renamer命令，如下所示：

const nodeCLI = require("shelljs-nodecli");
nodeCLI.exec('renamer', '--find "[NAME]" --replace "TEST" "FolderName/**"', { silent:true });

注意，使用shelljs-nodecli，您避免手动查看node_modules目录以查找二进制renamer文件。即。

shell.exec('node_modules/.bin/renamer ...

变成...

nodeCLI.exec('renamer' ...