dxkj 0.1.0 → 0.1.2

package/src/lib/targets.js

@@ -1,50 +1,50 @@
-import path from 'node:path';
-import { loadConfig, expandHome } from './config.js';
-
-/** 把 id/名称转成安全的目录名 */
-export function slugify(str) {
-  return String(str || '')
-    .replace(/@v?/g, '-v')
-    .replace(/[^a-zA-Z0-9._-]+/g, '-')
-    .replace(/^-+|-+$/g, '')
-    .toLowerCase();
-}
-
-/**
- * 解析某条目在指定 target 下的安装目录。
- * target 三种：ai-editor | navlink | generic
- * @returns {{target:string, dir:string, hint:string}}
- */
-export function resolveTargetDir(item, opts = {}, cfg = loadConfig()) {
-  const target = (opts.target || cfg.target || 'generic').toLowerCase();
-  const key = slugify(item.name || item.id || `item-${item.number}`);
-
-  if (target === 'ai-editor' || target === 'ai' || target === 'editor') {
-    const editor = (opts.editor || cfg.editor || 'opencode').toLowerCase();
-    const preset = cfg.targets?.aiEditor?.[editor];
-    if (!preset) {
-      throw new Error(`未知编辑器 ${editor}（支持 opencode / claude），可用 dxkj config set targets.aiEditor.${editor}.base <路径> 自定义`);
-    }
-    const sub = preset.map?.[item.kind] || item.kind || 'misc';
-    const base = expandHome(preset.base);
-    return {
-      target: 'ai-editor',
-      dir: path.join(base, sub, key),
-      hint: `${editor}:${sub}`
-    };
-  }
-
-  if (target === 'navlink') {
-    const dirBase = expandHome(opts.dir || cfg.targets?.navlink?.pluginsDir);
-    if (!dirBase) throw new Error('navlink 目标未配置安装目录，请用 --dir <NavLink 的 plugins 目录> 或 dxkj config set targets.navlink.pluginsDir <路径>');
-    return { target: 'navlink', dir: path.join(dirBase, key), hint: 'navlink:plugins' };
-  }
-
-  if (target === 'generic') {
-    const base = expandHome(opts.dir || cfg.targets?.generic?.dir);
-    if (!base) throw new Error('generic 目标未配置目录，请用 --dir <目标目录> 或 dxkj config set targets.generic.dir <路径>');
-    return { target: 'generic', dir: path.join(base, key), hint: 'generic' };
-  }
-
-  throw new Error(`未知 target：${target}（支持 ai-editor / navlink / generic）`);
-}
+import path from 'node:path';
+import { loadConfig, expandHome } from './config.js';
+
+/** 把 id/名称转成安全的目录名 */
+export function slugify(str) {
+  return String(str || '')
+    .replace(/@v?/g, '-v')
+    .replace(/[^a-zA-Z0-9._-]+/g, '-')
+    .replace(/^-+|-+$/g, '')
+    .toLowerCase();
+}
+
+/**
+ * 解析某条目在指定 target 下的安装目录。
+ * target 三种：ai-editor | navlink | generic
+ * @returns {{target:string, dir:string, hint:string}}
+ */
+export function resolveTargetDir(item, opts = {}, cfg = loadConfig()) {
+  const target = (opts.target || cfg.target || 'generic').toLowerCase();
+  const key = slugify(item.name || item.id || `item-${item.number}`);
+
+  if (target === 'ai-editor' || target === 'ai' || target === 'editor') {
+    const editor = (opts.editor || cfg.editor || 'opencode').toLowerCase();
+    const preset = cfg.targets?.aiEditor?.[editor];
+    if (!preset) {
+      throw new Error(`未知编辑器 ${editor}（支持 opencode / claude），可用 dxkj config set targets.aiEditor.${editor}.base <路径> 自定义`);
+    }
+    const sub = preset.map?.[item.kind] || item.kind || 'misc';
+    const base = expandHome(preset.base);
+    return {
+      target: 'ai-editor',
+      dir: path.join(base, sub, key),
+      hint: `${editor}:${sub}`
+    };
+  }
+
+  if (target === 'navlink') {
+    const dirBase = expandHome(opts.dir || cfg.targets?.navlink?.pluginsDir);
+    if (!dirBase) throw new Error('navlink 目标未配置安装目录，请用 --dir <NavLink 的 plugins 目录> 或 dxkj config set targets.navlink.pluginsDir <路径>');
+    return { target: 'navlink', dir: path.join(dirBase, key), hint: 'navlink:plugins' };
+  }
+
+  if (target === 'generic') {
+    const base = expandHome(opts.dir || cfg.targets?.generic?.dir);
+    if (!base) throw new Error('generic 目标未配置目录，请用 --dir <目标目录> 或 dxkj config set targets.generic.dir <路径>');
+    return { target: 'generic', dir: path.join(base, key), hint: 'generic' };
+  }
+
+  throw new Error(`未知 target：${target}（支持 ai-editor / navlink / generic）`);
+}

