From ad4105af5e92d82abafa8df8a417a17a1c1c7c6b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=8D=E6=B1=82=E5=9C=A3=E5=89=91?= Date: Tue, 18 Nov 2025 15:45:27 +0800 Subject: [PATCH] refactor: rename JackeryHome component directory and update references - Renamed the `custom_components/jackery_home/` directory to `custom_components/JackeryHome/` for consistency with naming conventions. - Updated all relevant documentation and scripts to reflect the new directory name. - Removed obsolete files related to the previous directory structure. --- AGENTS.md | 2 +- HACS_PUBLISHING_GUIDE.md | 4 ++-- README.md | 10 +++++----- .../{jackery_home => JackeryHome}/README.md | 0 .../{jackery_home => JackeryHome}/__init__.py | 0 .../{jackery_home => JackeryHome}/config_flow.py | 0 .../{jackery_home => JackeryHome}/manifest.json | 0 .../{jackery_home => JackeryHome}/sensor.py | 0 .../{jackery_home => JackeryHome}/strings.json | 0 .../translations/zh-Hans.json | 0 prepare_release.sh | 8 ++++---- 11 files changed, 12 insertions(+), 12 deletions(-) rename custom_components/{jackery_home => JackeryHome}/README.md (100%) rename custom_components/{jackery_home => JackeryHome}/__init__.py (100%) rename custom_components/{jackery_home => JackeryHome}/config_flow.py (100%) rename custom_components/{jackery_home => JackeryHome}/manifest.json (100%) rename custom_components/{jackery_home => JackeryHome}/sensor.py (100%) rename custom_components/{jackery_home => JackeryHome}/strings.json (100%) rename custom_components/{jackery_home => JackeryHome}/translations/zh-Hans.json (100%) diff --git a/AGENTS.md b/AGENTS.md index b826d8d..3ea4c51 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -2,7 +2,7 @@ ## Project Structure & Module Organization - Energy simulator lives at `main.py`; MQTT examples under `data_transmission_example.py`. -- Home Assistant integration is in `custom_components/jackery_home/` with `__init__.py`, `sensor.py`, `config_flow.py`, translations, and docs. +- Home Assistant integration is in `custom_components/JackeryHome/` with `__init__.py`, `sensor.py`, `config_flow.py`, translations, and docs. - Branding assets sit in `brands/`; release helpers and docs (e.g., `prepare_release.sh`, `README.md`, `energy_flow_card_config.yaml`) are at the repo root. - Tests currently consist of targeted scripts such as `test_mqtt.py`; add new suites beside related modules. diff --git a/HACS_PUBLISHING_GUIDE.md b/HACS_PUBLISHING_GUIDE.md index a0435ea..bddd444 100644 --- a/HACS_PUBLISHING_GUIDE.md +++ b/HACS_PUBLISHING_GUIDE.md @@ -90,11 +90,11 @@ jackery_home/ ``` 3. **更新版本号** - 编辑 `custom_components/jackery_home/manifest.json` 中的版本号 + 编辑 `custom_components/JackeryHome/manifest.json` 中的版本号 4. **提交版本更新** ```bash - git add custom_components/jackery_home/manifest.json + git add custom_components/JackeryHome/manifest.json git commit -m "版本更新至 v1.0.0" ``` diff --git a/README.md b/README.md index 472da56..4b3a767 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ 本项目包含两个主要部分： 1. **MQTT 模拟器** (`main.py`) - 模拟发送能源监控数据到 MQTT broker -2. **Home Assistant 自定义集成** (`custom_components/jackery_home/`) - 接收 MQTT 数据并创建传感器实体 +2. **Home Assistant 自定义集成** (`custom_components/JackeryHome/`) - 接收 MQTT 数据并创建传感器实体 ## 传感器列表 @@ -57,7 +57,7 @@ ### 方式二：手动安装 1. 下载最新的 [Release](https://github.com/suyulin/jackery_home/releases) -2. 将 `custom_components/jackery_home` 文件夹复制到你的 Home Assistant 配置目录的 `custom_components/` 文件夹中 +2. 将 `custom_components/JackeryHome` 文件夹复制到你的 Home Assistant 配置目录的 `custom_components/` 文件夹中 3. 重启 Home Assistant 4. 按照上述"配置集成"步骤进行配置 @@ -161,7 +161,7 @@ entities: ### 核心文件 - `main.py`: MQTT 传感器模拟器主程序 -- `custom_components/jackery_home/`: Home Assistant 自定义集成 +- `custom_components/JackeryHome/`: Home Assistant 自定义集成 - `__init__.py`: 集成入口 - `manifest.json`: 集成元数据 - `sensor.py`: 传感器平台实现 @@ -199,7 +199,7 @@ entities: ## 文档 - [**HACS 发布指南**](HACS_PUBLISHING_GUIDE.md) - 如何发布到 HACS -- [自定义集成 README](custom_components/jackery_home/README.md) - 集成技术文档 +- [自定义集成 README](custom_components/JackeryHome/README.md) - 集成技术文档 ## 开发者 @@ -213,7 +213,7 @@ entities: 或手动发布： -1. 更新 `custom_components/jackery_home/manifest.json` 中的版本号 +1. 更新 `custom_components/JackeryHome/manifest.json` 中的版本号 2. 提交更改并推送到 GitHub 3. 创建新的 Git tag（如 `v1.0.1`） 4. 在 GitHub 创建 Release diff --git a/custom_components/jackery_home/README.md b/custom_components/JackeryHome/README.md similarity index 100% rename from custom_components/jackery_home/README.md rename to custom_components/JackeryHome/README.md diff --git a/custom_components/jackery_home/__init__.py b/custom_components/JackeryHome/__init__.py similarity index 100% rename from custom_components/jackery_home/__init__.py rename to custom_components/JackeryHome/__init__.py diff --git a/custom_components/jackery_home/config_flow.py b/custom_components/JackeryHome/config_flow.py similarity index 100% rename from custom_components/jackery_home/config_flow.py rename to custom_components/JackeryHome/config_flow.py diff --git a/custom_components/jackery_home/manifest.json b/custom_components/JackeryHome/manifest.json similarity index 100% rename from custom_components/jackery_home/manifest.json rename to custom_components/JackeryHome/manifest.json diff --git a/custom_components/jackery_home/sensor.py b/custom_components/JackeryHome/sensor.py similarity index 100% rename from custom_components/jackery_home/sensor.py rename to custom_components/JackeryHome/sensor.py diff --git a/custom_components/jackery_home/strings.json b/custom_components/JackeryHome/strings.json similarity index 100% rename from custom_components/jackery_home/strings.json rename to custom_components/JackeryHome/strings.json diff --git a/custom_components/jackery_home/translations/zh-Hans.json b/custom_components/JackeryHome/translations/zh-Hans.json similarity index 100% rename from custom_components/jackery_home/translations/zh-Hans.json rename to custom_components/JackeryHome/translations/zh-Hans.json diff --git a/prepare_release.sh b/prepare_release.sh index bbb926b..75a9855 100755 --- a/prepare_release.sh +++ b/prepare_release.sh @@ -35,7 +35,7 @@ if ! git diff-index --quiet HEAD --; then fi # 获取当前版本 -CURRENT_VERSION=$(grep -o '"version": "[^"]*"' custom_components/jackery_home/manifest.json | cut -d'"' -f4) +CURRENT_VERSION=$(grep -o '"version": "[^"]*"' custom_components/JackeryHome/manifest.json | cut -d'"' -f4) echo "📦 当前版本: $CURRENT_VERSION" echo "" @@ -50,9 +50,9 @@ fi # 更新 manifest.json 中的版本号 if [ "$NEW_VERSION" != "$CURRENT_VERSION" ]; then echo "📝 更新 manifest.json 中的版本号..." - sed -i.bak "s/\"version\": \"$CURRENT_VERSION\"/\"version\": \"$NEW_VERSION\"/" custom_components/jackery_home/manifest.json - rm custom_components/jackery_home/manifest.json.bak - git add custom_components/jackery_home/manifest.json + sed -i.bak "s/\"version\": \"$CURRENT_VERSION\"/\"version\": \"$NEW_VERSION\"/" custom_components/JackeryHome/manifest.json + rm custom_components/JackeryHome/manifest.json.bak + git add custom_components/JackeryHome/manifest.json git commit -m "版本更新至 v$NEW_VERSION" echo "✅ 版本号已更新" fi