@jonathanleelx/meddle 0.5.0-beta.23 → 0.5.0-beta.25

package/bin/commands/route/update.js

@@ -1,136 +1,169 @@
 /**
  * meddle route update - Update a rule in a route file
+ *
+ * Issue #149: `--exclusions=` clears a rule's exclusions. Omitting the flag
+ * (and any !path in the pattern) still keeps them.
  */
 
 const output = require('../../lib/output')
 const { isProxyRunning } = require('../../lib/proxy-detect')
 const { apiGet, apiPut } = require('../../lib/api-client')
-const { getRuleFileContent, saveRuleFileContent, parseEprc, ruleMapToEprcText } = require('../../lib/file-access')
+const { getRuleFileContent, saveRuleFileContent } = require('../../lib/file-access')
+const { updateRouteRule, patternKey, parseRuleLine } = require('../../lib/rule-file-edit')
+const { isRulesetReadonlyError, exitRulesetReadonly } = require('../../lib/ruleset-readonly')
+const {
+  parseRouteWriteArgs,
+  parsePatternArg,
+  resolveExclusions,
+  UPDATE_HELP,
+} = require('../../lib/route-write-args')
 
-// Parse arguments (skip 'route' and 'update' from argv)
 const args = process.argv.slice(4)
-const jsonFlag = args.includes('--json')
+
+function fail(message, jsonFlag) {
+  if (jsonFlag) {
+    console.log(JSON.stringify({ success: false, error: { message } }))
+    console.error(message)
+  } else {
+    output.setJsonMode(false)
+    output.error(message)
+  }
+  process.exit(1)
+}
+
+let parsed
+try {
+  parsed = parseRouteWriteArgs(args)
+} catch (e) {
+  fail(e.message, args.includes('--json'))
+}
+
+if (parsed.help) {
+  console.log(UPDATE_HELP.trim())
+  process.exit(0)
+}
+
+const jsonFlag = parsed.json
 output.setJsonMode(jsonFlag)
 
-// Get positional arguments: file, pattern, newTarget
-const positionalArgs = args.filter(a => !a.startsWith('--'))
-const fileName = positionalArgs[0]
-const pattern = positionalArgs[1]
-const newTarget = positionalArgs[2]
+const fileName = parsed.positional[0]
+const pattern = parsed.positional[1]
+const newTarget = parsed.positional[2]
 
