@sk8metal/michi-cli 0.0.1 → 0.0.3

package/scripts/__tests__/validate-phase.test.ts

@@ -0,0 +1,185 @@
+/**
+ * validate-phase.ts の単体テスト
+ */
+
+import { describe, it, expect, beforeEach, vi } from 'vitest';
+import { existsSync, readFileSync } from 'fs';
+import { validatePhase } from '../validate-phase.js';
+
+// fsモジュールのモック
+vi.mock('fs', () => ({
+  existsSync: vi.fn(),
+  readFileSync: vi.fn()
+}));
+
+// project-metaのモック
+vi.mock('../utils/project-meta.js', () => ({
+  loadProjectMeta: vi.fn(() => ({
+    projectId: 'test-project',
+    projectName: 'テストプロジェクト',
+    jiraProjectKey: 'TEST'
+  }))
+}));
+
+describe('validatePhase', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  describe('基本動作', () => {
+    it('すべての必須項目が揃っている場合、validationが成功する', () => {
+      // Arrange: requirementsフェーズを代表例としてテスト
+      vi.mocked(existsSync).mockReturnValue(true);
+      vi.mocked(readFileSync).mockReturnValue(JSON.stringify({
+        confluence: {
+          spaceKey: 'TEST',
+          requirementsPageId: '12345'
+        },
+        milestones: {
+          requirements: {
+            completed: true
+          }
+        }
+      }));
+
+      // Act
+      const result = validatePhase('test-feature', 'requirements');
+
+      // Assert
+      expect(result.valid).toBe(true);
+      expect(result.errors).toHaveLength(0);
+      expect(result.phase).toBe('requirements');
+    });
+
+    it('Confluenceページが作成されていない場合、エラーを返す', () => {
+      // Arrange
+      vi.mocked(existsSync).mockReturnValue(true);
+      vi.mocked(readFileSync).mockReturnValue(JSON.stringify({
+        confluence: {
+          spaceKey: 'TEST'
+          // requirementsPageId が存在しない
+        }
+      }));
+
+      // Act
+      const result = validatePhase('test-feature', 'requirements');
+
+      // Assert
+      expect(result.valid).toBe(false);
+      expect(result.errors).toContain('❌ Confluenceページ（要件定義）が作成されていません');
+    });
+  });
+
+  describe('フェーズ固有の検証', () => {
+    it('designフェーズ: 前提条件（requirements完了）をチェックする', () => {
+      // Arrange
+      vi.mocked(existsSync).mockReturnValue(true);
+      vi.mocked(readFileSync).mockReturnValue(JSON.stringify({
+        confluence: {
+          designPageId: '67890'
+        },
+        milestones: {
+          requirements: {
+            completed: false // 前提条件が満たされていない
+          }
+        }
+      }));
+
+      // Act
+      const result = validatePhase('test-feature', 'design');
+
+      // Assert
+      expect(result.valid).toBe(false);
+      expect(result.errors).toContain('❌ 要件定義が完了していません（前提条件）');
+    });
+
+    it('tasksフェーズ: JIRA Epic/Story作成をチェックする', () => {
+      // Arrange
+      vi.mocked(existsSync).mockReturnValue(true);
+      vi.mocked(readFileSync).mockImplementation((path) => {
+        if (String(path).includes('tasks.md')) {
+          return '11/06（木）Day 1';
+        }
+        return JSON.stringify({
+          milestones: {
+            design: {
+              completed: true
+            }
+          },
+          jira: {
+            // epicKey が存在しない（重要なチェック）
+          }
+        });
+      });
+
+      // Act
+      const result = validatePhase('test-feature', 'tasks');
+
+      // Assert
+      expect(result.valid).toBe(false);
+      expect(result.errors).toContain('❌ JIRA Epicが作成されていません');
+    });
+
+    it('tasksフェーズ: 営業日表記をチェックする（重要な独自機能）', () => {
+      // Arrange
+      vi.mocked(existsSync).mockReturnValue(true);
+      vi.mocked(readFileSync).mockImplementation((path) => {
+        if (String(path).includes('tasks.md')) {
+          return 'タスク一覧（曜日表記なし）'; // 営業日表記がない
+        }
+        return JSON.stringify({
+          milestones: {
+            design: {
+              completed: true
+            }
+          },
+          jira: {
+            epicKey: 'TEST-1',
+            stories: {
+              created: 5,
+              total: 5
+            }
+          }
+        });
+      });
+
+      // Act
+      const result = validatePhase('test-feature', 'tasks');
+
+      // Assert
+      expect(result.valid).toBe(true); // 警告だけなのでvalid
+      expect(result.warnings).toContain('⚠️  tasks.mdに曜日表記（月、火、水...）が含まれていません');
+    });
+  });
+
+  describe('エッジケース', () => {
+    it('spec.jsonが存在しない場合、エラーを返す', () => {
+      // Arrange
+      // requirements.mdは存在するが、spec.jsonは存在しない
+      vi.mocked(existsSync).mockImplementation((path: string | Buffer | URL) => {
+        const pathStr = typeof path === 'string' ? path : path instanceof URL ? path.pathname : path.toString();
+        if (pathStr.includes('requirements.md')) {
+          return true;
+        }
+        if (pathStr.includes('spec.json')) {
+          return false;
+        }
+        return false;
+      });
+
+      // Act
+      const result = validatePhase('test-feature', 'requirements');
+
+      // Assert: エラーをスローせず、errors配列にエラーを含めて返す
+      expect(result.valid).toBe(false);
+      expect(result.errors).toContainEqual(expect.stringContaining('spec.json読み込みエラー'));
+      expect(result.errors).toContainEqual(expect.stringContaining('spec.json not found'));
+    });
+
+    it('不正なフェーズ名の場合、エラーをスローする', () => {
+      // Act & Assert
+      expect(() => validatePhase('test-feature', 'invalid' as any)).toThrow('Unknown phase: invalid');
+    });
+  });
+});
+

