docs(core): 📝 完善项目文档并增强安全性

更新项目根目录 README.md 以更清晰地展示脚本集合架构,并为 Homebrew、Sub-Store 和 Telegram 模块新增详细的使用说明文档。

同时移除了 brew-upgrade-manager.sh 中的硬编码 sudo 密码,改为空字符串占位符以提升代码安全性。

- 增强根目录文档的可读性与结构
- 为每个子模块添加独立的 README.md
- 修复脚本中的敏感信息泄露问题 (SUDO_PWD)
This commit is contained in:
2026-05-03 15:18:21 +08:00
parent ce6710724d
commit c3437ae163
5 changed files with 420 additions and 2 deletions

96
substore/README.md Normal file
View File

@@ -0,0 +1,96 @@
# Sub-Store SNTP Rename
`sntp-rename.js` 是一个 Sub-Store 节点处理脚本,用于根据节点名中的关键词自动注入线路属性标签。
## 作用
脚本会遍历传入的 `proxies` 数组,检查每个代理节点的 `name` 字段。命中关键词后,会把对应标签追加到节点名中:
- 如果节点名带有 `- SNTP...` 后缀,标签会插入到 `- SNTP` 之前。
- 如果节点名没有该后缀,标签会追加到名称末尾。
- 如果已经包含同样标签,不会重复注入。
## 默认规则
| 命中关键词 | 注入标签 |
| --- | --- |
| `GTM 0.5x` | `[三网]` |
| `GTM` | `[三网]` |
| `S1` | `[广移]` |
| `S2` | `[广电]` |
| `S3` | `[广移]` |
| `S4` | `[广联]` |
| `BGP` | `[cn2\|5x]` |
| `Anytls` | `[直连]` |
## 示例
输入:
```text
香港 GTM 0.5x - SNTP 01
广州 S1 - SNTP 02
日本 BGP 01
普通节点 01
```
输出:
```text
香港 GTM 0.5x [三网] - SNTP 01
广州 S1 [广移] - SNTP 02
日本 BGP 01 [cn2|5x]
普通节点 01
```
## 在 Sub-Store 中使用
1. 打开 Sub-Store。
2. 进入订阅或节点处理配置。
3. 添加 JavaScript 脚本处理器。
4. 粘贴 [sntp-rename.js](sntp-rename.js) 内容。
5. 保存并刷新订阅。
脚本暴露的入口函数为:
```javascript
function operator(proxies) {
// ...
}
```
## 修改规则
只需要编辑脚本顶部的 `featureMap`
```javascript
const featureMap = {
"GTM 0.5x": "三网",
"GTM": "三网",
"S1": "广移",
"S2": "广电",
"S3": "广移",
"S4": "广联",
"BGP": "cn2|5x",
"Anytls": "直连"
};
```
新增规则示例:
```javascript
"IEPL": "专线"
```
## 匹配逻辑
- 关键词匹配不区分大小写。
- 关键词会按长度从长到短生成正则,避免 `GTM` 先抢走 `GTM 0.5x` 的匹配。
- 纯字母数字关键词会自动加单词边界,避免 `S1` 错误匹配到 `US1`
- 映射时会忽略关键词中的空格,例如 `GTM 0.5x``GTM0.5X` 会映射到同一个标签。
## 注意事项
- 该脚本只修改节点名称,不修改节点协议、地址、端口或其他连接参数。
- 如果节点命中多个关键词,只会按当前正则排序匹配第一个。
- 如需支持更多后缀位置,可修改脚本中的 `suffixRegex`