-async function run() {
-  if (!fileName) {
-    output.error('Missing required argument: <file>')
-    process.exit(1)
+/** Set once arguments are valid. `explicit` means the user asked to set exclusions, including clear. */
+let explicitExclusions = false
+let appliedExclusions = []
+
+function planUpdate() {
+  const { patterns, exclusions: patternExclusions } = parsePatternArg(pattern)
+  if (patterns.length === 0) {
+    fail('Missing required argument: <pattern>', jsonFlag)
   }
-  if (!pattern) {
-    output.error('Missing required argument: <pattern>')
-    process.exit(1)
+  const resolved = resolveExclusions(patternExclusions, parsed.exclusions)
+  explicitExclusions = resolved.explicit
+  appliedExclusions = resolved.exclusions || []
+  return { patterns, exclusions: resolved.explicit ? resolved.exclusions : undefined }
+}
+
+/**
+ * Issue #145: rewrite only the line(s) holding this pattern. The rule keeps its
+ * own `!exclusions` unless new ones are given. Issue #149: `--exclusions=` passes
+ * `[]`, which removes `!path` from that line. Every other line keeps its bytes.
+ */
+function applyUpdate(text, plan) {
+  const target = newTarget ? newTarget.trim() : undefined
+  let next = text
+  for (const p of plan.patterns) {
+    const result = updateRouteRule(next, { pattern: p, target, exclusions: plan.exclusions })
+    if (!result.found) {
+      fail(`Pattern not found: ${pattern.trim()}`, jsonFlag)
+    }
+    next = result.content
   }
-  if (!newTarget) {
-    output.error('Missing required argument: <target>')
-    process.exit(1)
+  return next
+}
+
+/** Target token actually written, for feedback when the user did not pass one. */
+function targetOnDisk(content, patternToken) {
+  const key = patternKey(patternToken)
+  const lines = content.split(/\r?\n/)
+  for (const line of lines) {
+    const parsedLine = parseRuleLine(line)
+    if (parsedLine && parsedLine.patterns.some((p) => patternKey(p) === key)) return parsedLine.target
   }
+  return ''
+}
 
-  const running = await isProxyRunning()
+function emitUpdated({ fileOnly, target }) {
+  const payload = { success: true, file: fileName, pattern: pattern.trim(), newTarget: target }
+  if (explicitExclusions) payload.exclusions = appliedExclusions
+  if (fileOnly) {
+    payload.fileOnly = true
+    payload.warning = output.FILE_ONLY_WARNING
+  }
+  if (jsonFlag) {
+    output.jsonRaw(payload)
+    return
+  }
+  output.header('Route Rule Updated')
+  output.success(`${pattern.trim()} -> ${target}`)
+  if (explicitExclusions) {
+    output.kv('Exclusions', appliedExclusions.length ? appliedExclusions.map((e) => `!${e}`).join(' ') : 'cleared')
+  }
+  output.kv('File', fileName)
+}
 
-  const pat = pattern.trim()
-  const tgt = newTarget.trim()
+async function run() {
+  if (!fileName) fail('Missing required argument: <file>', jsonFlag)
+  if (!pattern) fail('Missing required argument: <pattern>', jsonFlag)
+  if (parsed.positional.length > 3) fail(`Unexpected argument: ${parsed.positional[3]}`, jsonFlag)
+
+  let plan
+  try {
+    plan = planUpdate()
+  } catch (e) {
+    fail(e.message, jsonFlag)
+  }
+  if (!newTarget && !explicitExclusions) fail('Missing required argument: <target>', jsonFlag)
+
+  const running = await isProxyRunning()
 
-  // Handle [marker] syntax for lookup
-  const bm = pat.match(/\[([^\]]+)\]/)
-  const internalKey = bm ? pat.replace(bm[0], bm[1]) : pat
+  const finish = (content, fileOnly) => {
+    const target = newTarget ? newTarget.trim() : targetOnDisk(content, plan.patterns[0])
+    emitUpdated({ fileOnly, target })
+  }
 
   if (running) {
     try {
       let content = await apiGet(`/api/rule-files/${encodeURIComponent(fileName)}/content`)
       const text = typeof content === 'string' ? content : String(content)
-      const ruleMap = parseEprc(text)
-
-      if (!Object.prototype.hasOwnProperty.call(ruleMap, internalKey)) {
-        output.error(`Pattern not found: ${pat}`)
-        process.exit(1)
-      }
-
-      ruleMap[internalKey] = bm ? tgt + bm[0] : tgt
-      const newContent = ruleMapToEprcText(ruleMap)
+      const newContent = applyUpdate(text, plan)
       await apiPut(`/api/rule-files/${encodeURIComponent(fileName)}/content`, { content: newContent })
-
-      if (jsonFlag) {
-        output.jsonRaw({ success: true, file: fileName, pattern: pat, newTarget: tgt })
-        return
-      }
-
-      output.header('Route Rule Updated')
-      output.success(`${pat} -> ${tgt}`)
-      output.kv('File', fileName)
+      finish(newContent, false)
+      return
     } catch (e) {
+      // Issue #137: a locked ruleset is a final answer, never a cue to write the file directly.
+      if (isRulesetReadonlyError(e)) exitRulesetReadonly(e, { json: jsonFlag, ruleFile: fileName })
       // Fallback to file mode
       const content = getRuleFileContent(fileName)
-      if (!content) {
-        output.error(`Route file not found: ${fileName}`)
-        process.exit(1)
-      }
-
-      const ruleMap = parseEprc(content)
-      if (!Object.prototype.hasOwnProperty.call(ruleMap, internalKey)) {
-        output.error(`Pattern not found: ${pat}`)
-        process.exit(1)
-      }
-
-      ruleMap[internalKey] = bm ? tgt + bm[0] : tgt
-      const newContent = ruleMapToEprcText(ruleMap)
+      if (!content) fail(`Route file not found: ${fileName}`, jsonFlag)
+      const newContent = applyUpdate(content, plan)
       saveRuleFileContent(fileName, newContent)
       output.warnFileOnlyMode()
-
-      if (jsonFlag) {
-        output.jsonRaw({ success: true, file: fileName, pattern: pat, newTarget: tgt,
-        fileOnly: true,
-        warning: output.FILE_ONLY_WARNING
-      })
-        return
-      }
-
-
-      output.header('Route Rule Updated')
-      output.success(`${pat} -> ${tgt}`)
-      output.kv('File', fileName)
-    }
-  } else {
-    // File mode
-    const content = getRuleFileContent(fileName)
-    if (!content) {
-      output.error(`Route file not found: ${fileName}`)
-      process.exit(1)
-    }
-
-    const ruleMap = parseEprc(content)
-    if (!Object.prototype.hasOwnProperty.call(ruleMap, internalKey)) {
-      output.error(`Pattern not found: ${pat}`)
-      process.exit(1)
-    }
-
-    ruleMap[internalKey] = bm ? tgt + bm[0] : tgt
-    const newContent = ruleMapToEprcText(ruleMap)
-    saveRuleFileContent(fileName, newContent)
-    output.warnFileOnlyMode()
-
-    if (jsonFlag) {
-      output.jsonRaw({ success: true, file: fileName, pattern: pat, newTarget: tgt,
-      fileOnly: true,
-      warning: output.FILE_ONLY_WARNING
-    })
+      finish(newContent, true)
       return
     }
-
-
-    output.header('Route Rule Updated')
-    output.success(`${pat} -> ${tgt}`)
-    output.kv('File', fileName)
   }
+
+  const content = getRuleFileContent(fileName)
+  if (!content) fail(`Route file not found: ${fileName}`, jsonFlag)
+  const newContent = applyUpdate(content, plan)
+  saveRuleFileContent(fileName, newContent)
+  output.warnFileOnlyMode()
+  finish(newContent, true)
 }
 
 run().catch(e => {
-  output.error(e.message)
-  process.exit(1)
-})
+  if (isRulesetReadonlyError(e)) exitRulesetReadonly(e, { json: jsonFlag, ruleFile: fileName })
+  fail(e.message, jsonFlag)
+})

package/bin/index.js

@@ -107,7 +107,8 @@ Route 命令:
   meddle route active set <file>  设置激活的路由文件
   meddle route create <name>      创建路由文件
   meddle route add <file> <pattern> <target>   添加路由规则
-  meddle route update <file> <pattern> <target> 更新路由规则
+  meddle route update <file> <pattern> [<target>] [--exclusions=]
+                              更新路由规则；--exclusions= 清空排除项
   meddle route delete <file> <pattern> 删除路由规则
 
 全局选项:
@@ -137,6 +138,7 @@ Route 命令:
   meddle route preview "https://api.example.com/v1/users"  # 预览转发目标
   meddle route preview "https://cdn.com/assets/js/app.js" --file dev-rules --json
   meddle route add dev-rules "api.test.com" "localhost:3000"
+  meddle route update dev-rules "api.test.com" --exclusions=
   meddle route active set beta-rules
 
 更多信息请访问: https://github.com/JonathanLee-LX/meddle

package/bin/lib/api-client.js

@@ -25,14 +25,26 @@ async function apiRequest(method, pathname, body, timeoutMs = DEFAULT_TIMEOUT) {
 
   if (!response.ok) {
     const text = await response.text()
-    throw new Error(text || response.statusText)
+    const err = new Error(text || response.statusText)
+    err.status = response.status
+    // Structured errors (e.g. issue #137 RULESET_READONLY) keep their code.
+    try {
+      const data = JSON.parse(text)
+      if (data && typeof data === 'object') {
+        if (typeof data.code === 'string') err.code = data.code
+        if (typeof data.ruleFile === 'string') err.ruleFile = data.ruleFile
+      }
+    } catch (_) {}
+    throw err
   }
 
   const contentType = response.headers.get('content-type')
   if (contentType && contentType.includes('application/json')) {
     return response.json()
   }
-  return response.text()
+  // Issue #145: `Response.text()` strips a leading UTF-8 BOM, so a rule file
+  // read and written back through the API would silently lose it.
+  return new TextDecoder('utf-8', { ignoreBOM: true }).decode(await response.arrayBuffer())
 }
 
 /**

package/bin/lib/file-access.js

@@ -5,6 +5,7 @@
 const fs = require('fs')
 const path = require('path')
 const { meddleDir } = require('./proxy-detect')
+const { RulesetReadonlyError } = require('./ruleset-readonly')
 
 const routeRulesDir = path.join(meddleDir, 'route-rules')
 const settingsPath = path.join(meddleDir, 'settings.json')
@@ -51,6 +52,33 @@ function setActiveRuleFileNames(names) {
   saveSettings(settings)
 }
 
+/**
+ * Issue #137: locked rule files (settings.json `readonlyRuleFiles`). Entries
+ * whose file no longer exists are dropped silently. A missing field = none locked.
+ */
+function getReadonlyRuleFileNames() {
+  const settings = loadSettings()
+  if (!Object.prototype.hasOwnProperty.call(settings, 'readonlyRuleFiles')) return []
+  const raw = settings.readonlyRuleFiles
+  const names = Array.isArray(raw) ? raw.filter((n, i, arr) => typeof n === 'string' && n && arr.indexOf(n) === i) : []
+  const live = names.filter((name) => fs.existsSync(path.join(routeRulesDir, `${name}.txt`)))
+  if (!Array.isArray(raw) || live.length !== raw.length) {
+    settings.readonlyRuleFiles = live
+    saveSettings(settings)
+  }
+  return live
+}
+
+function isRuleFileReadonly(name) {
+  const fold = (n) => (process.platform === 'darwin' || process.platform === 'win32' ? n.toLowerCase() : n)
+  return getReadonlyRuleFileNames().some((item) => fold(item) === fold(name))
+}
+
+/** Throws RulesetReadonlyError (code RULESET_READONLY) for a locked rule file. */
+function assertRuleFileWritable(name) {
+  if (isRuleFileReadonly(name)) throw new RulesetReadonlyError(name)
+}
+
 // ========== Mocks ==========
 
 /**
@@ -217,6 +245,7 @@ function listRuleFiles() {
     .map(f => f.replace(/\.txt$/, ''))
 
   const ordered = resolveRuleFileOrder(files, getRuleFileOrderNames(), activeNames)
+  const readonlyNames = new Set(getReadonlyRuleFileNames())
 
   return ordered.map(name => {
     const filePath = getRuleFilePath(name)
@@ -234,6 +263,7 @@ function listRuleFiles() {
     return {
       name,
       enabled: activeNames.includes(name),
+      readonly: readonlyNames.has(name),
       ruleCount,
       excludeCount
     }
@@ -258,6 +288,7 @@ function getRuleFileContent(name) {
  */
 function saveRuleFileContent(name, content) {
   ensureRouteRulesDir()
+  assertRuleFileWritable(name)
   const filePath = getRuleFilePath(name)
   fs.writeFileSync(filePath, content, 'utf8')
 }
@@ -274,6 +305,8 @@ function createRuleFile(name, content = '', enabled = true) {
     throw new Error(`规则文件 "${safeName}" 已存在`)
   }
 
+  // Drop stale lock entries so a new file never inherits an old lock.
+  getReadonlyRuleFileNames()
   fs.writeFileSync(filePath, content, 'utf8')
 
   if (enabled) {
@@ -285,7 +318,7 @@ function createRuleFile(name, content = '', enabled = true) {
   }
 
   const ruleCount = content.trim() ? Object.keys(parseEprc(content)).length : 0
-  return { name: safeName, enabled, ruleCount }
+  return { name: safeName, enabled, readonly: false, ruleCount }
 }
 
 /**
@@ -296,6 +329,7 @@ function deleteRuleFile(name) {
   if (!fs.existsSync(filePath)) {
     throw new Error('规则文件不存在')
   }
+  assertRuleFileWritable(name)
   fs.unlinkSync(filePath)
 
   const activeNames = getActiveRuleFileNames()
@@ -317,6 +351,7 @@ function setRuleFileEnabled(name, enabled) {
 
   const activeNames = getActiveRuleFileNames()
   const idx = activeNames.indexOf(name)
+  if ((enabled && idx === -1) || (!enabled && idx !== -1)) assertRuleFileWritable(name)
 
   if (enabled && idx === -1) {
     activeNames.push(name)
@@ -352,6 +387,9 @@ module.exports = {
   saveSettings,
   getActiveRuleFileNames,
   setActiveRuleFileNames,
+  getReadonlyRuleFileNames,
+  isRuleFileReadonly,
+  assertRuleFileWritable,
 
   // Mocks
   getMocksPath,

package/bin/lib/route-write-args.js

@@ -0,0 +1,150 @@
+/**
+ * Argument parsing for `meddle route add|update|delete` (issue #149).
+ *
+ * `--exclusions=` clears a rule's exclusions. `--exclusions=/a,/b` replaces
+ * them. A bare `--exclusions`, an unknown flag, or an empty `!` token used to
+ * be ignored and the command still exited 0 without changing exclusions.
+ */
+
+const { splitPatternArg } = require('./rule-file-edit')
+
+class RouteArgError extends Error {
+  constructor(message) {
+    super(message)
+    this.name = 'RouteArgError'
+  }
+}
+
+const CLEAR_HINT = 'To clear exclusions, pass --exclusions= (empty). To replace them, pass --exclusions=/a,/b.'
+
+/**
+ * @param {string} raw value after `=`
+ * @returns {string[]}
+ */
+function parseExclusionList(raw) {
+  const value = String(raw).trim()
+  if (value === '') return []
+  const pieces = value.includes(',') ? value.split(',') : value.split(/\s+/)
+  const out = []
+  for (const piece of pieces) {
+    const token = piece.trim()
+    if (!token) {
+      throw new RouteArgError(`Invalid --exclusions: empty entry. ${CLEAR_HINT}`)
+    }
+    const body = token.startsWith('!') ? token.slice(1).trim() : token
+    if (!body) {
+      throw new RouteArgError(`Invalid --exclusions: "!" needs a path, for example --exclusions=/health. ${CLEAR_HINT}`)
+    }
+    out.push(body)
+  }
+  return out
+}
+
+/**
+ * @param {string[]} args argv after the subcommand
+ * @param {{ allowExclusions?: boolean }} [options]
+ * @returns {{ help: boolean, json: boolean, positional: string[], exclusions: string[] | undefined }}
+ * `exclusions` is undefined when the flag was not passed. `[]` means clear.
+ */
+function parseRouteWriteArgs(args, { allowExclusions = true } = {}) {
+  let help = false
+  let json = false
+  /** @type {string[] | undefined} */
+  let exclusions
+  let sawExclusions = false
+  const positional = []
+
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i]
+    if (arg === '--help' || arg === '-h') {
+      help = true
+      continue
+    }
+    if (arg === '--json') {
+      json = true
+      continue
+    }
+    if (arg === '--exclusions' || arg.startsWith('--exclusions=')) {
+      if (!allowExclusions) {
+        throw new RouteArgError(`Unsupported option: ${arg === '--exclusions' ? '--exclusions' : '--exclusions='}. route delete does not change exclusions.`)
+      }
+      if (arg === '--exclusions') {
+        throw new RouteArgError(`Unsupported option: --exclusions. ${CLEAR_HINT}`)
+      }
+      if (sawExclusions) throw new RouteArgError('--exclusions was given more than once.')
+      sawExclusions = true
+      exclusions = parseExclusionList(arg.slice('--exclusions='.length))
+      continue
+    }
+    if (arg.startsWith('-')) {
+      throw new RouteArgError(`Unsupported option: ${arg}.`)
+    }
+    positional.push(arg)
+  }
+
+  return { help, json, positional, exclusions: sawExclusions ? exclusions : undefined }
+}
+
+/**
+ * Split a pattern argument the way the CLI always has (`"host !/api"`), but
+ * refuse a bare `!` — that used to be dropped and looked like a successful clear.
+ * @returns {{ patterns: string[], exclusions: string[] }}
+ */
+function parsePatternArg(raw) {
+  const parts = String(raw).trim().split(/\s+/).filter(Boolean)
+  for (const part of parts) {
+    if (part.startsWith('!') && part.slice(1).trim() === '') {
+      throw new RouteArgError('Invalid exclusion "!": a "!" token needs a path such as "!/api". To clear exclusions, pass --exclusions=.')
+    }
+  }
+  return splitPatternArg(raw)
+}
+
+/**
+ * @param {string[]} patternExclusions exclusions parsed from !path tokens
+ * @param {string[] | undefined} flagExclusions undefined when --exclusions was omitted
+ * @returns {{ explicit: boolean, exclusions: string[] | undefined }}
+ */
+function resolveExclusions(patternExclusions, flagExclusions) {
+  if (flagExclusions !== undefined && patternExclusions.length > 0) {
+    throw new RouteArgError('Pass exclusions either as !path tokens in the pattern or with --exclusions, not both.')
+  }
+  if (flagExclusions !== undefined) return { explicit: true, exclusions: flagExclusions }
+  if (patternExclusions.length > 0) return { explicit: true, exclusions: patternExclusions }
+  return { explicit: false, exclusions: undefined }
+}
+
+const UPDATE_HELP = `
+meddle route update <file> <pattern> [<target>] [--exclusions=<list>] [--json]
+
+Update a rule. Edits only the line(s) that hold the pattern; every other line
+stays byte-for-byte, including comments, blank lines and other rules' !path.
+
+  --exclusions=            Clear this rule's exclusions (the line loses !path).
+  --exclusions=/a,/b       Replace exclusions. Spaces work inside quotes
+                           (--exclusions="/a /b"). A leading ! is optional.
+  "pattern !/a !/b"        Replace exclusions (same as before). Omit both
+                           --exclusions and !path to keep existing exclusions.
+
+The <target> may be omitted when --exclusions is set; the current target stays.
+A bare --exclusions, an empty "!" token, an unknown flag, or both exclusion
+forms at once exits 1 and does not change the file.
+
+A "#" comments out a whole line only when it is the first non-space character.
+A "#" later on a rule line is a pattern token, not a trailing comment.
+
+Examples:
+  meddle route update dev "api.example.com" "localhost:4000"
+  meddle route update dev "api.example.com" --exclusions=
+  meddle route update dev "api.example.com" "localhost:4000" --exclusions=/health
+`
+
+module.exports = {
+  CLEAR_HINT,
+  RouteArgError,
+  UPDATE_HELP,
+  parseExclusionList,
+  parsePatternArg,
+  parseRouteWriteArgs,
+  resolveExclusions,
+}