package/src/lib/validator.js

@@ -1,84 +1,84 @@
-/**
- * 收录.md 规范 Linter
- * 依据：Skill & Agent Tool 分类与命名规范 v1.0
- */
-
-const CATEGORY_CODES = ['IR', 'CL', 'CG', 'DO', 'SI', 'ES', 'AC'];
-const KINDS = ['tool', 'skill', 'prompt', 'agent', 'plugin'];
-const STATUSES = ['experimental', 'active', 'deprecated', 'archived'];
-const ID_RE = /^(tool|skill|prompt|agent|plugin)\.(IR|CL|CG|DO|SI|ES|AC)\.[a-z0-9_]+(\.[a-z0-9_]+)*@v\d+\.\d+$/;
-const VERSION_RE = /^v?\d+\.\d+$/;
-const CJK_RE = /[\u4e00-\u9fff]/;
-
-/**
- * @param {object} item
- * @returns {{errors: string[], warnings: string[]}}
- */
-export function validateItem(item, { isNew = true } = {}) {
-  const errors = [];
-  const warnings = [];
-  if (!item || typeof item !== 'object') {
-    return { errors: ['条目不是合法对象'], warnings };
-  }
-
-  // 1. id / 命名格式
-  if (!item.id) {
-    errors.push('缺少必填字段 id');
-  } else {
-    if (CJK_RE.test(item.id)) errors.push('id 禁止包含中文');
-    if (!ID_RE.test(item.id)) {
-      errors.push(`id 不符合命名规范：${item.id}（应形如 tool.CL.math_calculator@v1.2 或 skill.CG.ns.name@v1.1）`);
-    } else {
-      const prefix = item.id.split('.')[0];
-      const code = item.id.split('.')[1];
-      if (item.kind && prefix !== item.kind) errors.push(`id 前缀(${prefix})与 kind(${item.kind}) 不一致`);
-      if (!CATEGORY_CODES.includes(code)) errors.push(`分类简写非法：${code}`);
-    }
-  }
-
-  // 2. 必填字段（收录.md 三）
-  for (const f of ['name', 'category', 'description', 'status', 'author']) {
-    if (!item[f] || (typeof item[f] === 'string' && !item[f].trim())) errors.push(`缺少必填字段 ${f}`);
-  }
-  if (isNew) {
-    for (const f of ['created_at', 'updated_at']) {
-      if (!item[f]) warnings.push(`建议补充字段 ${f}`);
-    }
-  }
-
-  // 3. kind
-  if (item.kind && !KINDS.includes(item.kind)) errors.push(`kind 非法：${item.kind}（应为 ${KINDS.join('/')}）`);
-
-  // 4. status 生命周期
-  if (item.status && !STATUSES.includes(item.status)) errors.push(`status 非法：${item.status}（应为 ${STATUSES.join('/')}）`);
-  if (item.status === 'deprecated' && !item.deprecated_reason) errors.push('status=deprecated 时必须填写 deprecated_reason');
-  if (item.deprecated_reason && item.status !== 'deprecated') warnings.push('存在 deprecated_reason 但 status 不是 deprecated');
-
-  // 5. 版本号
-  if (item.version && !VERSION_RE.test(String(item.version))) warnings.push(`version 格式建议为 major.minor：${item.version}`);
-
-  // 6. tags
-  if (item.tags != null && !Array.isArray(item.tags)) errors.push('tags 必须是字符串数组');
-  if (Array.isArray(item.tags) && item.tags.some((t) => typeof t !== 'string')) errors.push('tags 必须是字符串数组');
-
-  // 7. 展示区（本需求）
-  if (item.images != null && !Array.isArray(item.images)) errors.push('images 必须是数组');
-  if (item.intro == null || item.intro === '') warnings.push('建议补充简介 intro（展示页简介区）');
-
-  // 8. 安装源
-  const install = item.install || {};
-  if (!install.url) warnings.push('缺少安装包地址 install.url，CLI 将无法安装');
-
-  return { errors, warnings };
-}
-
-export function formatReport(name, { errors, warnings }) {
-  const lines = [];
-  if (errors.length === 0 && warnings.length === 0) {
-    lines.push(`✓ ${name} 校验通过`);
-    return { ok: true, text: lines.join('\n') };
-  }
-  for (const e of errors) lines.push(`✗ [错误] ${e}`);
-  for (const w of warnings) lines.push(`! [警告] ${w}`);
-  return { ok: errors.length === 0, text: lines.join('\n') };
-}
+/**
+ * 收录.md 规范 Linter
+ * 依据：Skill & Agent Tool 分类与命名规范 v1.0
+ */
+
+const CATEGORY_CODES = ['IR', 'CL', 'CG', 'DO', 'SI', 'ES', 'AC'];
+const KINDS = ['tool', 'skill', 'prompt', 'agent', 'plugin'];
+const STATUSES = ['experimental', 'active', 'deprecated', 'archived'];
+const ID_RE = /^(tool|skill|prompt|agent|plugin)\.(IR|CL|CG|DO|SI|ES|AC)\.[a-z0-9_]+(\.[a-z0-9_]+)*@v\d+\.\d+$/;
+const VERSION_RE = /^v?\d+\.\d+$/;
+const CJK_RE = /[\u4e00-\u9fff]/;
+
+/**
+ * @param {object} item
+ * @returns {{errors: string[], warnings: string[]}}
+ */
+export function validateItem(item, { isNew = true } = {}) {
+  const errors = [];
+  const warnings = [];
+  if (!item || typeof item !== 'object') {
+    return { errors: ['条目不是合法对象'], warnings };
+  }
+
+  // 1. id / 命名格式
+  if (!item.id) {
+    errors.push('缺少必填字段 id');
+  } else {
+    if (CJK_RE.test(item.id)) errors.push('id 禁止包含中文');
+    if (!ID_RE.test(item.id)) {
+      errors.push(`id 不符合命名规范：${item.id}（应形如 tool.CL.math_calculator@v1.2 或 skill.CG.ns.name@v1.1）`);
+    } else {
+      const prefix = item.id.split('.')[0];
+      const code = item.id.split('.')[1];
+      if (item.kind && prefix !== item.kind) errors.push(`id 前缀(${prefix})与 kind(${item.kind}) 不一致`);
+      if (!CATEGORY_CODES.includes(code)) errors.push(`分类简写非法：${code}`);
+    }
+  }
+
+  // 2. 必填字段（收录.md 三）
+  for (const f of ['name', 'category', 'description', 'status', 'author']) {
+    if (!item[f] || (typeof item[f] === 'string' && !item[f].trim())) errors.push(`缺少必填字段 ${f}`);
+  }
+  if (isNew) {
+    for (const f of ['created_at', 'updated_at']) {
+      if (!item[f]) warnings.push(`建议补充字段 ${f}`);
+    }
+  }
+
+  // 3. kind
+  if (item.kind && !KINDS.includes(item.kind)) errors.push(`kind 非法：${item.kind}（应为 ${KINDS.join('/')}）`);
+
+  // 4. status 生命周期
+  if (item.status && !STATUSES.includes(item.status)) errors.push(`status 非法：${item.status}（应为 ${STATUSES.join('/')}）`);
+  if (item.status === 'deprecated' && !item.deprecated_reason) errors.push('status=deprecated 时必须填写 deprecated_reason');
+  if (item.deprecated_reason && item.status !== 'deprecated') warnings.push('存在 deprecated_reason 但 status 不是 deprecated');
+
+  // 5. 版本号
+  if (item.version && !VERSION_RE.test(String(item.version))) warnings.push(`version 格式建议为 major.minor：${item.version}`);
+
+  // 6. tags
+  if (item.tags != null && !Array.isArray(item.tags)) errors.push('tags 必须是字符串数组');
+  if (Array.isArray(item.tags) && item.tags.some((t) => typeof t !== 'string')) errors.push('tags 必须是字符串数组');
+
+  // 7. 展示区（本需求）
+  if (item.images != null && !Array.isArray(item.images)) errors.push('images 必须是数组');
+  if (item.intro == null || item.intro === '') warnings.push('建议补充简介 intro（展示页简介区）');
+
+  // 8. 安装源
+  const install = item.install || {};
+  if (!install.url) warnings.push('缺少安装包地址 install.url，CLI 将无法安装');
+
+  return { errors, warnings };
+}
+
+export function formatReport(name, { errors, warnings }) {
+  const lines = [];
+  if (errors.length === 0 && warnings.length === 0) {
+    lines.push(`✓ ${name} 校验通过`);
+    return { ok: true, text: lines.join('\n') };
+  }
+  for (const e of errors) lines.push(`✗ [错误] ${e}`);
+  for (const w of warnings) lines.push(`! [警告] ${w}`);
+  return { ok: errors.length === 0, text: lines.join('\n') };
+}

