@fishdivinity/dsh-local-search 0.2.1 → 0.3.0

package/lib/tools.js

@@ -29,13 +29,12 @@ async function guard(fn) {
 }
 
 /**
- * Coerce an optional numeric argument into `[1, cap]`. A non-numeric argument
- * falls back to the configured default instead of turning the window into NaN,
- * which would silently return nothing.
- * @param value - the argument as the model sent it
- * @param fallback - default to use when it is not a finite number
- * @param cap - inclusive upper bound
- * @returns the usable count
+ * 把可选的数字参数收进 `[1, cap]`。非数字参数回落到配置的默认值，而不是让窗口变成 NaN
+ * ——那样会静默返回空结果。
+ * @param value - 模型发来的参数原样
+ * @param fallback - 不是有限数字时用的默认值
+ * @param cap - 闭区间上界
+ * @returns 可用的条数
  */
 function clampCount(value, fallback, cap) {
   const number = Number.isFinite(value) ? Math.floor(value) : fallback
@@ -64,6 +63,19 @@ function validateEngine(engine, allowed) {
   return value
 }
 
+/**
+ * 这次调用该用哪个后端。
+ *
+ * `auto`（或没传）跟随配置里选的后端，而不是「注册表里的第一个」：配置里的 backend 就是
+ * 「默认用哪个」的声明，自动选第一个会让那个字段变成死配置。
+ * @param {string|undefined} requested - 调用参数里的 engine
+ * @param {string} configured - 配置里选的后端
+ * @returns {string} 要解析的后端名
+ */
+function engineFor(requested, configured) {
+  return requested === undefined || requested === '' || requested === 'auto' ? configured : requested
+}
+
 function presentSearchCall(label) {
   return (args) => ({
     card: 'generic',
@@ -188,20 +200,19 @@ const statusOutput = {
 }
 
 /**
- * Build and register the five model-facing tools.
+ * 构建并注册五个面向模型的工具。
  * @param {import('@deepseek-ai/cordis').Context} ctx
  * @param {object} config
- * @returns {Array<() => void>} tool disposers
+ * @returns {Array<() => void>} 工具的 disposer
  */
 export function createTools(ctx, config) {
-  // Registration fixes the tool deadlines and the text describing defaults;
-  // everything a call acts on is read per operation, so a save on the config
-  // page applies to the next call instead of the next reload.
+  // 注册时就固定了工具的截止时间与描述默认值的文案；一次调用真正用到的一切都是每次操作现读
+  // 的，所以配置页上的保存对下一次调用生效，而不是对下一次重载生效。
   const initial = readConfig(config)
   const names = engineNames()
 
   async function resolveWorkspace(exec, cfg) {
-    if (cfg.workspaceRoot) return cfg.workspaceRoot
+    if (cfg.scopes.workspaceRoot) return cfg.scopes.workspaceRoot
     if (exec.agent && ctx.workingDirectory?.ensure) {
       try {
         return await ctx.workingDirectory.ensure(exec.agent, exec.signal)
@@ -238,11 +249,11 @@ export function createTools(ctx, config) {
       },
       engine: {
         type: 'string',
-        description: `auto (default) or ${names.files.join(', ')}. Use auto unless the user asks for a specific engine.`,
+        description: `auto (default) follows the configured files backend; ${names.files.join(', ')} otherwise. Name one only when the user asks for a specific engine.`,
       },
       limit: {
         type: 'number',
-        description: `Max results (default ${initial.maxResults}; max ${MAX_LIMIT}).`,
+        description: `Max results (default ${initial.limits.maxResults}; max ${MAX_LIMIT}).`,
       },
     },
     timeoutMs: initial.timeoutMs,
@@ -251,7 +262,7 @@ export function createTools(ctx, config) {
       return guard(async () => {
         const cfg = readConfig(config)
         const query = requireQuery(args.query)
-        const engine = resolveFilesEngine(args.engine)
+        const engine = resolveFilesEngine(engineFor(args.engine, cfg.files.backend))
         const scope = args.scope || 'workspace'
         const workspace = await resolveWorkspace(exec, cfg)
         let dir
@@ -263,11 +274,11 @@ export function createTools(ctx, config) {
         return await engine.search({
           query,
           dir,
-          limit: clampLimit(args.limit, cfg.maxResults),
-          esPath: cfg.esPath,
+          limit: clampLimit(args.limit, cfg.limits.maxResults),
+          esPath: cfg.files.everything.esPath,
           timeoutMs: initial.timeoutMs,
           signal: exec.signal,
-          encoding: cfg.esEncoding,
+          encoding: cfg.files.everything.esEncoding,
         })
       })
     },
@@ -302,11 +313,11 @@ export function createTools(ctx, config) {
       },
       engine: {
         type: 'string',
-        description: `auto (default) or ${names.content.join(', ')}. Use auto unless the user asks for a specific engine.`,
+        description: `auto (default) follows the configured content backend; ${names.content.join(', ')} otherwise. Name one only when the user asks for a specific engine.`,
       },
       limit: {
         type: 'number',
-        description: `Max files (default ${initial.maxResults}; max ${MAX_LIMIT}).`,
+        description: `Max files (default ${initial.limits.maxResults}; max ${MAX_LIMIT}).`,
       },
     },
     timeoutMs: initial.timeoutMs,
@@ -315,15 +326,15 @@ export function createTools(ctx, config) {
       return guard(async () => {
         const cfg = readConfig(config)
         const query = requireQuery(args.query)
-        const engine = resolveContentEngine(args.engine)
+        const engine = resolveContentEngine(engineFor(args.engine, cfg.content.backend))
         const workspace = await resolveWorkspace(exec, cfg)
         const roots = rootsFor(args.scope || 'workspace', args.path, cfg, workspace)
         const result = await engine.search({
           query,
           roots,
           ext: args.ext,
-          limit: clampLimit(args.limit, cfg.maxResults),
-          url: cfg.anytxtUrl,
+          limit: clampLimit(args.limit, cfg.limits.maxResults),
+          url: cfg.content.anytxt.url,
           timeoutMs: initial.timeoutMs,
           signal: exec.signal,
         })
@@ -381,7 +392,7 @@ export function createTools(ctx, config) {
         const fragments = await engine.fragments({
           ref: args.ref,
           query,
-          url: cfg.anytxtUrl,
+          url: cfg.content.anytxt.url,
           timeoutMs: initial.timeoutMs,
           signal: exec.signal,
         })
@@ -411,7 +422,7 @@ export function createTools(ctx, config) {
       },
       max: {
         type: 'number',
-        description: `Max characters (default ${initial.readMaxChars}; max ${MAX_READ}).`,
+        description: `Max characters (default ${initial.limits.readMaxChars}; max ${MAX_READ}).`,
       },
     },
     timeoutMs: initial.timeoutMs,
@@ -422,7 +433,7 @@ export function createTools(ctx, config) {
         if (typeof args.ref !== 'string' || args.ref.trim().length === 0) {
           throw new Error('ref must be a non-empty string')
         }
-        const max = clampCount(args.max, cfg.readMaxChars, MAX_READ)
+        const max = clampCount(args.max, cfg.limits.readMaxChars, MAX_READ)
         const offset = clampOffset(args.offset)
         const parsed = parseRef(args.ref)
         const requested = args.engine && args.engine !== 'auto' ? args.engine : parsed.engine
@@ -435,7 +446,7 @@ export function createTools(ctx, config) {
         }
         const text = await engine.read({
           ref: args.ref,
-          url: cfg.anytxtUrl,
+          url: cfg.content.anytxt.url,
           timeoutMs: initial.timeoutMs,
           signal: exec.signal,
         })
@@ -462,21 +473,21 @@ export function createTools(ctx, config) {
       return guard(async () => {
         const cfg = readConfig(config)
         const engine = validateEngine(args.engine, STATUS_ENGINES)
-        let workspace = cfg.workspaceRoot || ctx.workingDirectory?.defaultDirectory || process.cwd()
+        let workspace = cfg.scopes.workspaceRoot || ctx.workingDirectory?.defaultDirectory || process.cwd()
         try {
           workspace = await resolveWorkspace(exec, cfg)
         } catch {
-          // Status must still report the engines even when the workspace is gone.
+          // 工作区没了也得把引擎报出来。
         }
 
-        // The same probe the configuration page's Test control asks for.
+        // 与配置页测试按钮要的是同一个探测。
         const { everything, anytxt } = await probeEngines(config, {
           only: engine,
           workspace,
           signal: exec.signal,
         })
 
-        const all = cfg.allRoots ? parseAllRoots(cfg.allRoots) : defaultAllRoots()
+        const all = cfg.scopes.allRoots ? parseAllRoots(cfg.scopes.allRoots) : defaultAllRoots()
         return {
           text: formatStatus({
             everything,
@@ -484,8 +495,8 @@ export function createTools(ctx, config) {
             engines: engineNames(),
             roots: {
               workspace,
-              work: cfg.workRoot,
-              personal: cfg.personalRoot,
+              work: cfg.scopes.workRoot,
+              personal: cfg.scopes.personalRoot,
               all,
             },
           }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fishdivinity/dsh-local-search",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Local file and document search for DeepSeek Harness: Everything filenames plus Anytxt document contents, read-only, with a configuration page on the Plugins page.",
   "type": "module",
   "main": "lib/index.js",
@@ -23,7 +23,8 @@
   ],
   "scripts": {
     "test": "node --test",
-    "check": "node --check lib/index.js && node --check lib/tools.js && node --check lib/engines.js && node --check lib/ref.js && node --check lib/everything.js && node --check lib/anytxt.js && node --check lib/roots.js && node --check lib/format.js && node --check lib/errors.js && node --check lib/config.js && node --check lib/limits.js && node --check lib/probe.js && node --check lib/route.js && node --check lib/client.js && node --check scripts/expand-release-links.mjs",
+    "check": "node --check lib/index.js && node --check lib/tools.js && node --check lib/engines.js && node --check lib/ref.js && node --check lib/everything.js && node --check lib/anytxt.js && node --check lib/roots.js && node --check lib/format.js && node --check lib/errors.js && node --check lib/config.js && node --check lib/schema.js && node --check lib/describe.js && node --check lib/bootstrap.js && node --check lib/limits.js && node --check lib/probe.js && node --check lib/route.js && node --check lib/client.js && node --check scripts/expand-release-links.mjs && node --check scripts/privacy-scan.mjs",
+    "privacy": "node scripts/privacy-scan.mjs",
     "pack:check": "npm pack --dry-run"
   },
   "keywords": [