@yaohaixiao/renames.js 0.0.1

package/bin/renames.js

@@ -0,0 +1,415 @@
+#!/usr/bin/env node
+
+import path from 'node:path';
+import { execSync } from 'node:child_process';
+import { fileURLToPath } from 'node:url';
+import { program } from 'commander';
+import chalk from 'chalk';
+import { select, input } from '@inquirer/prompts';
+
+import createConfig from '../lib/create-config.js';
+import isFileExists from '../lib/utils/is-file-exists.js';
+import isEmptyObject from '../lib/utils/is-empty-object.js';
+import readFile from '../lib/utils/read-file.js';
+import renames from '../index.js';
+import showWarningLog from '../lib/utils/show-warning-log.js';
+import terminalLink from '../lib/utils/terminal-link.js';
+
+const { resolve, dirname } = path;
+const currentFilePath = dirname(fileURLToPath(import.meta.url));
+const pkg = JSON.parse(readFile(resolve(currentFilePath, '../package.json')));
+const { version, author, description } = pkg;
+
+// 配置文件相关常量
+const CONFIG_FILE_NAME = 'renames.config.js';
+const DEMO_DIR_PATH = String.raw`C:\Downloads\Videos`;
+const DEMO_LIST_PATH = String.raw`C:\Downloads\names.txt`;
+const DEMO_LIST_DATA = '新的开始,完美结局';
+const DEMO_PREFIX = '动画片';
+const DEMO_SUFFIX = '1080p';
+const DEMO_CONNECTOR = '-';
+const DEMO_BASENAME = '第01话：新的开始';
+const DEMO_FILE_NAME = `${DEMO_BASENAME}.mp4`;
+const DEMO_FULL_FILE_NAME = `${DEMO_PREFIX}${DEMO_CONNECTOR}${DEMO_BASENAME}${DEMO_CONNECTOR}${DEMO_SUFFIX}.mp4`;
+const DEFAULT_SORT = 'name';
+const DEFAULT_ORDER = 'asc';
+const DEFAULT_SENSITIVITY = 'base';
+const DEFAULT_INDEX_PREFIX = '第';
+const DEFAULT_INDEX_SUFFIX = '集';
+const DEFAULT_DELIMITER = '：';
+const DEFAULT_START_INDEX = 0;
+
+// 配置文件路径
+const CONFIG_PATH = resolve(currentFilePath, `../${CONFIG_FILE_NAME}`);
+const CONFIG_PATH_URL = `file://${CONFIG_PATH}`;
+const DEFAULT_CONFIG_PATH = resolve(
+  currentFilePath,
+  '../config/default.config.json',
+);
+
+/**
+ * # 辅助函数：解析布尔型 CLI 参数
+ *
+ * @function parseBooleanOption
+ * @param {string} enable - 输入的参数值
+ * @param {boolean} defaultValue - 默认值
+ * @returns {boolean} 解析后的布尔值
+ */
+const parseBooleanOption = (enable, defaultValue = false) => {
+  switch (enable) {
+    case '1':
+    case 'true': {
+      return true;
+    }
+    case '0':
+    case 'false': {
+      return false;
+    }
+    default: {
+      return defaultValue;
+    }
+  }
+};
+
+/**
+ * # 辅助函数：解析数值型 CLI 参数
+ *
+ * @function parseNumberOption
+ * @param {string} value - 输入的参数值
+ * @param {number} defaultValue - 默认值
+ * @param {string} paramName - 参数名（用于错误提示）
+ * @returns {number} 解析后的数值
+ */
+const parseNumberOption = (
+  value,
+  defaultValue = DEFAULT_START_INDEX,
+  paramName = '--startIndex',
+) => {
+  const numValue = Number(value);
+  if (Number.isNaN(numValue)) {
+    showWarningLog(
+      '警告',
+      `${value} 为无效数字`,
+      `${paramName} 必须传入合法数值，将使用默认值"${defaultValue}"。`,
+    );
+    return defaultValue;
+  }
+  return numValue;
+};
+
+/**
+ * # 辅助函数：获取通用的 CLI 选项配置
+ *
+ * @function getCommonOptions
+ * @returns {Array} 选项配置数组
+ */
+const getCommonOptions = () => [
+  {
+    flags: '--names, --namesList <namesList>',
+    description: `可选，文件名列表数组数据，例如："${DEMO_LIST_DATA}"。或者文件名列表文件的路径，例如："${DEMO_LIST_PATH}"。`,
+  },
+  {
+    flags: '--prefix <prefix>',
+    description: `可选，文件名的前缀字符串，例如："${DEMO_FULL_FILE_NAME}"中的"${DEMO_PREFIX}"`,
+  },
+  {
+    flags: '--suffix <suffix>',
+    description: `可选，文件名的后缀字符串，例如："${DEMO_FULL_FILE_NAME}"中的"${DEMO_SUFFIX}"`,
+  },
+  {
+    flags: '--connector <connector>',
+    description: `可选，文件名的前/后缀字符串间的连接字符串，例如："${DEMO_FULL_FILE_NAME}"中的"${DEMO_CONNECTOR}"`,
+  },
+  {
+    flags: '--autoIndex [enable]',
+    description: '可选，是否自动生成索引编号（default：false）',
+    parser: (enable) => parseBooleanOption(enable, false),
+  },
+  {
+    flags: '--startIndex <startIndex>',
+    description: `可选，索引编号起始值（default：${DEFAULT_START_INDEX}）`,
+    parser: (index) => parseNumberOption(index, DEFAULT_START_INDEX),
+  },
+  {
+    flags: '--indexPadZero [enable]',
+    description: '可选，是否自动用"0"填充索引编号（default：true）',
+    parser: (enable) => parseBooleanOption(enable, true),
+  },
+  {
+    flags: '--indexPrefix <indexPrefix>',
+    description: `可选，索引编号的前缀字符串，例如："${DEMO_FILE_NAME}"中的"第"`,
+    defaultValue: DEFAULT_INDEX_PREFIX,
+  },
+  {
+    flags: '--indexSuffix <indexSuffix>',
+    description: `可选，索引编号的后缀字符串，例如："${DEMO_FILE_NAME}"中的"话"`,
+    defaultValue: DEFAULT_INDEX_SUFFIX,
+  },
+  {
+    flags: '--delimiter <delimiter>',
+    description: `可选，索引编号和的前/后缀字符串间的连接符，例如："${DEMO_FILE_NAME}"中的"："`,
+    defaultValue: DEFAULT_DELIMITER,
+  },
+  {
+    flags: '-f, --force [enable]',
+    description: '可选，是否强制重命名（default：false）',
+    parser: (enable) => parseBooleanOption(enable, false),
+  },
+  {
+    flags: '--ext, --extname <extname>',
+    description: '可选，重命名后的扩展名，例如：".txt"',
+  },
+  {
+    flags: '--sort, --sortBy <sortBy>',
+    description:
+      '可选，排序类型，可选项：name、type、size、birthtime 和 modify-time',
+    defaultValue: DEFAULT_SORT,
+  },
+  {
+    flags: '--order <order>',
+    description: '可选，排序方式，可选项：desc 和 asc',
+    defaultValue: DEFAULT_ORDER,
+  },
+  {
+    flags: '--sensitivity <sensitivity>',
+    description:
+      '可选，排序方式为 name 时，大小写/重音处理的方式，可选项：base、accent、case 和 variant',
+    defaultValue: DEFAULT_SENSITIVITY,
+  },
+];
+
+/**
+ * # 辅助函数：为 Commander 实例添加通用选项
+ *
+ * @function addCommonOptions
+ * @param {object} commanderInstance - Commander 实例
+ */
+const addCommonOptions = (commanderInstance) => {
+  const commonOptions = getCommonOptions();
+
+  for (const option of commonOptions) {
+    if (option.parser) {
+      commanderInstance.option(
+        option.flags,
+        option.description,
+        option.parser,
+        option.defaultValue,
+      );
+    } else if (option.defaultValue) {
+      commanderInstance.option(
+        option.flags,
+        option.description,
+        option.defaultValue,
+      );
+    } else {
+      commanderInstance.option(option.flags, option.description);
+    }
+  }
+};
+
+/**
+ * # 辅助函数：处理文件名列表参数
+ *
+ * @function processNameList
+ * @param {string} nameList - 输入的文件名列表（路径或逗号分隔字符串）
+ * @returns {Array | string} 解析后的数组或原路径
+ */
+const processNameList = (nameList) => {
+  if (!nameList) return '';
+
+  // 如果不是文件路径，解析为数组
+  if (!isFileExists(nameList)) {
+    return nameList.split(',').map((item) => item.trim());
+  }
+
+  return nameList;
+};
+
+/**
+ * # 辅助函数：获取最终的文件夹路径
+ *
+ * @function getFinalDirPath
+ * @param {string} dirPath - 命令行传入的路径
+ * @param {object} defaults - 默认配置
+ * @returns {Promise<string>} 最终的文件夹路径
+ */
+async function getFinalDirPath(dirPath, defaults) {
+  // 优先使用命令行传入的路径
+  if (dirPath) {
+    return dirPath;
+  }
+
+  // 使用默认配置中的路径
+  if (defaults?.dirPath) {
+    return defaults.dirPath;
+  }
+
+  // 交互式获取路径
+  return await input({
+    message: chalk.greenBright(
+      `请输入需要执行重命名操作的文件夹路径（例如："${DEMO_DIR_PATH}"）：`,
+    ),
+  });
+}
+
+/**
+ * # 辅助函数：执行帮助命令
+ *
+ * @function executeHelpCommand
+ */
+const executeHelpCommand = () => {
+  execSync('renames -h', {
+    encoding: 'utf8',
+    stdio: 'inherit',
+  });
+};
+
+/**
+ * # 辅助函数：执行初始化命令
+ *
+ * @function executeInitCommand
+ */
+const executeInitCommand = () => {
+  execSync('renames init -h', {
+    encoding: 'utf8',
+    stdio: 'inherit',
+  });
+};
+
+// 配置主程序
+const mainCommander = program
+  .name('renames')
+  .description(description)
+  .version(`renames.js [version：${version}]\n(C) ${author}，保留所有权利。`)
+  .usage('[arguments|command] [options]');
+
+// 主程序添加通用选项
+addCommonOptions(mainCommander);
+
+// 主命令逻辑
+mainCommander
+  .argument(
+    '[dir-path]',
+    `可选，目标文件夹（绝对或相对）路径，如不设置，则使用 ${CONFIG_FILE_NAME} 中的 dirPath 属性。`,
+  )
+  .action(async (dirPath, options) => {
+    let answer;
+
+    // 无配置文件且无选项时，提供交互式选择
+    if (!isFileExists(CONFIG_PATH) && isEmptyObject(options)) {
+      answer = await select({
+        message:
+          `请指定命令或参数，或者创建 ${CONFIG_FILE_NAME} 配置文件，\n` +
+          '执行命令：renames -h，将显示 renames 命令的详细帮助信息，\n' +
+          '执行命令：renames init，将创建命令配置文件，请选择后序操作？',
+        pageSize: 3,
+        choices: [
+          {
+            name: '执行命令：renames -h',
+            value: 'help',
+            description: '执行 renames -h 命令，显示帮助信息',
+          },
+          {
+            name: '执行命令：renames init 命令',
+            value: 'init',
+            description: '执行命令：renames init，创建配置文件',
+          },
+          {
+            name: '退出',
+            value: 'exit',
+            disabled: false,
+          },
+        ],
+      });
+    }
+
+    switch (answer) {
+      case 'help': {
+        executeHelpCommand();
+        break;
+      }
+      case 'init': {
+        executeInitCommand();
+        break;
+      }
+      case 'exit': {
+        console.log(chalk.green('\n已退出！'));
+        break;
+      }
+      default: {
+        // 获取配置文件内容
+        const content = readFile(DEFAULT_CONFIG_PATH, { encoding: 'utf8' });
+        const defaults = isFileExists(CONFIG_PATH)
+          ? await import(`../${CONFIG_FILE_NAME}`)
+          : JSON.parse(content);
+        const config = defaults.default || defaults;
+
+        // 获取最终的文件夹路径
+        const finalDirPath = await getFinalDirPath(dirPath, config);
+
+        // 合并配置并处理文件名列表
+        const finalOptions = { ...config, ...options };
+
+        finalOptions.namesList = processNameList(finalOptions.namesList);
+
+        if (finalDirPath) {
+          // 执行重命名
+          renames(finalDirPath, finalOptions);
+        } else if (isFileExists(CONFIG_PATH)) {
+          // 提示修改配置文件中的 dirPath
+          showWarningLog(
+            '警告',
+            `${terminalLink(CONFIG_PATH, CONFIG_PATH_URL)}`,
+            '已生成，可配置 dirPath 属性后再执行 renames 命令。',
+          );
+        } else {
+          showWarningLog(
+            '警告',
+            '执行重命名操作的文件夹路径',
+            '未接受到任何信息，已退出程序。',
+          );
+        }
+        break;
+      }
+    }
+  });
+
+// 配置 init 命令
+const initCommand = program
+  .command('init')
+  .description(`用以生成"${CONFIG_FILE_NAME}"配置文件`);
+
+// init 命令添加 dirPath 选项
+initCommand.option(
+  '--dir, --dirPath <dirPath>',
+  `可选，目标文件夹（绝对或相对）路径，例如：${DEMO_DIR_PATH}`,
+);
+
+// init 命令添加通用选项
+addCommonOptions(initCommand);
+
+// init 命令逻辑
+initCommand.action((options) => {
+  createConfig(options)
+    .then(({ isCancel }) => {
+      if (!isCancel) {
+        console.log(
+          chalk.green(
+            `\n配置文件 ${terminalLink(CONFIG_PATH, CONFIG_PATH_URL)} 已生成！`,
+          ),
+        );
+        return false;
+      }
+
+      console.log(
+        chalk.yellowBright(
+          `\n已取消重写 ${terminalLink(CONFIG_PATH, CONFIG_PATH_URL)} 配置文件！`,
+        ),
+      );
+    })
+    .catch((error) => {
+      console.log(chalk.red(`生成配置文件失败：${error.message}`));
+    });
+});
+
+program.parse(process.argv);

