@xiaoqiong0v0/opencode-sound-notify 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -4
- package/assets/ask.wav +0 -0
- package/assets/error.wav +0 -0
- package/dist/sound-notify.js +25 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -22,16 +22,20 @@ npm install @xiaoqiong0v0/opencode-sound-notify
|
|
|
22
22
|
|
|
23
23
|
```jsonc
|
|
24
24
|
{
|
|
25
|
-
//
|
|
25
|
+
// 默认提示音文件路径,留空使用内置 default.wav
|
|
26
26
|
"sound": "",
|
|
27
|
+
// 按事件单独指定提示音路径,key=事件名,value=wav 文件路径
|
|
28
|
+
"sounds": {
|
|
29
|
+
"session.error": "",
|
|
30
|
+
"permission.asked": ""
|
|
31
|
+
},
|
|
27
32
|
// 触发提示音的事件列表
|
|
28
33
|
"events": ["session.idle", "session.error", "permission.asked"],
|
|
29
34
|
// 全局默认防抖间隔(ms),未单独配置的事件使用此值
|
|
30
35
|
"defaultDebounceMs": 30000,
|
|
31
36
|
// 按事件单独配置防抖间隔(ms),覆盖 defaultDebounceMs
|
|
32
37
|
"debounceMs": {
|
|
33
|
-
"
|
|
34
|
-
"session.error": 5000
|
|
38
|
+
"permission.asked": 5000
|
|
35
39
|
},
|
|
36
40
|
// 语言: "zh" 或 "en"
|
|
37
41
|
"lang": "en",
|
|
@@ -42,13 +46,22 @@ npm install @xiaoqiong0v0/opencode-sound-notify
|
|
|
42
46
|
|
|
43
47
|
| 字段 | 默认值 | 说明 |
|
|
44
48
|
|------|--------|------|
|
|
45
|
-
| `sound` | 内置 `assets/default.wav` |
|
|
49
|
+
| `sound` | 内置 `assets/default.wav` | 默认 .wav 路径 |
|
|
50
|
+
| `sounds` | `{}` | 按事件单独配置,key=事件名,value=wav 路径 |
|
|
46
51
|
| `events` | `["session.idle", "session.error", "permission.asked"]` | 触发事件列表 |
|
|
47
52
|
| `defaultDebounceMs` | `30000` | 全局默认防抖间隔 |
|
|
48
53
|
| `debounceMs` | `{}` | 按事件单独配置,key=事件名,value=防抖间隔(ms) |
|
|
49
54
|
| `lang` | `"en"` | 语言设置 |
|
|
50
55
|
| `enabled` | `true` | 总开关 |
|
|
51
56
|
|
|
57
|
+
内置音频对应关系:
|
|
58
|
+
|
|
59
|
+
| 事件 | 内置文件 | 音效 |
|
|
60
|
+
|------|----------|------|
|
|
61
|
+
| `session.idle` | `assets/default.wav` | 默认 |
|
|
62
|
+
| `session.error` | `assets/error.wav` | 短促蜂鸣 |
|
|
63
|
+
| `permission.asked` | `assets/ask.wav` | 双音提醒 |
|
|
64
|
+
|
|
52
65
|
## 支持的事件
|
|
53
66
|
|
|
54
67
|
| 事件 | 说明 |
|
package/assets/ask.wav
ADDED
|
Binary file
|
package/assets/error.wav
ADDED
|
Binary file
|
package/dist/sound-notify.js
CHANGED
|
@@ -11,8 +11,14 @@ const ASSET_DIR = join(__dirname, "..", "assets");
|
|
|
11
11
|
const DEFAULT_SOUND = join(ASSET_DIR, "default.wav");
|
|
12
12
|
const log = createLogger("sound-notify");
|
|
13
13
|
const SAMPLE_CFG = `{
|
|
14
|
-
//
|
|
14
|
+
// 默认提示音文件路径,留空使用内置 default.wav
|
|
15
15
|
"sound": "",
|
|
16
|
+
// 按事件单独指定提示音路径,key=事件名,value=wav文件路径
|
|
17
|
+
// 留空则使用默认 sound
|
|
18
|
+
"sounds": {
|
|
19
|
+
"session.error": "",
|
|
20
|
+
"permission.asked": ""
|
|
21
|
+
},
|
|
16
22
|
// 触发提示音的事件列表
|
|
17
23
|
"events": ["session.idle", "session.error", "permission.asked"],
|
|
18
24
|
// 全局默认防抖间隔(ms),未单独配置的事件使用此值
|
|
@@ -42,7 +48,6 @@ const T = (key, params) => {
|
|
|
42
48
|
return Object.entries(params).reduce((s, [k, v]) => s.replace(`{${k}}`, v), t);
|
|
43
49
|
};
|
|
44
50
|
let cfg = {};
|
|
45
|
-
let soundPath = DEFAULT_SOUND;
|
|
46
51
|
function readJsonc(path) {
|
|
47
52
|
const raw = readFileSync(path, "utf-8").replace(/\/\/.*$/gm, "").replace(/\/\*[\s\S]*?\*\//g, "");
|
|
48
53
|
return JSON.parse(raw);
|
|
@@ -57,12 +62,12 @@ function loadCfg() {
|
|
|
57
62
|
const raw = readJsonc(CONFIG_PATH);
|
|
58
63
|
cfg = {
|
|
59
64
|
sound: raw.sound || "",
|
|
65
|
+
sounds: raw.sounds,
|
|
60
66
|
events: raw.events,
|
|
61
67
|
defaultDebounceMs: raw.defaultDebounceMs || 30000,
|
|
62
68
|
debounceMs: raw.debounceMs,
|
|
63
69
|
enabled: raw.enabled !== false,
|
|
64
70
|
};
|
|
65
|
-
soundPath = cfg.sound && existsSync(cfg.sound) ? cfg.sound : DEFAULT_SOUND;
|
|
66
71
|
LANG = raw.lang === "zh" ? "zh" : "en";
|
|
67
72
|
}
|
|
68
73
|
try {
|
|
@@ -89,12 +94,24 @@ function getPlayerArgs(sound) {
|
|
|
89
94
|
return null;
|
|
90
95
|
}
|
|
91
96
|
}
|
|
92
|
-
function
|
|
93
|
-
|
|
94
|
-
|
|
97
|
+
function resolveSound(eventType) {
|
|
98
|
+
const custom = cfg.sounds?.[eventType];
|
|
99
|
+
if (custom && existsSync(custom))
|
|
100
|
+
return custom;
|
|
101
|
+
if (cfg.sound && existsSync(cfg.sound))
|
|
102
|
+
return cfg.sound;
|
|
103
|
+
const builtin = join(ASSET_DIR, `${eventType === "session.idle" ? "default" : eventType.replace("session.", "")}.wav`);
|
|
104
|
+
if (existsSync(builtin))
|
|
105
|
+
return builtin;
|
|
106
|
+
return DEFAULT_SOUND;
|
|
107
|
+
}
|
|
108
|
+
function play(eventType) {
|
|
109
|
+
const path = resolveSound(eventType);
|
|
110
|
+
if (!existsSync(path)) {
|
|
111
|
+
log.error(T("no_sound_file", { path }));
|
|
95
112
|
return Promise.resolve(false);
|
|
96
113
|
}
|
|
97
|
-
const args = getPlayerArgs(
|
|
114
|
+
const args = getPlayerArgs(path);
|
|
98
115
|
if (!args) {
|
|
99
116
|
log.error(T("unsupported_platform", { platform: process.platform }));
|
|
100
117
|
return Promise.resolve(false);
|
|
@@ -124,7 +141,7 @@ export const SoundNotify = async () => {
|
|
|
124
141
|
return {
|
|
125
142
|
event: async ({ event }) => {
|
|
126
143
|
if (shouldPlay(event.type)) {
|
|
127
|
-
play();
|
|
144
|
+
play(event.type);
|
|
128
145
|
}
|
|
129
146
|
},
|
|
130
147
|
};
|
package/package.json
CHANGED