growork 1.0.1 → 1.1.1

package/src/index.ts

@@ -10,7 +10,7 @@ const program = new Command();
 program
   .name('growork')
   .description('将飞书文档同步到本地，为 AI Agent 提供完整上下文')
-  .version('1.0.0');
+  .version('2.0.0');
 
 program
   .command('init')
@@ -18,9 +18,18 @@ program
   .action(initCommand);
 
 program
-  .command('sync [name]')
-  .description('同步文档，可选指定文档名称')
-  .action(syncCommand);
+  .command('sync')
+  .description('同步文档')
+  .option('--ver <version>', '只同步指定版本')
+  .option('-f, --feature <feature>', '只同步指定 feature')
+  .option('-c, --custom', '只同步全局文档')
+  .action((options) => {
+    // 将 ver 映射到 version
+    if (options.ver) {
+      options.version = options.ver;
+    }
+    syncCommand(options);
+  });
 
 program
   .command('list')

package/src/utils/config.ts

@@ -2,13 +2,6 @@ import * as fs from 'fs';
 import * as path from 'path';
 import * as yaml from 'yaml';
 
-export interface DocConfig {
-  name: string;
-  type: 'feishu' | 'notion';
-  url: string;
-  output: string;
-}
-
 export interface NotionConfig {
   token: string;
 }