package/commitlint.config.js

@@ -0,0 +1,42 @@
+/**
+ * Commitlint.config.js - git commit 校验配置
+ *
+ * Commit 类型： build：主要目的是修改项目构建系统(例如 glup，webpack，rollup 的配置等)的提交
+ * ci：主要目的是修改项目继续集成流程(例如 Travis，Jenkins，GitLab CI，Circle等)的提交 docs：文档更新
+ * feat：新增功能 fix：bug 修复 pref：性能优化 refactor：重构代码(既没有新增功能，也没有修复 bug)
+ * style：不影响程序逻辑的代码修改(修改空白字符，补全缺失的分号等) test：新增测试用例或是更新现有测试 revert：回滚某个更早之前的提交
+ * chore：不属于以上类型的其他类型(日常事务)
+ *
+ * @see https://github.com/conventional-changelog/commitlint
+ * @see https://typicode.github.io/husky/#/?id=uninstall
+ *
+ * Created By: Yaohaixiao
+ * Update: 2026.1.10
+ */
+const TYPES = [
+  'build',
+  'ci',
+  'chore',
+  'docs',
+  'feat',
+  'fix',
+  'pref',
+  'refactor',
+  'revert',
+  'style',
+  'test',
+];
+
+export default {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'type-enum': [2, 'always', TYPES],
+    'type-case': [0],
+    'type-empty': [0],
+    'scope-empty': [0],
+    'scope-case': [0],
+    'subject-full-stop': [0, 'never'],
+    'subject-case': [0, 'never'],
+    'header-max-length': [0, 'always', 72],
+  },
+};

