在前端开发中，经常需要对文件名进行批量修改。npm包 rename-fn 就是一个方便的工具，它可以帮助我们快速地重命名文件名。本文将详细介绍 rename-fn 的使用方法，包括安装、基本用法和高级用法。
1. 安装
使用 npm 安装 rename-fn：
npm install rename-fn --save-dev
2. 基本用法
首先，我们需要引入 rename-fn 模块：
const renameFn = require('rename-fn');接下来，我们可以使用 renameFn() 方法来重命名文件，该方法有两个参数：源文件名称和目标文件名称。以下是使用 renameFn() 方法修改文件名的示例代码：
const fs = require('fs');
const renameFn = require('rename-fn');
fs.readdirSync('path/to/files').forEach(file => {
const oldPath = `path/to/files/${file}`;
const newPath = `path/to/files/${renameFn(file, { append: '-new' })}`;
fs.renameSync(oldPath, newPath);
});在上面的示例中，我们使用了 fs.readdirSync() 方法列出了 path/to/files 目录下的所有文件名。接着，我们使用 renameFn() 方法给每个文件名添加了一个后缀 '-new' ，然后使用 fs.renameSync() 方法将旧文件名改为新文件名。这样，我们便完成了文件名的批量修改。
3. 高级用法
除了基本用法，rename-fn 还支持一些高级用法，例如：过滤、替换和排序。
3.1 过滤
rename-fn 可以使用 include 和 exclude 选项来过滤文件名。include 选项指定的字符串会被保留，而不包含该字符串的文件名会被过滤掉；而 exclude 选项指定的字符串会被过滤掉，而包含该字符串的文件名会被保留。
以下是使用 include 和 exclude 选项的示例代码：
-- -------------------- ---- -------
----- -- - --------------
----- -------- - ---------------------
-------------------------------------------- -- -
-- ----------------------- -
----- ------- - ------------------------
----- ------- - ------------------------------- - -------- -------- -------- ------- -----
---------------------- ---------
-
---在上面的示例中，我们首先使用 file.endsWith() 方法过滤出所有以 '.jpg' 结尾的文件名。然后，我们使用 renameFn() 方法，将包含 'photo' 字符串而不包含 'small' 字符串的文件名重命名。
3.2 替换
rename-fn 还支持使用正则表达式替换文件名。我们可以使用 replace 选项来指定一个正则表达式和一个用于替换匹配结果的字符串。replace 选项的取值为一个对象，其属性包括：pattern 正则表达式和 replacement 字符串。
以下是使用 replace 选项的示例代码：
const fs = require('fs');
const renameFn = require('rename-fn');
fs.readdirSync('path/to/files').forEach(file => {
const oldPath = `path/to/files/${file}`;
const newPath = `path/to/files/${renameFn(file, { replace: { pattern: /_/g, replacement: '-' } })}`;
fs.renameSync(oldPath, newPath);
});在上面的示例中，我们使用了 replace 选项，将所有下划线 '_' 替换成连字符 '-'。
3.3 排序
rename-fn 还支持使用 sort 选项对文件名进行排序。sort 选项的取值为一个函数，该函数接受两个参数，分别为前一个文件名和后一个文件名。该函数应返回负数、0 或正数，表示前一个文件名应排在后一个文件名之前、相同、之后。
以下是使用 sort 选项的示例代码：
const fs = require('fs');
const renameFn = require('rename-fn');
fs.readdirSync('path/to/files').sort(renameFn({ sort: (a, b) => a.localeCompare(b) })).forEach(file => {
const oldPath = `path/to/files/${file}`;
const newPath = `path/to/files/${renameFn(file, { append: '-new' })}`;
fs.renameSync(oldPath, newPath);
});在上面的示例中，我们使用了 sort 选项，将文件名按字母顺序排序。
4. 总结
在本文中，我们介绍了 npm 包 rename-fn 的基本用法和高级用法，学习了如何使用 include、exclude、replace 和 sort 选项来进行文件名的批量修改。希望本文对广大开发者有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f388d47dbf7be33b2566f6e