基于正则表达式递归重命名文件和文件夹

时间:2017-09-13 14:26:07

标签: node.js regex shelljs

我有这个文件结构:

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

使用Node.js我想用变量替换[NAME]。

以下是我尝试的内容:

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

1 个答案:

答案 0 :(得分:0)

问题

在示例的上下文中运行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

解决方案A

为避免错误,请尝试以下方法:

  1. 利用shelljs find命令获取路径,而不是ls。这将确保生成的路径包括基目录。
  2. 迭代每个路径并filter出任何资产不包含要查找的字符串的路径(例如[NAME]。还要排除任何隐藏的资源(即以点.开头的名称)
  3. 按照深度降序排列路径数组。
  4. 仅替换要在每个路径中使用替换字符串(例如[NAME])查找的字符串的最后一个实例(例如TEST)。然后最后使用shelljs mv命令应用新路径。
  5. 注意:作为安全措施(步骤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 更简洁,(虽然它会产生额外的依赖性),您可以使用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' ...