package/config/default.config.json

@@ -0,0 +1,20 @@
+{
+  "dirPath": "",
+  "namesList": "",
+  "prefix": "",
+  "suffix": "",
+  "connector": "",
+  "autoIndex": false,
+  "startIndex": 0,
+  "indexPadZero": true,
+  "indexPrefix": "第",
+  "indexSuffix": "集",
+  "delimiter": "：",
+  "force": false,
+  "extname": "",
+  "filter": null,
+  "sortBy": "name",
+  "order": "desc",
+  "sensitivity": "base",
+  "format": null
+}

package/eslint.config.js

@@ -0,0 +1,196 @@
+/**
+ * # Eslint.config.js - eslint 配置
+ *
+ * Created By: Yaohaixiao Update: 2026.1.10
+ */
+import eslintJs from '@eslint/js';
+import { defineConfig } from 'eslint/config';
+// Added for .gitignore
+import { includeIgnoreFile } from '@eslint/compat';
+
+// Added for .gitignore path
+import { fileURLToPath } from 'node:url';
+import globals from 'globals';
+
+import eslintPluginJsdoc from 'eslint-plugin-jsdoc';
+import eslintPluginN from 'eslint-plugin-n';
+import eslintPluginUnicorn from 'eslint-plugin-unicorn';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import jestPlugin from 'eslint-plugin-jest';
+
+const gitignorePath = fileURLToPath(new URL('.gitignore', import.meta.url));
+
+export default defineConfig(
+  // 1. Handle .gitignore patterns
+  includeIgnoreFile(gitignorePath),
+
+  // 2. 忽略指定目录/文件（全局生效）
+  {
+    ignores: [
+      'node_modules/',
+      'dist/',
+      'build/',
+      'coverage/',
+      'public/',
+      'logs/',
+      '*.config.js',
+      '**/*.min.js',
+    ],
+  },
+
+  // 3. Global linter options
+  {
+    linterOptions: {
+      // Enable reporting of unused disable directives
+      reportUnusedDisableDirectives: true,
+    },
+  },
+
+  // 4. Base configurations for all relevant files
+  eslintJs.configs.recommended, // Basic ESLint recommended rules
+
+  // 5. JSDoc configuration
+  {
+    plugins: { jsdoc: eslintPluginJsdoc },
+    rules: {
+      ...eslintPluginJsdoc.configs.recommended.rules,
+      'jsdoc/require-jsdoc': 0,
+      'jsdoc/tag-lines': [2, 'any', { startLines: 1 }],
+      'jsdoc/require-param-type': 0,
+      'jsdoc/require-returns-type': 0,
+      'jsdoc/no-types': 0,
+      'jsdoc/no-defaults': 0,
+      // Was in TS override, better here
+      'jsdoc/require-returns-check': 0,
+      // 核心配置：关闭注释首字母大写约束规则
+      'jsdoc/capitalized-comments': 0,
+      // 可选：关闭关联的描述开头格式规则（若仍有报错补充配置）
+      'jsdoc/require-description-start': 0,
+      'jsdoc/reject-function-type': 0,
+    },
+    settings: {
+      jsdoc: {
+        mode: 'jsdoc',
+        tagNamePreference: { category: 'category' },
+      },
+    },
+  },
+
+  // 6. Node plugin configuration
+  {
+    plugins: { n: eslintPluginN },
+    rules: {
+      ...eslintPluginN.configs.recommended.rules,
+      'n/file-extension-in-import': [2, 'always'],
+      'n/no-missing-import': 0,
+      'n/no-unpublished-import': 0,
+    },
+  },
+
+  // 7. Unicorn plugin configuration
+  {
+    plugins: { unicorn: eslintPluginUnicorn },
+    rules: {
+      ...eslintPluginUnicorn.configs.recommended.rules,
+      'unicorn/no-null': 0,
+      'unicorn/prevent-abbreviations': 0,
+      'unicorn/prefer-code-point': 0,
+      'unicorn/no-for-loop': 0,
+      'unicorn/no-array-callback-reference': 0,
+      'unicorn/prefer-spread': 0,
+      'unicorn/no-useless-undefined': 0,
+      'unicorn/no-array-reduce': 0,
+      'unicorn/prefer-array-find': 0,
+      'unicorn/prefer-module': 0,
+      'unicorn/prefer-at': 0,
+      'unicorn/prefer-string-replace-all': 0,
+      'unicorn/prefer-switch': [2, { emptyDefaultCase: 'do-nothing-comment' }],
+    },
+  },
+
+  // 8. Jest 专属配置（核心：插件与规则在同一个配置对象内）
+  {
+    // 仅对测试文件生效，精准匹配
+    files: ['**/tests/**/*.js'],
+
+    ignores: ['node_modules/', 'dist/'],
+
+    // 1. 注册 jest 插件（必须步骤，解决「找不到 plugin jest」）
+    plugins: {
+      // 键名「jest」需与规则前缀「jest/xxx」对应
+      jest: jestPlugin,
+    },
+
+    // 2. 配置环境（导入 Jest 全局变量，顺带解决 describe 未定义）
+    languageOptions: {
+      globals: {
+        ...jestPlugin.environments.globals.globals,
+        ...globals.node,
+      },
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+    },
+
+    // 3. 启用 Jest 规则（包括 jest/expect-expect）
+    rules: {
+      // 继承 Jest 推荐规则（包含 jest/expect-expect，无需单独手动写）
+      ...jestPlugin.configs.recommended.rules,
+      // 可选：手动自定义 jest/expect-expect 规则级别（error/warn/off）
+      'jest/expect-expect': ['error', { assertFunctionNames: ['expect'] }],
+    },
+  },
+
+  // 9. Global custom rules and language options
+  {
+    languageOptions: {
+      globals: {
+        // 保留 console, process（Jest 运行在 Node 中）
+        ...globals.node,
+      },
+      parserOptions: {
+        projectService: {
+          allowDefaultProject: ['*.js'],
+        },
+      },
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+    },
+    rules: {
+      'array-callback-return': [2, { allowImplicit: true }],
+      'no-lonely-if': 2,
+      'no-proto': 2,
+      eqeqeq: [2, 'smart'],
+      'no-caller': 2,
+      'dot-notation': 2,
+      'no-var': 2,
+      'prefer-const': 2,
+      'prefer-arrow-callback': [2, { allowNamedFunctions: true }],
+      'arrow-body-style': [2, 'as-needed'],
+      'object-shorthand': 2,
+      'prefer-template': 2,
+      'one-var': [2, 'never'],
+      'prefer-destructuring': [2, { object: true }],
+      'capitalized-comments': 0,
+      'multiline-comment-style': [2, 'starred-block'],
+      'spaced-comment': 2,
+      yoda: [2, 'never'],
+      curly: [2, 'multi-line'],
+      'no-else-return': [2, { allowElseIf: false }],
+      'no-unused-expressions': 2,
+      'no-useless-call': 2,
+      'no-use-before-define': [2, 'nofunc'],
+      'no-constant-binary-expression': 2,
+      'no-void': 2,
+    },
+    settings: {
+      'import/resolver': {
+        jest: {
+          jestConfigFile: './jest.config.js',
+        },
+      },
+    },
+  },
+
+  // 10. Prettier - must be the last configuration to override styling rules
+  eslintConfigPrettier,
+);

package/index.js

@@ -0,0 +1,14 @@
+import batchRename from './lib/batch-rename.js';
+
+/**
+ * # 批量重命名（指定文件夹）文件名
+ *
+ * @function renames
+ * @param {string} dirPath - 指定的文件夹路径
+ * @param {object} [options] - 可选，指定重命名的配置参数信息
+ * @returns {boolean} - 数据异常时返回 false，数据处理完成，返回 true.
+ * @see lib/batch-rename.js
+ */
+const renames = (dirPath, options) => batchRename(dirPath, options);
+
+export default renames;