package/scripts/config/config-schema.ts

@@ -0,0 +1,130 @@
+/**
+ * 設定スキーマ定義
+ * Zodを使用して設定ファイルの型安全性を保証
+ */
+
+import { z } from 'zod';
+
+/**
+ * Confluence階層構造のモード
+ */
+export const ConfluenceHierarchyModeSchema = z.enum(['simple', 'nested']);
+
+/**
+ * Confluenceページ作成粒度
+ */
+export const ConfluencePageCreationGranularitySchema = z.enum([
+  'single',
+  'by-section',
+  'by-hierarchy',
+  'manual'
+]);
+
+/**
+ * Confluence階層構造設定（by-hierarchyまたはmanualの場合）
+ */
+export const ConfluenceHierarchyStructureSchema = z.object({
+  mode: ConfluenceHierarchyModeSchema.optional(),
+  parentPageTitle: z.string().optional(),
+  createDocTypeParents: z.boolean().optional(),
+  structure: z.record(
+    z.string(),
+    z.object({
+      parent: z.string().optional(),
+      title: z.string().optional(),
+      children: z.array(
+        z.object({
+          section: z.string(),
+          title: z.string()
+        })
+      ).optional(),
+      pages: z.array(
+        z.object({
+          title: z.string(),
+          sections: z.array(z.string()),
+          labels: z.array(z.string()).optional()
+        })
+      ).optional()
+    })
+  ).optional()
+});
+
+/**
+ * Confluence設定スキーマ
+ */
+export const ConfluenceConfigSchema = z.object({
+  pageCreationGranularity: ConfluencePageCreationGranularitySchema.default('single'),
+  pageTitleFormat: z.string().default('[{projectName}] {featureName} {docTypeLabel}'),
+  autoLabels: z.array(z.string()).default(['{projectLabel}', '{docType}', '{featureName}', 'github-sync']),
+  spaces: z.object({
+    requirements: z.string().optional(),
+    design: z.string().optional(),
+    tasks: z.string().optional()
+  }).optional(),
+  hierarchy: ConfluenceHierarchyStructureSchema.optional()
+});
+
+/**
+ * JIRA Story作成粒度
+ */
+export const JiraStoryCreationGranularitySchema = z.enum([
+  'all',
+  'by-phase',
+  'selected-phases'
+]);
+
+/**
+ * JIRA Story Points設定
+ */
+export const JiraStoryPointsSchema = z.enum(['auto', 'manual', 'disabled']);
+
+/**
+ * JIRA設定スキーマ
+ */
+export const JiraConfigSchema = z.object({
+  storyCreationGranularity: JiraStoryCreationGranularitySchema.default('all'),
+  createEpic: z.boolean().default(true),
+  storyPoints: JiraStoryPointsSchema.default('auto'),
+  autoLabels: z.array(z.string()).default(['{projectLabel}', '{featureName}', '{phaseLabel}']),
+    issueTypes: z.object({
+      epic: z.string().default('Epic'),
+      story: z.string().nullish().default(null),  // null | undefined | string
+      subtask: z.string().nullish().default(null)  // null | undefined | string
+    }).optional(),
+  selectedPhases: z.array(z.string()).optional()
+});
+
+/**
+ * ワークフロー設定スキーマ
+ */
+export const WorkflowConfigSchema = z.object({
+  enabledPhases: z.array(z.string()).default(['requirements', 'design', 'tasks']),
+  approvalGates: z.object({
+    requirements: z.array(z.string()).optional(),
+    design: z.array(z.string()).optional(),
+    release: z.array(z.string()).optional()
+  }).optional()
+});
+
+/**
+ * 全体設定スキーマ
+ */
+export const AppConfigSchema = z.object({
+  confluence: ConfluenceConfigSchema.optional(),
+  jira: JiraConfigSchema.optional(),
+  workflow: WorkflowConfigSchema.optional()
+});
+
+/**
+ * 設定の型定義
+ */
+export type ConfluenceHierarchyMode = z.infer<typeof ConfluenceHierarchyModeSchema>;
+export type ConfluencePageCreationGranularity = z.infer<typeof ConfluencePageCreationGranularitySchema>;
+export type ConfluenceHierarchyStructure = z.infer<typeof ConfluenceHierarchyStructureSchema>;
+export type ConfluenceConfig = z.infer<typeof ConfluenceConfigSchema>;
+export type JiraStoryCreationGranularity = z.infer<typeof JiraStoryCreationGranularitySchema>;
+export type JiraStoryPoints = z.infer<typeof JiraStoryPointsSchema>;
+export type JiraConfig = z.infer<typeof JiraConfigSchema>;
+export type WorkflowConfig = z.infer<typeof WorkflowConfigSchema>;
+export type AppConfig = z.infer<typeof AppConfigSchema>;
+

