# SmartTools

**Repository Path**: ll-other/smart-tools

## Basic Information

- **Project Name**: SmartTools
- **Description**: 工具-electron构建的桌面软件
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-28
- **Last Updated**: 2025-08-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

SmartAbbrev - 智能单词缩写工具

SmartAbbrev 图标
image
（注：实际使用时请确保项目根目录存在 icon.png 图标文件）

一款专为开发者设计的轻量级桌面应用，可快速生成单词 / 短语的多种缩写形式，支持自定义快捷键和多格式输出，显著提升代码命名、变量定义等场景的效率。
一、核心功能
功能模块	具体特性
缩写生成	5 种缩写策略（首字母组合、按段截断、词典替换、辅音骨架、可读音节）
格式支持	4 种命名格式（驼峰式、帕斯卡式、下划线、连字符）
快捷操作	全局快捷键呼出 / 关闭、点击复制、自动隐藏
个性化设置	自定义快捷键、紧凑窗口布局、状态栏定位
兼容性	支持 Apple Silicon（M1/M2）及 Intel 芯片 Mac
二、安装指南
1. 下载安装包
   从项目 installer 目录获取最新版本的 SmartAbbrev.dmg 安装包（打包方法见「开发与打包」章节）。
2. 安装步骤
   双击 SmartAbbrev.dmg 文件，打开安装镜像
   将 SmartAbbrev 应用图标拖拽到 Applications 文件夹
   从「启动台」或「应用程序」文件夹启动应用
   三、使用说明
1. 基础操作流程
   启动应用：首次启动后，状态栏会显示应用图标（小字母图标）
   呼出窗口：按下默认快捷键 Command+Shift+A（可自定义）
   输入内容：在搜索框中输入单词 / 短语（示例：user authentication service、configuration）
   获取结果：输入后自动生成缩写，按「缩写策略」分组显示
   复制使用：点击任意结果项或右侧「复制」按钮，内容会自动复制到剪贴板（有 toast 提示）
   关闭窗口：
   按下相同快捷键 Command+Shift+A
   点击窗口右上角「关闭」按钮
   按下 Escape 键
   点击窗口外任意区域（自动隐藏）
2. 快捷键设置
   在应用窗口点击顶部「设置」标签页，切换到设置面板
   点击「快捷键输入框」，按下想要设置的组合键（示例：Command+Shift+K，需至少包含 2 个键）
   点击「保存」按钮，新快捷键立即生效并自动保存（重启应用不丢失）
   点击「结果」标签页返回主界面
3. 其他常用操作
   操作需求	实现方式
   清空输入	点击搜索框右侧「×」按钮
   强制退出	右键点击状态栏图标 → 选择「退出」
   重新呼出	右键点击状态栏图标 → 选择「显示」
   查看历史	（当前版本基于本地存储，输入历史自动保留）
   四、开发与打包
1. 环境准备
   安装 Node.js（v16+ 推荐）和 Yarn
   NODE版本：v20.18.1， 使用Yarn v1.22.22
   克隆 / 下载项目代码到本地
   安装依赖：
   bash
   cd smartabbrev  # 进入项目根目录
   yarn install    # 安装所有依赖

2. 核心命令说明
   命令	作用	适用场景
   yarn start	启动开发模式，运行应用并显示调试日志	开发阶段，实时测试功能
   yarn clean	清理打包残留文件（dist 和 installer 目录）	打包前确保环境干净，避免旧文件冲突
   yarn package	为 Apple Silicon 芯片（M1/M2）打包应用	仅用于 ARM 架构 Mac（主流新机型）
   yarn package-universal	打包通用版本（同时支持 ARM + Intel 芯片）	需兼容旧款 Intel Mac 时使用
   yarn build-dmg	为 ARM 版本生成 DMG 安装包	配合 yarn package 使用
   yarn build-dmg-universal	为通用版本生成 DMG 安装包	配合 yarn package-universal 使用
3. 完整打包流程（以 ARM 版本为例）
   bash
# 1. 清理旧文件（可选但推荐）
yarn clean

# 2. 打包 ARM 架构应用（生成 .app 文件）
yarn package

# 3. 生成 DMG 安装包（输出到 installer 目录）
yarn build-dmg

打包完成后，installer 目录会生成 SmartAbbrev.dmg，可直接分发给其他用户安装。
五、注意事项
图标文件：项目根目录需存在 icon.icns（应用图标）和 icon.png（状态栏图标），否则打包可能失败（可使用在线工具将 PNG 转换为 ICNS 格式）。
快捷键冲突：若默认快捷键 Command+Shift+A 被其他应用占用，需在「设置」中修改为其他组合键（可在「系统设置 → 键盘 → 快捷键」中排查冲突）。
权限问题：
首次启动可能提示「无法打开，因为它来自身份不明的开发者」，需在「系统设置 → 隐私与安全性」中允许打开。
打包时若提示权限错误，可尝试在命令前加 sudo（示例：sudo yarn build-dmg）。
窗口位置：应用窗口默认显示在状态栏图标正下方，确保不会被状态栏遮挡，若屏幕空间不足会自动调整位置。
六、版本信息
当前版本：v1.0.0
兼容系统：macOS 12+（Monterey 及以上）
架构支持：ARM（M1/M2/M3）、Intel（x64）
依赖说明：基于 Electron 25.3.1 开发，离线可用（无需网络）
七、许可证
本项目基于 MIT 许可证开源，可自由修改、分发和商用，详见项目根目录的 LICENSE 文件。