package/src/lib/version.js

@@ -0,0 +1,8 @@
+import { readFileSync } from 'node:fs';
+
+/** 版本号唯一来源：package.json，避免与硬编码漂移 */
+export const VERSION = JSON.parse(
+  readFileSync(new URL('../../package.json', import.meta.url), 'utf-8')
+).version;
+
+export const USER_AGENT = `dxkj-cli/${VERSION}`;

package/src/opencode.js

@@ -1,71 +1,71 @@
-import { execFile } from 'node:child_process';
-
-/**
- * opencode 插件壳
- * 注册方式（opencode.json）：{ "plugin": ["dxkj"] }
- * 该模块即包的默认导出（package.json 的 main/exports["."]）。
- */
-
-async function tryToolHelper() {
-  try {
-    const mod = await import('@opencode-ai/plugin');
-    return mod.tool || null;
-  } catch {
-    return null;
-  }
-}
-
-function runCli(args) {
-  return new Promise((resolve) => {
-    execFile('npx', ['-y', 'dxkj', ...args], { timeout: 120000, maxBuffer: 10 * 1024 * 1024 }, (err, stdout, stderr) => {
-      const out = (stdout || '').toString().trim();
-      const errText = (stderr || '').toString().trim();
-      if (err && !out) resolve(errText || err.message);
-      else resolve([out, errText].filter(Boolean).join('\n'));
-    });
-  });
-}
-
-export async function dxkjPlugin() {
-  const tool = await tryToolHelper();
-  const schema = tool?.schema;
-  const def = (spec) => (tool ? tool(spec) : spec);
-
-  const tools = {
-    dxkj_catalog: def({
-      description: 'List or search the dxkj catalog of prompts/skills/agents/plugins/tools by keyword and/or kind.',
-      args: schema
-        ? { keyword: schema.string().optional(), kind: schema.string().optional() }
-        : { keyword: { type: 'string' }, kind: { type: 'string' } },
-      execute: async (args = {}) => {
-        const cliArgs = ['list'];
-        if (args.kind) cliArgs.push('--kind', String(args.kind));
-        const out = await runCli(cliArgs);
-        if (!args.keyword) return out;
-        const kw = String(args.keyword).toLowerCase();
-        return out
-          .split(/\r?\n/)
-          .filter((line) => line.toLowerCase().includes(kw) || /^\s*\d+\s/.test(line))
-          .join('\n');
-      }
-    }),
-    dxkj_install: def({
-      description: 'Install one or more catalog items by number/id using the dxkj CLI.',
-      args: schema
-        ? { refs: schema.string().describe('逗号分隔的编号或 id，例如 "3,7"'), target: schema.string().optional(), dir: schema.string().optional() }
-        : { refs: { type: 'string' }, target: { type: 'string' }, dir: { type: 'string' } },
-      execute: async (args = {}) => {
-        const refs = String(args.refs || '').split(',').map((s) => s.trim()).filter(Boolean);
-        if (refs.length === 0) return '请提供编号，例如 refs="3,7"';
-        const cliArgs = ['install', ...refs];
-        if (args.target) cliArgs.push('--target', String(args.target));
-        if (args.dir) cliArgs.push('--dir', String(args.dir));
-        return runCli(cliArgs);
-      }
-    })
-  };
-
-  return { tool: tools };
-}
-
-export default dxkjPlugin;
+import { execFile } from 'node:child_process';
+
+/**
+ * opencode 插件壳
+ * 注册方式（opencode.json）：{ "plugin": ["dxkj"] }
+ * 该模块即包的默认导出（package.json 的 main/exports["."]）。
+ */
+
+async function tryToolHelper() {
+  try {
+    const mod = await import('@opencode-ai/plugin');
+    return mod.tool || null;
+  } catch {
+    return null;
+  }
+}
+
+function runCli(args) {
+  return new Promise((resolve) => {
+    execFile('npx', ['-y', 'dxkj', ...args], { timeout: 120000, maxBuffer: 10 * 1024 * 1024 }, (err, stdout, stderr) => {
+      const out = (stdout || '').toString().trim();
+      const errText = (stderr || '').toString().trim();
+      if (err && !out) resolve(errText || err.message);
+      else resolve([out, errText].filter(Boolean).join('\n'));
+    });
+  });
+}
+
+export async function dxkjPlugin() {
+  const tool = await tryToolHelper();
+  const schema = tool?.schema;
+  const def = (spec) => (tool ? tool(spec) : spec);
+
+  const tools = {
+    dxkj_catalog: def({
+      description: 'List or search the dxkj catalog of prompts/skills/agents/plugins/tools by keyword and/or kind.',
+      args: schema
+        ? { keyword: schema.string().optional(), kind: schema.string().optional() }
+        : { keyword: { type: 'string' }, kind: { type: 'string' } },
+      execute: async (args = {}) => {
+        const cliArgs = ['list'];
+        if (args.kind) cliArgs.push('--kind', String(args.kind));
+        const out = await runCli(cliArgs);
+        if (!args.keyword) return out;
+        const kw = String(args.keyword).toLowerCase();
+        return out
+          .split(/\r?\n/)
+          .filter((line) => line.toLowerCase().includes(kw) || /^\s*\d+\s/.test(line))
+          .join('\n');
+      }
+    }),
+    dxkj_install: def({
+      description: 'Install one or more catalog items by number/id using the dxkj CLI.',
+      args: schema
+        ? { refs: schema.string().describe('逗号分隔的编号或 id，例如 "3,7"'), target: schema.string().optional(), dir: schema.string().optional() }
+        : { refs: { type: 'string' }, target: { type: 'string' }, dir: { type: 'string' } },
+      execute: async (args = {}) => {
+        const refs = String(args.refs || '').split(',').map((s) => s.trim()).filter(Boolean);
+        if (refs.length === 0) return '请提供编号，例如 refs="3,7"';
+        const cliArgs = ['install', ...refs];
+        if (args.target) cliArgs.push('--target', String(args.target));
+        if (args.dir) cliArgs.push('--dir', String(args.dir));
+        return runCli(cliArgs);
+      }
+    })
+  };
+
+  return { tool: tools };
+}
+
+export default dxkjPlugin;