@freely01/opencode-notify 0.1.0 → 0.2.0

package/events.ts

@@ -2,7 +2,7 @@
 // 但通过 event hook 收到时是 { type: string; properties: any }
 // 这里直接使用 any 避免对 SDK 内部类型的依赖
 import type { Message } from "./message.js"
-import { formatTitle, defaultBody } from "./message.js"
+import { formatTitle, formatBody, defaultBody } from "./message.js"
 
 /**
  * 将 opencode event hook 收到的 Event 映射为内部通知 Message
@@ -15,6 +15,8 @@ import { formatTitle, defaultBody } from "./message.js"
  * - "session.error"           → 会话错误
  * - "session.created"         → 新会话
  *
+ * @param event opencode 事件对象
+ * @param enabledEvents 启用的事件列表，用于过滤
  * @returns Message | null — 不关心的事件返回 null
  */
 export function route(
@@ -23,18 +25,33 @@ export function route(
 ): Message | null {
   const enabled = new Set(enabledEvents ?? [])
   const { type, properties } = event
+  const sessionID = properties.sessionID ?? "unknown"
+
+  /**
+   * 构造 Message 的辅助函数
+   * 统一处理 sessionID、title（带会话前缀）、body（结构化格式）
+   */
+  function makeMsg(evt: string, detail: string): Message {
+    const msg: Message = {
+      agent: "opencode",
+      event: evt,
+      sessionID,
+      title: formatTitle(evt, sessionID),
+      body: detail,
+    }
+    // 将 body 格式化为结构化通知正文
+    msg.body = formatBody(msg)
+    return msg
+  }
 
   // question.asked — 通用问题询问（权限/确认等均走此事件）
   // properties 结构待实测确认
   if (type === "question.asked" && enabled.has("permission_required")) {
     const text = properties.text ?? properties.message ?? ""
-    return {
-      agent: "opencode",
-      event: "permission_required",
-      sessionID: properties.sessionID ?? "unknown",
-      title: formatTitle("permission_required"),
-      body: text ? `需要确认: ${truncate(text, 200)}` : defaultBody("permission_required"),
-    }
+    return makeMsg(
+      "permission_required",
+      text ? `需要确认: ${truncate(text, 200)}` : defaultBody("permission_required"),
+    )
   }
 
   // permission.asked — 工具权限请求
@@ -46,62 +63,37 @@ export function route(
       : (properties.tool ?? "")
     const permission = properties.permission ?? ""
     const desc = [toolName, permission].filter(Boolean).join(" - ")
-    return {
-      agent: "opencode",
-      event: "permission_required",
-      sessionID: properties.sessionID ?? "unknown",
-      title: formatTitle("permission_required"),
-      body: desc
+    return makeMsg(
+      "permission_required",
+      desc
         ? `操作「${desc}」需要您的授权许可`
         : defaultBody("permission_required"),
-    }
+    )
   }
 
   // 会话错误 → run_failed
   if (type === "session.error" && enabled.has("run_failed")) {
     const err = properties.error
     const errMsg = err?.message ?? err?.name ?? defaultBody("run_failed")
-    return {
-      agent: "opencode",
-      event: "run_failed",
-      sessionID: properties.sessionID ?? "unknown",
-      title: formatTitle("run_failed"),
-      body: `错误: ${truncate(String(errMsg), 200)}`,
-    }
+    return makeMsg(
+      "run_failed",
+      `错误: ${truncate(String(errMsg), 200)}`,
+    )
   }
 
   // 会话空闲 → input_required
   if (type === "session.idle" && enabled.has("input_required")) {
-    return {
-      agent: "opencode",
-      event: "input_required",
-      sessionID: properties.sessionID ?? "unknown",
-      title: formatTitle("input_required"),
-      body: defaultBody("input_required"),
-    }
+    return makeMsg("input_required", defaultBody("input_required"))
   }
 
   // session.status 也可能包含 idle 状态
   if (type === "session.status" && enabled.has("input_required")) {
     const status = properties.status
     if (status?.type === "idle") {
-      return {
-        agent: "opencode",
-        event: "input_required",
-        sessionID: properties.sessionID ?? "unknown",
-        title: formatTitle("input_required"),
-        body: defaultBody("input_required"),
-      }
+      return makeMsg("input_required", defaultBody("input_required"))
     }
   }
 
-  // 新会话创建 → 可跟踪任务开始
-  // 当前暂不直接通知，留作 run_completed 检测的基础
-  if (type === "session.created") {
-    // 预留: 可在这里记录会话开始时间，用于后续推断任务完成
-    return null
-  }
-
   return null
 }
 

package/index.ts

@@ -1,43 +1,21 @@
 import type { Plugin } from "@opencode-ai/plugin"
 import type { PluginConfig } from "./config.js"
-import { resolveConfig, loadYamlConfig, mergeConfig } from "./config.js"
+import { resolveConfig, loadYamlConfig, mergeConfig, ensureConfigFile } from "./config.js"
 import { route } from "./events.js"
 import { Dispatcher } from "./dispatcher.js"
 import { FileStore } from "./store.js"
-import { SystemSender } from "./senders/system.js"
-import { ScreenFlashSender } from "./senders/screen-flash.js"
+import { SystemSender } from "./senders/system/index.js"
+import { ScreenFlashSender } from "./senders/screen-flash/index.js"
 import { CustomWebhookSender } from "./senders/custom-webhook.js"
 import { WechatWorkSender } from "./senders/wechat-work.js"
 import { FeishuSender } from "./senders/feishu.js"
 import { FilteredSender } from "./senders/types.js"
-import { writeFileSync, mkdirSync, existsSync } from "node:fs"
-import { homedir } from "node:os"
-import { join, dirname } from "node:path"
-import { fileURLToPath } from "node:url"
+import { SessionTracker } from "./session-tracker.js"
+import { configureLog, error, warn, info, debug } from "./log.js"
+import { DelayedDispatcher } from "./delayed-dispatcher.js"
+import { isTerminalOccluded } from "./terminator-detect.js"
 
-const __dirname = dirname(fileURLToPath(import.meta.url))
-const MARQUEE_SCRIPT = join(__dirname, "scripts", "marquee.py")
-
-const LOG_DIR = join(homedir(), ".opencode-notify")
-const LOG_FILE = join(LOG_DIR, "plugin.log")
-
-let debugEnabled = false
-
-function enableDebug() {
-  debugEnabled = true
-}
-
-function log(msg: string) {
-  if (!debugEnabled) return
-  try {
-    if (!existsSync(LOG_DIR)) mkdirSync(LOG_DIR, { recursive: true })
-    writeFileSync(LOG_FILE, `[${new Date().toISOString()}] ${msg}\n`, { flag: "a" })
-  } catch {
-    // 日志写入失败不影响主流程
-  }
-}
-
-// 用户活跃事件类型
+// 用户活跃事件类型（这些事件表明用户正在操作 opencode 的某个会话）
 const USER_ACTIVITY_EVENTS = new Set([
   "message.updated",
   "permission.replied",
@@ -46,21 +24,44 @@ const USER_ACTIVITY_EVENTS = new Set([
   "tui.command.execute",
 ])
 
+// 应追踪会话生命周期的事件（不产生通知，仅更新会话状态）
+// 直接在内联 if 中判断，无需常量
+
+
 const plugin: Plugin = async (_input, options) => {
+  // 确保配置文件存在（不存在则生成默认模板）
+  ensureConfigFile()
+
   // 加载 YAML 配置 + 合并 plugin options
   const yamlCfg = loadYamlConfig() ?? {}
   const merged = mergeConfig(yamlCfg, options as PluginConfig ?? {})
   const cfg = resolveConfig(merged)
-  if (cfg.debug_log) enableDebug()
+  configureLog(cfg.log?.level as any ?? "info", cfg.log?.file)
   const store = new FileStore()
-  const senders = buildSenders(cfg)
+
+  // 构建发送器
+  const { senders, senderMap } = buildSenders(cfg)
   const dispatcher = new Dispatcher(store, cfg.dedupe_seconds ?? 60, senders)
-  // 用户活跃追踪
-  let lastActivity = Date.now()
-  const suppressActive = cfg.suppress_when_active ?? true
-  const activityTimeout = cfg.activity_timeout_ms ?? 30_000
 
-  log(`插件已加载, debug_log=${cfg.debug_log}, events=${JSON.stringify(cfg.events)}, suppressActive=${suppressActive}, timeout=${activityTimeout}ms`)
+  // 远程延迟推送
+  const delayedChannels = cfg.remote_delay_channels ?? []
+  const delayedDispatcher = delayedChannels.length > 0
+    ? new DelayedDispatcher(
+        (cfg.remote_delay_seconds ?? 60) * 1000,
+        cfg.remote_delay_max_count ?? 3,
+        delayedChannels,
+        senderMap,
+      )
+    : undefined
+
+  // 会话感知抑制
+  const tracker = new SessionTracker(cfg.session_stale_timeout_ms)
+
+  info(`插件已加载, log_level=${cfg.log?.level}, events=${JSON.stringify(cfg.events)}, `
+    + `suppressActive=${cfg.suppress_when_active}, timeout=${cfg.activity_timeout_ms}ms, `
+    + `suppressEvents=${JSON.stringify(cfg.suppress_events_when_active)}, `
+    + `remote_channels=${JSON.stringify(delayedChannels)}, `
+    + `terminator_detect=${!!process.env.TERMINATOR_UUID}`)
 
   return {
     // event 总线 — 所有事件通过此钩子
@@ -68,70 +69,122 @@ const plugin: Plugin = async (_input, options) => {
       const { type, properties } = event as any
       const propKeys = properties ? Object.keys(properties).join(",") : ""
 
-      // 调试日志：记录所有事件（随时可关闭）
-      log(`[event] type=${type} keys=${propKeys}`)
+      // 调试日志：记录所有事件
+      debug(`[event] type=${type} keys=${propKeys}`)
+
+      const sessionID = properties?.sessionID ?? "unknown"
 
-      // 用户活跃事件追踪
+      // === 更新会话追踪状态 ===
+
+      // 用户操作事件 → 标记该会话活跃 + 取消延迟通知
       if (USER_ACTIVITY_EVENTS.has(type)) {
-        lastActivity = Date.now()
-        log(`→ 用户活跃事件, 重置活跃时间`)
+        tracker.markActivity(sessionID)
+        delayedDispatcher?.cancelForSession(sessionID)
+        debug(`→ 用户活跃事件, 会话=${sessionID}`)
       }
 
-      // 活跃抑制检查
-      if (suppressActive) {
-        const idleMs = Date.now() - lastActivity
-        if (idleMs < activityTimeout) {
-          // 用户活跃中，跳过通知
-          return
-        }
+      // 会话生命周期事件
+      if (type === "session.created") {
+        tracker.register(sessionID)
+        debug(`→ 会话已创建, 会话=${sessionID}`)
+      }
+      if (type === "session.deleted") {
+        tracker.remove(sessionID)
+        delayedDispatcher?.cancelForSession(sessionID)
+        debug(`→ 会话已删除, 会话=${sessionID}`)
       }
 
+      // === 通知判定 ===
+
+      const suppressEvents = cfg.suppress_events_when_active ?? []
+
+      // 先路由事件，看是否匹配通知
       const msg = route(event, cfg.events)
-      if (msg) {
-        log(`→ 匹配通知: ${msg.event}`)
-        await dispatcher.dispatch(msg)
+      if (!msg) return  // 不关心的事件
+
+      debug(`→ 匹配通知: ${msg.event}`)
+
+      // 会话感知抑制判定
+      let shouldSuppress = cfg.suppress_when_active && suppressEvents.includes(msg.event)
+        && tracker.isSessionActive(sessionID, cfg.activity_timeout_ms ?? 15000)
+
+      // Terminator 子屏遮挡覆盖：会话活跃但如果本屏被遮挡 → 强制通知
+      if (shouldSuppress) {
+        const occluded = isTerminalOccluded()
+        if (occluded === true) {
+          info(`→ 会话 ${sessionID} 活跃但 Terminator 子屏被遮挡，强制通知 (${msg.event})`)
+          shouldSuppress = false
+        } else if (occluded === false) {
+          debug(`→ Terminator 子屏未遮挡，正常抑制`)
+        }
+        // null = 不在 Terminator 或检测失败，不处理
       }
+
+      if (shouldSuppress) {
+        info(`→ 会话 ${sessionID} 活跃中，跳过通知 (${msg.event})`)
+        return
+      }
+
+      // 调度发送（正常立即通知）
+      await dispatcher.dispatch(msg)
+
+      // 正常通知已发出 → 调度远程延迟推送（如果启用）
+      delayedDispatcher?.schedule(msg)
     },
   }
 }
 
+/** buildSenders 返回值 */
+interface BuildSendersResult {
+  senders: import("./senders/types.js").Sender[]
+  senderMap: Map<string, import("./senders/types.js").Sender>
+}
+
 function addSender(
   senders: import("./senders/types.js").Sender[],
   sender: import("./senders/types.js").Sender,
   events: string[],
   label: string,
   extra?: string,
-) {
-  senders.push(new FilteredSender(sender, events))
+): import("./senders/types.js").Sender {
+  const filtered = new FilteredSender(sender, events)
+  senders.push(filtered)
   const evt = events.length < 6 ? `events=${JSON.stringify(events)}` : `events=${events.length}个`
-  log(`${label}已启用 (${evt})${extra ? `, ${extra}` : ""}`)
+  info(`${label}已启用 (${evt})${extra ? `, ${extra}` : ""}`)
+  return filtered
 }
 
-function buildSenders(cfg: PluginConfig) {
+function buildSenders(cfg: PluginConfig): BuildSendersResult {
   const senders: import("./senders/types.js").Sender[] = []
+  const senderMap = new Map<string, import("./senders/types.js").Sender>()
   const globalEvents = cfg.events ?? []
 
   if (cfg.channels?.system_message?.enabled) {
     const events = cfg.channels.system_message.events ?? globalEvents
-    addSender(senders, new SystemSender(), events, "系统通知")
+    const s = addSender(senders, new SystemSender(), events, "系统通知")
+    senderMap.set("system_message", s)
   }
   if (cfg.channels?.screen_flash?.enabled) {
     const events = cfg.channels.screen_flash.events ?? globalEvents
-    addSender(senders, new ScreenFlashSender(cfg.channels.screen_flash), events, "屏幕跑马灯")
+    const s = addSender(senders, new ScreenFlashSender(cfg.channels.screen_flash), events, "屏幕跑马灯")
+    senderMap.set("screen_flash", s)
   }
   if (cfg.channels?.custom_webhook?.enabled && cfg.channels.custom_webhook.url) {
     const events = cfg.channels.custom_webhook.events ?? globalEvents
-    addSender(senders, new CustomWebhookSender(cfg.channels.custom_webhook), events, "自定义 Webhook")
+    const s = addSender(senders, new CustomWebhookSender(cfg.channels.custom_webhook), events, "自定义 Webhook")
+    senderMap.set("custom_webhook", s)
   }
   if (cfg.channels?.wechat_work?.enabled && cfg.channels.wechat_work.webhook_url) {
     const events = cfg.channels.wechat_work.events ?? globalEvents
-    addSender(senders, new WechatWorkSender(cfg.channels.wechat_work), events, "企业微信")
+    const s = addSender(senders, new WechatWorkSender(cfg.channels.wechat_work), events, "企业微信")
+    senderMap.set("wechat_work", s)
   }
   if (cfg.channels?.feishu?.enabled && cfg.channels.feishu.webhook_url) {
     const events = cfg.channels.feishu.events ?? globalEvents
-    addSender(senders, new FeishuSender(cfg.channels.feishu), events, "飞书")
+    const s = addSender(senders, new FeishuSender(cfg.channels.feishu), events, "飞书")
+    senderMap.set("feishu", s)
   }
-  return senders
+  return { senders, senderMap }
 }
 
 export default plugin

package/log.ts

@@ -0,0 +1,90 @@
+import { writeFileSync, mkdirSync, existsSync } from "node:fs"
+import { homedir } from "node:os"
+import { join, dirname } from "node:path"
+
+/**
+ * 日志等级（按优先级从高到低）
+ */
+export type LogLevel = "error" | "warn" | "info" | "debug"
+
+const LEVEL_PRIORITY: Record<LogLevel, number> = {
+  error: 0,
+  warn: 1,
+  info: 2,
+  debug: 3,
+}
+
+interface LogState {
+  level: LogLevel
+  file: string
+}
+
+const state: LogState = {
+  level: "info",
+  file: join(homedir(), ".opencode-notify", "plugin.log"),
+}
+
+/**
+ * 配置日志系统
+ *
+ * @param level 日志等级（仅输出 >= 此等级的消息）
+ * @param file  日志文件路径（可选，不传保持当前值）
+ */
+export function configureLog(level: LogLevel, file?: string): void {
+  state.level = level
+  if (file) state.file = file
+  ensureDir()
+}
+
+/** 获取当前日志文件路径 */
+export function getLogFile(): string {
+  return state.file
+}
+
+/** 获取当前日志等级 */
+export function getLogLevel(): LogLevel {
+  return state.level
+}
+
+function ensureDir(): void {
+  try {
+    const dir = dirname(state.file)
+    if (!existsSync(dir)) mkdirSync(dir, { recursive: true })
+  } catch {
+    // 创建目录失败不影响主流程
+  }
+}
+
+function writeLog(level: LogLevel, msg: string): void {
+  if (LEVEL_PRIORITY[level] > LEVEL_PRIORITY[state.level]) return
+  try {
+    ensureDir()
+    writeFileSync(
+      state.file,
+      `[${new Date().toISOString()}] [${level.toUpperCase()}] ${msg}\n`,
+      { flag: "a" },
+    )
+  } catch {
+    // 日志写入失败不影响主流程
+  }
+}
+
+/** 错误日志 — 系统无法正常运行或功能不可用 */
+export function error(msg: string): void {
+  writeLog("error", msg)
+}
+
+/** 警告日志 — 潜在问题，但不影响核心功能 */
+export function warn(msg: string): void {
+  writeLog("warn", msg)
+}
+
+/** 信息日志 — 正常运行状态变化 */
+export function info(msg: string): void {
+  writeLog("info", msg)
+}
+
+/** 调试日志 — 详细事件流，仅排查问题时开启 */
+export function debug(msg: string): void {
+  writeLog("debug", msg)
+}

package/message.ts

@@ -23,12 +23,27 @@ const EVENT_LABELS: Record<string, string> = {
   session_idle: "会话空闲",
 }
 
+/**
+ * 截短会话 ID 便于阅读
+ */
+function shortSession(sessionID: string): string {
+  if (!sessionID || sessionID === "unknown") return "未知"
+  return sessionID.length > 11
+    ? sessionID.slice(0, 11) + "…"
+    : sessionID
+}
+
 /**
  * 格式化通知标题
+ * @param event 事件类型
+ * @param sessionID 会话 ID（可选，传入后在标题前加会话标签）
  */
-export function formatTitle(event: string): string {
+export function formatTitle(event: string, sessionID?: string): string {
   const label = EVENT_LABELS[event] ?? event
-  return `opencode - ${label}`
+  const prefix = sessionID && sessionID !== "unknown"
+    ? `[${shortSession(sessionID)}] `
+    : ""
+  return `${prefix}opencode - ${label}`
 }
 
 /**
@@ -48,3 +63,25 @@ export function defaultBody(event: string): string {
       return `事件: ${event}`
   }
 }
+
+/**
+ * 格式化结构化通知正文
+ *
+ * 输出格式：
+ *   事件：权限请求
+ *   会话：ses_abc1234
+ *   详情：Agent 需要授权
+ *   时间：2026-05-31 15:30:00
+ */
+export function formatBody(msg: Message): string {
+  const now = new Date()
+  const time = `${now.getFullYear()}-${String(now.getMonth() + 1).padStart(2, "0")}-${String(now.getDate()).padStart(2, "0")} ${String(now.getHours()).padStart(2, "0")}:${String(now.getMinutes()).padStart(2, "0")}:${String(now.getSeconds()).padStart(2, "0")}`
+  const eventLabel = EVENT_LABELS[msg.event] ?? msg.event
+
+  return [
+    `事件：${eventLabel}`,
+    `会话：${shortSession(msg.sessionID)}`,
+    `详情：${msg.body}`,
+    `时间：${time}`,
+  ].join("\n")
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@freely01/opencode-notify",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "opencode 通知插件 - 监听会话事件并通过多渠道推送通知",
   "type": "module",
   "main": "index.ts",

package/senders/screen-flash/index.ts

@@ -0,0 +1,27 @@
+/**
+ * 屏幕跑马灯发送器
+ *
+ * 通知时在屏幕四边产生彩色跑马灯效果。
+ * 当前仅 Linux X11 支持（Python + GTK 透明覆盖窗口）。
+ * 其他平台静默忽略。
+ */
+
+import type { Sender } from "../types.js"
+import type { Message } from "../../message.js"
+import type { ScreenFlashChannelConfig } from "../../config.js"
+import { flash } from "./linux.js"
+
+export class ScreenFlashSender implements Sender {
+  readonly name = "screen_flash"
+  private config: ScreenFlashChannelConfig
+
+  constructor(config: ScreenFlashChannelConfig) {
+    this.config = config
+  }
+
+  async send(_msg: Message): Promise<void> {
+    // 仅 Linux 支持跑马灯效果
+    if (process.platform !== "linux") return
+    await flash(this.config)
+  }
+}

package/senders/screen-flash/linux.ts

@@ -0,0 +1,29 @@
+/**
+ * Linux X11 屏幕跑马灯
+ *
+ * 在屏幕四边生成彩色高亮闪烁效果（跑马灯）。
+ * 使用 Python + PyGObject(GTK 3) 创建透明覆盖窗口。
+ * Ubuntu GNOME 桌面内置依赖，无需额外安装。
+ */
+
+import { spawn } from "node:child_process"
+import { join, dirname } from "node:path"
+import { fileURLToPath } from "node:url"
+import type { ScreenFlashChannelConfig } from "../../config.js"
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+const MARQUEE_SCRIPT = join(__dirname, "..", "..", "scripts", "marquee.py")
+
+export async function flash(config: ScreenFlashChannelConfig): Promise<void> {
+  const args = [
+    MARQUEE_SCRIPT,
+    String(config.duration ?? 3.0),
+    String(config.speed ?? 4.0),
+    String(config.intensity ?? 0.9),
+  ]
+  const child = spawn("python3", args, {
+    stdio: "ignore",
+    detached: true,
+  })
+  child.unref()
+}

package/senders/system/darwin.ts

@@ -0,0 +1,17 @@
+/**
+ * macOS 系统通知
+ *
+ * 使用 osascript 调用原生通知中心。
+ * - display notification: 弹窗 + 声音
+ * - 系统内置，无需额外安装
+ */
+
+import { execSync } from "node:child_process"
+
+export async function notify(title: string, body: string): Promise<void> {
+  const script = `display notification "${body}" with title "${title}" sound name "default"`
+  execSync(`osascript -e ${JSON.stringify(script)}`, {
+    timeout: 5000,
+    stdio: "ignore",
+  })
+}

package/senders/system/index.ts

@@ -0,0 +1,61 @@
+/**
+ * 系统通知发送器
+ *
+ * 根据运行平台自动选择实现：
+ * - macOS  → darwin.ts  (osascript)
+ * - Linux  → linux.ts   (notify-send)
+ * - Windows → win32.ts  (PowerShell BurntToast / MessageBox)
+ * - 其他平台 → 静默忽略
+ */
+
+import type { Sender } from "../types.js"
+import type { Message } from "../../message.js"
+import { notify as darwinNotify } from "./darwin.js"
+import { notify as linuxNotify } from "./linux.js"
+import { notify as win32Notify } from "./win32.js"
+
+/** 平台通知函数注册表 */
+const notifiers: Record<string, (title: string, body: string) => Promise<void>> = {
+  darwin: darwinNotify,
+  linux: linuxNotify,
+  win32: win32Notify,
+}
+
+export class SystemSender implements Sender {
+  readonly name = "system_message"
+
+  async send(msg: Message): Promise<void> {
+    const fn = notifiers[process.platform]
+    if (!fn) return // 其他平台静默忽略
+
+    const { title, body } = sanitize(msg.title, msg.body)
+    try {
+      await fn(title, body)
+    } catch (err) {
+      throw new Error(`系统通知失败: ${err}`)
+    }
+  }
+}
+
+/**
+ * 转义标题和正文中的特殊字符，防止 shell 注入
+ */
+function sanitize(
+  title: string,
+  body: string,
+): { title: string; body: string } {
+  return {
+    title: escape(title),
+    body: escape(body),
+  }
+}
+
+function escape(s: string): string {
+  return s
+    .replace(/"/g, '\\"')
+    .replace(/'/g, "\\'")
+    .replace(/`/g, "\\`")
+    .replace(/\$/g, "\\$")
+    .replace(/\n/g, " ")
+    .replace(/\r/g, "")
+}