Files
everything-claude-code/scripts/hooks/desktop-notify.js
QWsin 02206e87a5 fix(hooks): remove external repo URL from tip message
BurntToast module is a well-known Microsoft module but per project
policy avoiding unvetted external links in user-facing output.
2026-03-30 14:08:08 +08:00

175 lines
5.4 KiB
JavaScript

#!/usr/bin/env node
/**
* Desktop Notification Hook (Stop)
*
* Sends a native desktop notification with the task summary when Claude
* finishes responding. Supports:
* - macOS: osascript (native)
* - WSL: PowerShell 7 or Windows PowerShell + BurntToast module
*
* On WSL, if BurntToast is not installed, logs a tip for installation.
*
* Hook ID : stop:desktop-notify
* Profiles: standard, strict
*/
'use strict';
const { spawnSync } = require('child_process');
const { isMacOS, log } = require('../lib/utils');
const TITLE = 'Claude Code';
const MAX_BODY_LENGTH = 100;
/**
* Check if running on WSL (Windows Subsystem for Linux).
*/
function isWSL() {
if (process.platform !== 'linux') return false;
try {
return require('fs').readFileSync('/proc/version', 'utf8').toLowerCase().includes('microsoft');
} catch {
return false;
}
}
/**
* Find available PowerShell executable on WSL.
* Checks PowerShell 7 first, then falls back to Windows PowerShell.
* Returns { path, version } or null if none available.
*/
function findPowerShell() {
if (!isWSL()) return null;
const candidates = [
'/mnt/c/Program Files/PowerShell/7/pwsh.exe', // PowerShell 7
'/mnt/c/Windows/System32/WindowsPowerShell/v1.0/powershell.exe', // Windows PowerShell
];
for (const path of candidates) {
try {
const result = spawnSync(path, ['-Command', '$PSVersionTable.PSVersion.Major'],
{ stdio: ['ignore', 'pipe', 'ignore'], timeout: 3000 });
if (result.status === 0) {
const version = parseInt(result.stdout.toString().trim(), 10);
return { path, version };
}
} catch {
// continue
}
}
return null;
}
/**
* Check if BurntToast module is available on the given PowerShell path.
*/
function isBurntToastAvailable(pwshPath) {
try {
const result = spawnSync(pwshPath,
['-Command', 'Import-Module BurntToast -ErrorAction Stop; $true'],
{ stdio: ['ignore', 'pipe', 'ignore'], timeout: 5000 });
return result.status === 0;
} catch {
return false;
}
}
/**
* Extract a short summary from the last assistant message.
* Takes the first non-empty line and truncates to MAX_BODY_LENGTH chars.
*/
function extractSummary(message) {
if (!message || typeof message !== 'string') return 'Done';
const firstLine = message
.split('\n')
.map(l => l.trim())
.find(l => l.length > 0);
if (!firstLine) return 'Done';
return firstLine.length > MAX_BODY_LENGTH
? `${firstLine.slice(0, MAX_BODY_LENGTH)}...`
: firstLine;
}
/**
* Send a macOS notification via osascript.
* AppleScript strings do not support backslash escapes, so we replace
* double quotes with curly quotes and strip backslashes before embedding.
*/
function notifyMacOS(title, body) {
const safeBody = body.replace(/\\/g, '').replace(/"/g, '\u201C');
const safeTitle = title.replace(/\\/g, '').replace(/"/g, '\u201C');
const script = `display notification "${safeBody}" with title "${safeTitle}"`;
const result = spawnSync('osascript', ['-e', script], { stdio: 'ignore', timeout: 5000 });
if (result.error || result.status !== 0) {
log(`[DesktopNotify] osascript failed: ${result.error ? result.error.message : `exit ${result.status}`}`);
}
}
/**
* Send a Windows Toast notification via PowerShell BurntToast.
* Used when running under WSL to show notification on Windows desktop.
*/
function notifyWindows(pwshPath, title, body) {
const safeBody = body.replace(/'/g, "''");
const safeTitle = title.replace(/'/g, "''");
const command = `Import-Module BurntToast; New-BurntToastNotification -Text '${safeTitle}', '${safeBody}'`;
const result = spawnSync(pwshPath, ['-Command', command], { stdio: ['ignore', 'pipe', 'pipe'], timeout: 5000 });
if (result.error || result.status !== 0) {
log(`[DesktopNotify] BurntToast failed (exit ${result.status}): ${result.error ? result.error.message : result.stderr?.toString()}`);
}
}
/**
* Fast-path entry point for run-with-flags.js (avoids extra process spawn).
*/
function run(raw) {
try {
const input = raw.trim() ? JSON.parse(raw) : {};
const summary = extractSummary(input.last_assistant_message);
if (isMacOS) {
notifyMacOS(TITLE, summary);
} else if (isWSL()) {
// WSL: try PowerShell 7 first, then Windows PowerShell
const ps = findPowerShell();
if (ps && isBurntToastAvailable(ps.path)) {
notifyWindows(ps.path, TITLE, summary);
} else if (ps) {
// PowerShell exists but no BurntToast module
log('[DesktopNotify] Tip: Install BurntToast module to enable notifications:');
log(`[DesktopNotify] "${ps.path}" -Command "Install-Module -Name BurntToast -Scope CurrentUser"`);
} else {
// No PowerShell found
log('[DesktopNotify] Tip: Install BurntToast module in PowerShell for notifications');
}
}
} catch (err) {
log(`[DesktopNotify] Error: ${err.message}`);
}
return raw;
}
module.exports = { run };
// Legacy stdin path (when invoked directly rather than via run-with-flags)
if (require.main === module) {
const MAX_STDIN = 1024 * 1024;
let data = '';
process.stdin.setEncoding('utf8');
process.stdin.on('data', chunk => {
if (data.length < MAX_STDIN) {
data += chunk.substring(0, MAX_STDIN - data.length);
}
});
process.stdin.on('end', () => {
const output = run(data);
if (output) process.stdout.write(output);
});
}