@@ -16,13 +9,40 @@ export interface NotionConfig {
 export interface FeishuConfig {
   appId: string;
   appSecret: string;
-  domain?: 'feishu' | 'lark';  // 默认 feishu，国际版用 lark
+  domain?: 'feishu' | 'lark';
 }
+export type DocInput = string | { url: string; name?: string };
+
+export type FeatureValue = DocInput[] | {
+  prd?: DocInput[];
+  design?: DocInput[];
+  api?: DocInput[];
+  test?: DocInput[];
+};
 
-export interface GroworkConfig {
+export interface GroworkConfigV2 {
   feishu?: FeishuConfig;
   notion?: NotionConfig;
-  docs: DocConfig[];
+  outputDir?: string;  // 输出根目录，默认 "docs"
+  custom?: DocInput[];
+  versions?: {
+    [version: string]: {
+      [feature: string]: FeatureValue;
+    };
+  };
+}
+
+export interface NormalizedDoc {
+  url: string;
+  name?: string;
+  type: 'feishu' | 'notion';
+  outputPath: string;  // 含 {title} 占位符
+}
+
+export interface SyncOptions {
+  version?: string;
+  feature?: string;
+  custom?: boolean;
 }
 
 const CONFIG_FILE_NAME = 'growork.config.yaml';
@@ -35,38 +55,122 @@ export function configExists(): boolean {
   return fs.existsSync(getConfigPath());
 }
 
-export function loadConfig(): GroworkConfig {
-  const configPath = getConfigPath();
+export function inferDocType(url: string): 'feishu' | 'notion' {
+  if (url.includes('feishu.cn') || url.includes('larksuite.com')) {
+    return 'feishu';
+  }
+  if (url.includes('notion.so') || url.includes('notion.site')) {
+    return 'notion';
+  }
+  throw new Error(`无法从 URL 推断文档类型: ${url}`);
+}
 
-  if (!fs.existsSync(configPath)) {
-    throw new Error(`配置文件不存在: ${configPath}\n请先运行 growork init 初始化配置`);
+export function sanitizeFileName(title: string): string {
+  return title
+    .replace(/[\/\\:*?"<>|]/g, '')  // 移除文件系统保留字符
+    .replace(/\s+/g, '-')           // 空格替换为 -
+    .replace(/-+/g, '-')            // 连续 - 合并
+    .replace(/^-|-$/g, '');         // 首尾 - 去除
+}
+
+export function parseDocInput(input: DocInput): { url: string; name?: string } {
+  if (typeof input === 'string') {
+    return { url: input };
   }
+  return input;
+}
 
-  const content = fs.readFileSync(configPath, 'utf-8');
-  const config = yaml.parse(content) as GroworkConfig;
+function isTypedFeature(value: FeatureValue): value is { prd?: DocInput[]; design?: DocInput[]; api?: DocInput[]; test?: DocInput[] } {
+  return !Array.isArray(value);
+}
+
+export function normalizeConfig(config: GroworkConfigV2, options: SyncOptions = {}): NormalizedDoc[] {
+  const docs: NormalizedDoc[] = [];
+  const outputDir = config.outputDir || 'docs';
+
+  // 处理 custom 文档
+  if (config.custom && (options.custom || (!options.version && !options.feature))) {
+    for (const input of config.custom) {
+      const { url, name } = parseDocInput(input);
+      docs.push({
+        url,
+        name,
+        type: inferDocType(url),
+        outputPath: `${outputDir}/custom/{title}.md`,
+      });
+    }
+  }
+
+  // 如果只请求 custom，直接返回
+  if (options.custom) {
+    return docs;
+  }
 
-  // 验证配置
-  if (!config.docs || config.docs.length === 0) {
-    throw new Error('配置文件中没有配置任何文档');
+  // 处理 versions
+  if (config.versions) {
+    for (const [version, features] of Object.entries(config.versions)) {
+      // 版本过滤
+      if (options.version && options.version !== version) continue;
+
+      for (const [feature, value] of Object.entries(features)) {
+        // feature 过滤
+        if (options.feature && options.feature !== feature) continue;
+
+        if (isTypedFeature(value)) {
+          // 分类型的 feature
+          for (const docType of ['prd', 'design', 'api', 'test'] as const) {
+            const docInputs = value[docType];
+            if (!docInputs) continue;
+
+            for (const input of docInputs) {
+              const { url, name } = parseDocInput(input);
+              docs.push({
+                url,
+                name,
+                type: inferDocType(url),
+                outputPath: `${outputDir}/${version}/${feature}/${docType}/{title}.md`,
+              });
+            }
+          }
+        } else {
+          // 简单 feature（数组形式）
+          for (const input of value) {
+            const { url, name } = parseDocInput(input);
+            docs.push({
+              url,
+              name,
+              type: inferDocType(url),
+              outputPath: `${outputDir}/${version}/${feature}/{title}.md`,
+            });
+          }
+        }
+      }
+    }
   }
 
-  // 检查文档类型所需的凭证
-  const hasFeishuDocs = config.docs.some(d => d.type === 'feishu');
-  const hasNotionDocs = config.docs.some(d => d.type === 'notion');
+  return docs;
+}
+
+export function loadConfigV2(): GroworkConfigV2 {
+  const configPath = getConfigPath();
 
-  if (hasFeishuDocs && (!config.feishu?.appId || !config.feishu?.appSecret)) {
-    throw new Error('配置文件缺少飞书凭证 (feishu.appId, feishu.appSecret)');
+  if (!fs.existsSync(configPath)) {
+    throw new Error(`配置文件不存在: ${configPath}\n请先运行 growork init 初始化配置`);
   }
 
-  if (hasNotionDocs && !config.notion?.token) {
-    throw new Error('配置文件缺少 Notion 凭证 (notion.token)');
+  const content = fs.readFileSync(configPath, 'utf-8');
+  const config = yaml.parse(content) as GroworkConfigV2;
+
+  // v2.0 至少需要 custom 或 versions
+  if (!config.custom && !config.versions) {
+    throw new Error('配置文件中没有配置任何文档（custom 或 versions）');
   }
 
   return config;
 }
 
 export function getDefaultConfig(): string {
-  return `# Growork 配置文件
+  return `# Growork v2.0 配置文件
 
 # 飞书应用凭证 (使用飞书文档时需要)
 feishu:
@@ -78,18 +182,30 @@ feishu:
 notion:
   token: "ntn_xxxx"  # Notion Integration Token
 
-# 文档同步配置
-docs:
-  # 飞书文档示例
-  - name: prd
-    type: feishu
-    url: "https://xxx.feishu.cn/docx/xxxxx"
-    output: "docs/product/prd.md"
-
-  # Notion 文档示例
-  - name: notion-prd
-    type: notion
-    url: "https://www.notion.so/xxxxx"
-    output: "docs/product/notion-prd.md"
+# 输出根目录（默认 "docs"）
+outputDir: "docs"
+
+# 全局文档（不跟版本）
+custom:
+  - "https://xxx.feishu.cn/docx/xxxxx"        # 最简写法
+  # - url: "https://www.notion.so/xxxxx"
+  #   name: "技术架构"                          # 可选：自定义名称
+
+# 版本化文档
+versions:
+  v1.0:
+    用户登录:
+      prd:
+        - "https://xxx.feishu.cn/docx/xxxxx"
+      # design:
+      #   - "https://xxx.feishu.cn/docx/yyyyy"
+      # api:
+      #   - "https://xxx.feishu.cn/docx/zzzzz"
+      # test:
+      #   - "https://xxx.feishu.cn/docx/aaaaa"
+
+    # 简单 feature 可不分类
+    # 小优化:
+    #   - "https://xxx.feishu.cn/docx/bbbbb"
 `;
 }

package/tests/config.test.ts

@@ -1,10 +1,8 @@
 import { describe, it } from 'node:test';
 import assert from 'node:assert';
-import * as fs from 'fs';
-import * as path from 'path';
 import * as yaml from 'yaml';
 
-// 直接测试配置解析逻辑，不依赖 process.cwd()
+// ============ V1.0 配置类型（用于兼容性测试）============
 interface DocConfig {
   name: string;
   type: 'feishu' | 'notion';
@@ -35,6 +33,130 @@ function validateConfig(config: GroworkConfig): void {
   }
 }
 
+// ============ V2.0 配置类型和函数（从 config.ts 复制）============
+type DocInput = string | { url: string; name?: string };
+
+type FeatureValue = DocInput[] | {
+  prd?: DocInput[];
+  design?: DocInput[];
+  api?: DocInput[];
+  test?: DocInput[];
+};
+
+interface GroworkConfigV2 {
+  feishu?: { appId: string; appSecret: string; domain?: 'feishu' | 'lark' };
+  notion?: { token: string };
+  outputDir?: string;
+  custom?: DocInput[];
+  versions?: {
+    [version: string]: {
+      [feature: string]: FeatureValue;
+    };
+  };
+}
+
+interface NormalizedDoc {
+  url: string;
+  name?: string;
+  type: 'feishu' | 'notion';
+  outputPath: string;
+}
+
+interface SyncOptions {
+  version?: string;
+  feature?: string;
+  custom?: boolean;
+}
+
+function inferDocType(url: string): 'feishu' | 'notion' {
+  if (url.includes('feishu.cn') || url.includes('larksuite.com')) {
+    return 'feishu';
+  }
+  if (url.includes('notion.so') || url.includes('notion.site')) {
+    return 'notion';
+  }
+  throw new Error(`无法从 URL 推断文档类型: ${url}`);
+}
+
+function sanitizeFileName(title: string): string {
+  return title
+    .replace(/[\/\\:*?"<>|]/g, '')
+    .replace(/\s+/g, '-')
+    .replace(/-+/g, '-')
+    .replace(/^-|-$/g, '');
+}
+
+function parseDocInput(input: DocInput): { url: string; name?: string } {
+  if (typeof input === 'string') {
+    return { url: input };
+  }
+  return input;
+}
+
+function isTypedFeature(value: FeatureValue): value is { prd?: DocInput[]; design?: DocInput[]; api?: DocInput[]; test?: DocInput[] } {
+  return !Array.isArray(value);
+}
+
+function normalizeConfig(config: GroworkConfigV2, options: SyncOptions = {}): NormalizedDoc[] {
+  const docs: NormalizedDoc[] = [];
+  const outputDir = config.outputDir || 'docs';
+
+  if (config.custom && (options.custom || (!options.version && !options.feature))) {
+    for (const input of config.custom) {
+      const { url, name } = parseDocInput(input);
+      docs.push({
+        url,
+        name,
+        type: inferDocType(url),
+        outputPath: `${outputDir}/custom/{title}.md`,
+      });
+    }
+  }
+
+  if (options.custom) {
+    return docs;
+  }
+
+  if (config.versions) {
+    for (const [version, features] of Object.entries(config.versions)) {
+      if (options.version && options.version !== version) continue;
+
+      for (const [feature, value] of Object.entries(features)) {
+        if (options.feature && options.feature !== feature) continue;
+
+        if (isTypedFeature(value)) {
+          for (const docType of ['prd', 'design', 'api', 'test'] as const) {
+            const docInputs = value[docType];
+            if (!docInputs) continue;
+
+            for (const input of docInputs) {
+              const { url, name } = parseDocInput(input);
+              docs.push({
+                url,
+                name,
+                type: inferDocType(url),
+                outputPath: `${outputDir}/${version}/${feature}/${docType}/{title}.md`,
+              });
+            }
+          }
+        } else {
+          for (const input of value) {
+            const { url, name } = parseDocInput(input);
+            docs.push({
+              url,
+              name,
+              type: inferDocType(url),
+              outputPath: `${outputDir}/${version}/${feature}/{title}.md`,
+            });
+          }
+        }
+      }
+    }
+  }
+
+  return docs;
+}
+
 describe('配置文件解析', () => {
   it('应正确解析有效的 YAML 配置', () => {
     const yamlContent = `
@@ -184,3 +306,250 @@ describe('配置文件验证', () => {
     );
   });
 });
+
+// ============ V2.0 配置测试 ============
+
+describe('文档类型推断', () => {
+  it('应识别飞书 feishu.cn URL', () => {
+    assert.strictEqual(inferDocType('https://xxx.feishu.cn/docx/abc123'), 'feishu');
+  });
+
+  it('应识别飞书 larksuite.com URL', () => {
+    assert.strictEqual(inferDocType('https://xxx.larksuite.com/docx/abc123'), 'feishu');
+  });
+
+  it('应识别 Notion notion.so URL', () => {
+    assert.strictEqual(inferDocType('https://www.notion.so/abc123'), 'notion');
+  });
+
+  it('应识别 Notion notion.site URL', () => {
+    assert.strictEqual(inferDocType('https://myworkspace.notion.site/abc123'), 'notion');
+  });
+
+  it('应拒绝未知域名', () => {
+    assert.throws(
+      () => inferDocType('https://example.com/doc/123'),
+      /无法从 URL 推断文档类型/
+    );
+  });
+});
+
+describe('文件名清理', () => {
+  it('应移除文件系统保留字符', () => {
+    assert.strictEqual(sanitizeFileName('test/file:name'), 'testfilename');
+  });
+
+  it('应将空格替换为连字符', () => {
+    assert.strictEqual(sanitizeFileName('hello world'), 'hello-world');
+  });
+
+  it('应合并连续空格为单个连字符', () => {
+    assert.strictEqual(sanitizeFileName('hello   world'), 'hello-world');
+  });
+
+  it('应移除首尾连字符', () => {
+    assert.strictEqual(sanitizeFileName(' hello world '), 'hello-world');
+  });
+
+  it('应处理复杂标题', () => {
+    assert.strictEqual(sanitizeFileName('PRD: 用户登录 v1.0'), 'PRD-用户登录-v1.0');
+  });
+
+  it('应处理只有特殊字符的情况', () => {
+    assert.strictEqual(sanitizeFileName('***'), '');
+  });
+});
+
+describe('文档输入解析', () => {
+  it('应解析字符串输入', () => {
+    const result = parseDocInput('https://xxx.feishu.cn/docx/abc');
+    assert.deepStrictEqual(result, { url: 'https://xxx.feishu.cn/docx/abc' });
+  });
+
+  it('应解析对象输入（只有 url）', () => {
+    const result = parseDocInput({ url: 'https://xxx.feishu.cn/docx/abc' });
+    assert.deepStrictEqual(result, { url: 'https://xxx.feishu.cn/docx/abc' });
+  });
+
+  it('应解析对象输入（带 name）', () => {
+    const result = parseDocInput({ url: 'https://xxx.feishu.cn/docx/abc', name: '产品文档' });
+    assert.deepStrictEqual(result, { url: 'https://xxx.feishu.cn/docx/abc', name: '产品文档' });
+  });
+});
+
+describe('V2.0 配置规范化', () => {
+  it('应处理 custom 文档', () => {
+    const config: GroworkConfigV2 = {
+      custom: ['https://xxx.feishu.cn/docx/abc123']
+    };
+    const docs = normalizeConfig(config);
+
+    assert.strictEqual(docs.length, 1);
+    assert.strictEqual(docs[0].url, 'https://xxx.feishu.cn/docx/abc123');
+    assert.strictEqual(docs[0].type, 'feishu');
+    assert.strictEqual(docs[0].outputPath, 'docs/custom/{title}.md');
+  });
+
+  it('应处理带 name 的 custom 文档', () => {
+    const config: GroworkConfigV2 = {
+      custom: [{ url: 'https://www.notion.so/abc123', name: '技术架构' }]
+    };
+    const docs = normalizeConfig(config);
+
+    assert.strictEqual(docs.length, 1);
+    assert.strictEqual(docs[0].name, '技术架构');
+    assert.strictEqual(docs[0].type, 'notion');
+  });
+
+  it('应处理 versions 中的简单 feature', () => {
+    const config: GroworkConfigV2 = {
+      versions: {
+        'v1.0': {
+          '用户登录': ['https://xxx.feishu.cn/docx/abc']
+        }
+      }
+    };
+    const docs = normalizeConfig(config);
+
+    assert.strictEqual(docs.length, 1);
+    assert.strictEqual(docs[0].outputPath, 'docs/v1.0/用户登录/{title}.md');
+  });
+
+  it('应处理 versions 中的分类型 feature', () => {
+    const config: GroworkConfigV2 = {
+      versions: {
+        'v1.0': {
+          '用户登录': {
+            prd: ['https://xxx.feishu.cn/docx/prd'],
+            design: ['https://xxx.feishu.cn/docx/design'],
+            api: ['https://xxx.feishu.cn/docx/api']
+          }
+        }
+      }
+    };
+    const docs = normalizeConfig(config);
+
+    assert.strictEqual(docs.length, 3);
+    assert.strictEqual(docs[0].outputPath, 'docs/v1.0/用户登录/prd/{title}.md');
+    assert.strictEqual(docs[1].outputPath, 'docs/v1.0/用户登录/design/{title}.md');
+    assert.strictEqual(docs[2].outputPath, 'docs/v1.0/用户登录/api/{title}.md');
+  });
+
+  it('应支持自定义 outputDir', () => {
+    const config: GroworkConfigV2 = {
+      outputDir: 'output',
+      custom: ['https://xxx.feishu.cn/docx/abc']
+    };
+    const docs = normalizeConfig(config);
+
+    assert.strictEqual(docs[0].outputPath, 'output/custom/{title}.md');
+  });
+
+  it('应支持 version 过滤', () => {
+    const config: GroworkConfigV2 = {
+      versions: {
+        'v1.0': { 'feat1': ['https://xxx.feishu.cn/docx/1'] },
+        'v2.0': { 'feat2': ['https://xxx.feishu.cn/docx/2'] }
+      }
+    };
+    const docs = normalizeConfig(config, { version: 'v1.0' });
+
+    assert.strictEqual(docs.length, 1);
+    assert.ok(docs[0].outputPath.includes('v1.0'));
+  });
+
+  it('应支持 feature 过滤', () => {
+    const config: GroworkConfigV2 = {
+      versions: {
+        'v1.0': {
+          '登录': ['https://xxx.feishu.cn/docx/1'],
+          '注册': ['https://xxx.feishu.cn/docx/2']
+        }
+      }
+    };
+    const docs = normalizeConfig(config, { feature: '登录' });
+
+    assert.strictEqual(docs.length, 1);
+    assert.ok(docs[0].outputPath.includes('登录'));
+  });
+
+  it('应支持 custom 选项（只获取 custom 文档）', () => {
+    const config: GroworkConfigV2 = {
+      custom: ['https://xxx.feishu.cn/docx/custom'],
+      versions: {
+        'v1.0': { 'feat': ['https://xxx.feishu.cn/docx/versioned'] }
+      }
+    };
+    const docs = normalizeConfig(config, { custom: true });
+
+    assert.strictEqual(docs.length, 1);
+    assert.ok(docs[0].outputPath.includes('custom'));
+  });
+
+  it('默认情况下应返回所有文档', () => {
+    const config: GroworkConfigV2 = {
+      custom: ['https://xxx.feishu.cn/docx/custom'],
+      versions: {
+        'v1.0': { 'feat': ['https://xxx.feishu.cn/docx/versioned'] }
+      }
+    };
+    const docs = normalizeConfig(config);
+
+    assert.strictEqual(docs.length, 2);
+  });
+
+  it('应正确处理多版本多 feature', () => {
+    const config: GroworkConfigV2 = {
+      versions: {
+        'v1.0': {
+          'feat1': ['https://xxx.feishu.cn/docx/1'],
+          'feat2': ['https://xxx.feishu.cn/docx/2']
+        },
+        'v2.0': {
+          'feat3': ['https://xxx.feishu.cn/docx/3']
+        }
+      }
+    };
+    const docs = normalizeConfig(config);
+
+    assert.strictEqual(docs.length, 3);
+  });
+});
+
+describe('V2.0 YAML 配置解析', () => {
+  it('应正确解析 V2.0 配置', () => {
+    const yamlContent = `
+feishu:
+  appId: "cli_test"
+  appSecret: "secret_test"
+  domain: "feishu"
+
+outputDir: "docs"
+
+custom:
+  - "https://xxx.feishu.cn/docx/custom1"
+  - url: "https://xxx.feishu.cn/docx/custom2"
+    name: "技术架构"
+
+versions:
+  v1.0:
+    用户登录:
+      prd:
+        - "https://xxx.feishu.cn/docx/prd"
+      api:
+        - "https://xxx.feishu.cn/docx/api"
+    小优化:
+      - "https://xxx.feishu.cn/docx/opt"
+`;
+    const config = yaml.parse(yamlContent) as GroworkConfigV2;
+
+    assert.strictEqual(config.feishu?.appId, 'cli_test');
+    assert.strictEqual(config.feishu?.domain, 'feishu');
+    assert.strictEqual(config.outputDir, 'docs');
+    assert.strictEqual(config.custom?.length, 2);
+    assert.ok(config.versions?.['v1.0']);
+
+    const docs = normalizeConfig(config);
+    assert.strictEqual(docs.length, 5); // 2 custom + 2 分类 + 1 简单
+  });
+});