JSPM

dish-files-rename-cli

1.1.0
    • ESM via JSPM
    • ES Module Entrypoint
    • Export Map
    • Keywords
    • License
    • Repository URL
    • TypeScript Types
    • README
    • Created
    • Published
    • Downloads 4
    • Score
      100M100P100Q32086F
    • License MIT

    文件批量重命名工具

    Package Exports

    • dish-files-rename-cli
    • dish-files-rename-cli/dist/index.js

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (dish-files-rename-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    files-renamer

    一个强大的文件批量重命名工具,支持多种命名格式的转换。

    功能特点

    • 支持多种常见命名格式之间的转换
    • 可以递归处理子目录下的文件
    • 支持添加文件名前缀
    • 提供试运行模式,可以预览重命名效果
    • 自动跳过已存在的同名文件
    • 自动更新文件中的 import 语句引用
      • 支持更新 .ts 和 .js 文件中的 import 语句
      • 处理普通导入、类型导入、动态导入和 require 语句
      • 智能处理相对路径和索引文件
      • 提供详细的更新统计信息
    • 支持保留词功能
      • 可指定某些词（如"AI"、"API"等）作为不可分割的单词
      • 防止像"OpenAI"这样的名称被错误地分割为"Open-A-I"
      • 提供保留词列表管理界面，可添加、删除、编辑和重置
      • 保留词列表会被持久化存储，便于下次使用
    • 内置文件排除功能
      • 自动排除常见配置文件和系统文件
      • 包含完整的通用配置文件库，如.gitignore、.npmrc、.eslintrc.json等
      • 按类别组织排除列表，包括版本控制、包管理、代码质量、构建配置等
      • 智能识别并跳过位于被排除目录中的文件

    支持的命名格式

    • snake: 下划线分隔,全小写 (例如: two_words)
    • screaming_snake: 下划线分隔,全大写 (例如: TWO_WORDS)
    • camel: 驼峰式,首字母小写 (例如: twoWords)
    • pascal: 驼峰式,首字母大写 (例如: TwoWords)
    • kebab: 短横线分隔,全小写 (例如: two-words)
    • dot: 点号分隔,全小写 (例如: two.words)
    • capital: 空格分隔,单词首字母大写 (例如: Two Words)
    • constant: 下划线分隔,全大写 (例如: TWO_WORDS)
    • no: 空格分隔,全小写 (例如: two words)
    • pascal_snake: 下划线分隔,单词首字母大写 (例如: Two_Words)
    • path: 斜杠分隔,全小写 (例如: two/words)
    • sentence: 空格分隔,句子首字母大写 (例如: Two words)
    • train: 短横线分隔,单词首字母大写 (例如: Two-Words)

    安装

    使用 npm 全局安装

    npm install -g files-renamer

    本地开发

    1. 克隆项目代码
    git clone https://github.com/yourusername/files-renamer.git
cd files-renamer
    1. 安装依赖
    npm install
    1. 构建项目
    npm run build
    1. 链接到全局
    npm link

    开发调试

    方式一: 使用 ts-node 直接运行

    npm run dev

    这会启动开发模式,代码变更时自动重启程序。

    方式二: 使用 VSCode 调试

    1. 打开项目文件夹
    2. 按 F5 启动调试
    3. 可以设置断点、单步调试、查看变量等

    方式三: 全局链接调试

    npm run build  # 先构建
npm link  # 全局链接
rename-files  # 运行命令测试

    执行 npm link 后,可以在任意目录下使用 rename-files 命令来测试。

    使用说明

    在需要重命名文件的目录下运行:

    rename-files

    然后根据提示进行操作:

    1. 选择源文件的命名格式
    2. 选择目标命名格式
    3. 确认是否递归处理子目录
    4. 输入文件名前缀(可选)
    5. 选择是否使用试运行模式
    6. 选择是否更新文件中的 import 语句引用
    7. 选择是否尊重 .gitignore 等排除规则
    8. 选择是否管理保留词列表

    所有选项都可以通过方向键选择或直接输入。

    保留词列表管理

    如果选择管理保留词列表，你可以：

    • 查看当前的保留词列表
    • 添加新的保留词（多个词用逗号分隔）
    • 删除已有的保留词
    • 使用编辑器编辑整个列表
    • 重置为默认列表

    保留词列表会被保存在 .renamer-preserved-words.json 文件中，以便在下次使用时加载。默认的保留词列表包含常见的缩写词和专有名词如"AI"、"API"、"REST"、"UI"等。

    命令行参数

    除了交互式界面，你也可以使用命令行参数来指定选项：

    rename-files -t snake -r -u

    支持的参数:

    • -t, --to <case>: 目标命名格式
    • -r, --recursive: 递归处理子目录
    • -p, --prefix <prefix>: 添加文件名前缀
    • -d, --dry-run: 试运行模式
    • -e, --respect-excludes: 尊重 .gitignore 等排除规则
    • -u, --update-imports: 更新文件中的 import 语句引用