package/scripts/config/default-config.json

@@ -0,0 +1,57 @@
+{
+  "confluence": {
+    "pageCreationGranularity": "single",
+    "pageTitleFormat": "[{projectName}] {featureName} {docTypeLabel}",
+    "autoLabels": [
+      "{projectLabel}",
+      "{docType}",
+      "{featureName}",
+      "github-sync"
+    ],
+    "spaces": {
+      "requirements": "${CONFLUENCE_PRD_SPACE}",
+      "design": "${CONFLUENCE_PRD_SPACE}",
+      "tasks": "${CONFLUENCE_PRD_SPACE}"
+    },
+    "hierarchy": {
+      "enabled": false
+    }
+  },
+  "jira": {
+    "storyCreationGranularity": "all",
+    "createEpic": true,
+    "storyPoints": "auto",
+    "autoLabels": [
+      "{projectLabel}",
+      "{featureName}",
+      "{phaseLabel}"
+    ],
+    "issueTypes": {
+      "epic": "Epic",
+      "story": null,
+      "subtask": null
+    }
+  },
+  "workflow": {
+    "enabledPhases": [
+      "requirements",
+      "design",
+      "tasks"
+    ],
+    "approvalGates": {
+      "requirements": [
+        "pm",
+        "director"
+      ],
+      "design": [
+        "architect",
+        "director"
+      ],
+      "release": [
+        "sm",
+        "director"
+      ]
+    }
+  }
+}
+