用中文描述,生成规范英文变量名,这款 CLI 工具太懂我了!

126 阅读1分钟

变量命名是程序员最头疼的事之一。

  • 写个“用户头像地址”,脑海里蹦出十种英文写法
  • 命名太长?太短?团队缺少规范?

于是我搞了个小工具,叫 smart-naming


什么是 smart-naming?

smart-naming 是一个命令行插件,支持根据中文描述智能生成符合命名规范的英文变量名,并支持多种命名风格:

nmx 用户头像地址

输出:

大驼峰: UserAvatarAddress
小驼峰: userAvatarAddress
破折号: user-avatar-address
下划线: user_avatar_address

配置功能一览

1. 设置单个单词最大长度

nmx --setMaxWordLength 5

示例输入:

nmx 用户信息管理

原输出:

UserInformationManagement

限制后输出:

UserInforManag

2. 设置最多包含的单词数量

nmx --setMaxWord 3

示例输入:

nmx 用户头像地址上传路径

限制后输出:

UserAvatarPath

3. 清空配置,恢复默认

nmx --removeSet

输出:

✅ 配置已清空,当前使用默认设置。

4. 查看配置

nmx --view

输出:

单个单词最大长度 ∞
最大单词数量 ∞
(∞代表目前无限制)

安装方式

npm install -g smart-naming

然后直接使用:

nmx 中文描述

使用场景推荐

  • 快速生成变量名、字段名、函数名

🔗 项目地址

👉 GitHub 地址:
github.com/EricBoum/sm…

欢迎 Star、试用、提建议,一起打磨这个工具