@yaohaixiao/renames.js 0.0.1

package/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

package/.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx commitlint --edit

package/.husky/pre-commit

@@ -0,0 +1,3 @@
+#!/usr/bin/env husky
+
+npx lint-staged

package/.prettierignore

@@ -0,0 +1,28 @@
+# dependencies
+**/node_modules
+
+# production
+/dist
+/docs
+/.vscode
+/report
+/tests
+
+# misc
+npm-debug.log*
+
+/coverage
+.idea
+package-lock.json
+
+# visual studio code
+.history
+*.log
+functions/*
+.temp/**
+
+# screenshot
+screenshot
+.firebase
+
+.husky

package/.prettierrc.js

@@ -0,0 +1,41 @@
+/**
+ * # .prettierrc.js - prettier 配置文件
+ *
+ * Created By: Yaohaixiao Update: 2026.1.10
+ */
+export default {
+  // 单行长度
+  printWidth: 80,
+  // 缩进长度
+  tabWidth: 2,
+  // 使用空格代替tab缩进
+  useTabs: false,
+  // 句末使用分号
+  semi: false,
+  // 使用单引号
+  singleQuote: true,
+  // 仅在必需时为对象的key添加引号
+  quoteProps: 'as-needed',
+  // 多行时尽可能打印尾随逗号
+  trailingComma: 'none',
+  // 在对象前后添加空格 eg: { foo: bar }
+  bracketSpacing: true,
+  // 单参数箭头函数参数周围使用圆括号 eg: (x) => x
+  arrowParens: 'always',
+  // 无需顶部注释即可格式化
+  requirePragma: false,
+  // 在已被 preitter 格式化的文件顶部加上标注
+  insertPragma: false,
+  //
+  proseWrap: 'always',
+  // 对HTML全局空白不敏感
+  htmlWhitespaceSensitivity: 'ignore',
+  // 不对vue中的script及style标签缩进
+  vueIndentScriptAndStyle: false,
+  // 结束行形式
+  endOfLine: 'auto',
+  bracketSameLine: true,
+  singleAttributePerLine: true,
+  // 对引用代码进行格式化
+  embeddedLanguageFormatting: 'auto',
+};

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Robert Yao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,239 @@
+# renames.js
+
+renames.js - 基于 Node 的批量文件名重命名 cli 工具库。
+
+## Features
+
+- 方便快捷，配置灵活；
+- 支持指定文件名列表数据或者文件名列表文件；
+- 支持文件名自动生成索引；
+- 支持文件名自定义过滤；
+- 支持文件名自定义排序；
+- 支持文件名自定义格式化；
+
+## Usage
+
+renames.js 使用方式如下：
+
+```bash
+renames [arguments|command] [options]
+```
+
+renames.js 和其它 cli 工具一样，也可以通过 -h 选项获取完整帮助信息，命令如下：
+
+```bash
+renames -h
+```
+
+renames.js 提供目前提供一个 arguments（dir-path）参数和一个 command（init）子命令，以及10多个 options 配置信息。
+
+### Arguments:
+
+- dir-path - 可选，目标文件夹（绝对或相对）路径，如不设置，则使用 renames.config.js 中的 dirPath。
+
+使用 dir-path 参数的命令如下：
+
+```bash
+renames C:\Downloads --autoIndex only
+```
+
+当然，我们可以指定更多的 options 配置选项指定具体的文件重命名的操作细节信息。
+
+### Options
+
+renames.js 提供了较为丰富的 options 参数，用以控制重命名的操作细节处理方式：
+
+| 参数名                           | 参数说明                                                                                                        |
+| -------------------------------- | --------------------------------------------------------------------------------------------------------------- |
+| -h, --help                       | display help for command                                                                                        |
+| --dir, --dirPath <dirPath>       | 可选，目标文件夹（绝对或相对）路径（注意：仅 init 命令支持）                                                    |
+| --names, --namesList <namesList> | 可选，文件名列表数组数据，例如："新的开始,完美结局"。或者文件名列表文件的路径，例如："C:\Downloads\names.txt"。 |
+| --prefix <prefix>                | 可选，文件名的前缀字符串，例如："动画片-第01话：新的开始-1080p.mp4"中的"动画片"                                 |
+| --suffix <suffix>                | 可选，文件名的后缀字符串，例如："动画片-第01话：新的开始-1080p.mp4"中的"1080p"                                  |
+| --connector <connector>          | 可选，文件名的前/后缀字符串间的连接字符串，例如："动画片-第01话：新的开始-1080p.mp4"中的"-"                     |
+| --autoIndex [enable]             | 可选，是否自动生成索引编号（default：false）                                                                    |
+| --startIndex <startIndex>        | 可选，索引编号起始值（default：0）                                                                              |
+| --indexPadZero [enable]          | 可选，是否自动用"0"填充索引编号（default：true）                                                                |
+| --indexPrefix <indexPrefix>      | 可选，索引编号的前缀字符串，例如："第01话：新的开始.mp4"中的"第" (default: "第")                                |
+| --indexSuffix <indexSuffix>      | 可选，索引编号的后缀字符串，例如："第01话：新的开始.mp4"中的"话" (default: "集")                                |
+| --delimiter <delimiter>          | 可选，索引编号和的前/后缀字符串间的连接符，例如："第01话：新的开始.mp4"中的"：" (default: "：")                 |
+| -f, --force [enable]             | 可选，是否强制重命名（default：false）                                                                          |
+| --ext, --extname <extname>       | 可选，重命名后的扩展名，例如：".txt"                                                                            |
+| --sort, --sortBy <sortBy>        | 可选，排序类型，可选项：name、type、size、birthtime 和 modify-time (default: "name")                            |
+| --order <order>                  | 可选，排序方式，可选项：desc 和 asc (default: "asc")                                                            |
+| --sensitivity <sensitivity>      | 可选，排序方式为 name 时，大小写/重音处理的方式，可选项：base、accent、case 和 variant (default: "base")        |
+
+例如希望将 C:\Downloads 目录下的文件批量重命名为数字索引的信息，可以输入以下命令：
+
+```bash
+renames C:\Downloads --autoIndex only
+```
+
+### Command
+
+renames.js 目前仅提供了一个 init 子命令。
+
+#### init 子命令
+
+init 子命令是用来创建名为 renames.config.js 配置文件的，命令如下：
+
+```bash
+renames init
+```
+
+输入以上命令，renames.js 会提示输入 dirPath 和 namesList 两个重要的配置参数。
+
+#### 获取 init 子命令的帮助信息
+
+当然，renames.js 也可以直接在 init 命令后添加各种不同的 options 参数。查看完整的 options 参数信息的命令如下：
+
+```bash
+renames init -h
+```
+
+#### init 命令传递 options 配置参数
+
+以下展示通过传递 options 参数中的 dirPath 和 namesList 信息生成配置文件的方法，命令如下：
+
+```bash
+renames init --dir C:\Downloads --names C:\Downloads\names.txt
+```
+
+以上命令的功能是将 C:\Downloads 文件夹下的文件名，已 names.txt 文件中的文件列表数据进行重命名。
+
+## renames.config.js 配置文件
+
+通过 init 命令生成 renames.config.js 文件的内容如下：
+
+```js
+export default {
+  dirPath: 'C:\\Downloads',
+  namesList: 'C:\\Downloads\\names.txt',
+  prefix: '',
+  suffix: '',
+  connector: '',
+  autoIndex: false,
+  startIndex: 0,
+  indexPadZero: true,
+  indexPrefix: '第',
+  indexSuffix: '集',
+  delimiter: '：',
+  force: false,
+  extname: '',
+  // 指定过滤 dirPath 文件夹中的文件过滤方法
+  filter: null,
+  // 可以是排序方式的名称（可选项：name、type、size、birthtime 和 modify-time），也可以是具体的处理函数
+  sortBy: 'name',
+  order: 'desc',
+  sensitivity: 'base',
+  // 指定对最终文件名字的格式化处理函数
+  format: null,
+};
+```
+
+除了输出以上的配置文件内容，工具还会采用蓝色的链接文字显示 renames.config.js 的文件路径。（Windows 环境）可以按 Ctrl 键点并用鼠标击链接文本打开文件进行编辑。
+
+### 特殊配置
+
+renames.js 处理 options 参数中的配置信息外，在 renames.config.js 配置文件中，还额外提供了3个特殊的配置：
+
+- filter - 过滤文件处理函数
+- sortBy - 排序方式，可以是排序的名称或者具体的处理函数
+- format - 文件名字的格式化处理函数
+
+#### filter
+
+filter 参数可以用来过滤 dirPath 文件夹中的文件，例如 C:\Downloads 中的文件如下：
+
+- tinified.zip
+- 83665500d425db4a902c3d4d36f5181e24380200.jpg
+- 77665500d425db4a902c3d4d36f5181e24380200.jpg
+- names.txt
+
+我们希望过滤文件列表中的 .jpg 图片文件，配置如下：
+
+```js
+// renames.js 内部提供的功能函数
+import getExtension from '@yaohaixiao/renames.js/lib/utils/get-extension';
+
+export default {
+  dirPath: 'C:\\Downloads',
+  // ...省略其它默认参数
+  // 指定过滤 dirPath 文件夹中的文件过滤方法
+  filter: (files) => {
+    // files 为 dirPath 下所有文件的数组数据
+    return files.filter((filename) => {
+      // getExtension 函数用以获取文件名中的扩展名
+      return getExtension(filename) === '.jpg';
+    });
+  },
+};
+```
+
+#### sortBy
+
+sortBy 参数可以给文件夹中的文件进行排序，例如 C:\Downloads 中的文件如下：
+
+- tinified.zip
+- 83665500d425db4a902c3d4d36f5181e24380200.jpg
+- 77665500d425db4a902c3d4d36f5181e24380200.jpg
+- names.txt
+
+我们希望通过文件大小进行排序，配置如下：
+
+```js
+export default {
+  dirPath: 'C:\\Downloads',
+  // ...省略其它默认参数
+  sortBy: 'size',
+};
+```
+
+如果你希望的排序方式不在 name、type、size、birthtime 和 modify-time 这几种内置方式中，例如我们希望按文件名首字符 Unicode 编码值进行升序排序，配置如下：
+
+```js
+// renames.js 内部提供的功能函数
+import getBasename from '@yaohaixiao/renames.js/lib/utils/get-basename';
+
+export default {
+  dirPath: 'C:\\Downloads',
+  // ...省略其它默认参数
+  sortBy: (files) => {
+    return files.sorted((prev, next) => {
+      const prevBasename = getBasename(prev);
+      const nextBasename = getBasename(next);
+
+      return prevBasename.charCodeAt(0) - nextBasename.charCodeAt(0);
+    });
+  },
+};
+```
+
+#### format
+
+format 参数可以对文件夹中的文件进行格式化，例如 C:\Downloads 中的文件如下：
+
+- 01-start.mp4
+- 02-龙珠-神秘的龙珠出现！.mp4
+- 03-DRAGON_BOLL-FINAL_FIGHT.mkv
+- 05-悟空变成了小孩.mov
+
+我们希望通过文件名的索引信息重命名，配置如下：
+
+```js
+// renames.js 内部提供的功能函数
+import stripNonDigit from '@yaohaixiao/renames.js/lib/utils/strip-non-digit';
+
+export default {
+  dirPath: 'C:\\Downloads',
+  // ...省略其它默认参数
+  format: (basename) => {
+    return stripNonDigit(basename);
+  },
+};
+```
+
+## License
+
+Licensed under
+[MIT License](http://opensource.org/licenses/mit-license.html).