@sk8metal/michi-cli 0.14.1 → 0.20.0

package/scripts/utils/project-meta.ts

@@ -1,96 +1,13 @@
 /**
  * プロジェクトメタデータ読み込みユーティリティ
- */
-
-import { readFileSync, existsSync } from 'fs';
-import { resolve } from 'path';
-
-export interface ProjectMetadata {
-  projectId: string;
-  projectName: string;
-  jiraProjectKey: string;
-  confluenceLabels: string[];
-  status: 'active' | 'inactive' | 'completed';
-  team: string[];
-  stakeholders: string[];
-  repository: string;
-  description?: string;
-}
-
-/**
- * .kiro/project.json を読み込む
- */
-export function loadProjectMeta(projectRoot: string = process.cwd()): ProjectMetadata {
-  const projectJsonPath = resolve(projectRoot, '.kiro/project.json');
-  
-  if (!existsSync(projectJsonPath)) {
-    throw new Error(`Project metadata not found: ${projectJsonPath}`);
-  }
-  
-  try {
-    const content = readFileSync(projectJsonPath, 'utf-8');
-    const meta = JSON.parse(content) as ProjectMetadata;
-    
-    // 必須フィールドのバリデーション
-    const requiredFields: (keyof ProjectMetadata)[] = [
-      'projectId',
-      'projectName',
-      'jiraProjectKey',
-      'confluenceLabels'
-    ];
-    
-    for (const field of requiredFields) {
-      if (!meta[field]) {
-        throw new Error(`Required field missing in project.json: ${field}`);
-      }
-    }
-    
-    return meta;
-  } catch (error) {
-    if (error instanceof SyntaxError) {
-      throw new Error(`Invalid JSON in ${projectJsonPath}: ${error.message}`);
-    }
-    throw error;
-  }
-}
-
-/**
- * プロジェクトメタデータを表示用にフォーマット
- */
-export function formatProjectInfo(meta: ProjectMetadata): string {
-  return `
-Project: ${meta.projectName} (${meta.projectId})
-JIRA: ${meta.jiraProjectKey}
-Labels: ${meta.confluenceLabels.join(', ')}
-Status: ${meta.status}
-Team: ${meta.team.join(', ')}
-`.trim();
-}
-
-/**
- * GitHub リポジトリ情報を取得
- * repository フィールドから owner/repo 形式を抽出
  *
- * @param projectRoot プロジェクトルートディレクトリ（デフォルト: カレントディレクトリ）
- * @returns owner/repo 形式のリポジトリ情報
- * @throws リポジトリ情報が見つからない、または無効な形式の場合
+ * このファイルは後方互換性のための再エクスポートです。
+ * 実装は src/infrastructure/filesystem/project-meta.ts に移行されました。
  */
-export function getRepositoryInfo(projectRoot: string = process.cwd()): string {
-  const meta = loadProjectMeta(projectRoot);
-
-  if (!meta.repository) {
-    throw new Error('Repository information not found in project.json');
-  }
-
-  // URL形式から owner/repo を抽出
-  // 例: https://github.com/owner/repo.git -> owner/repo
-  // 例: git@github.com:owner/repo.git -> owner/repo
-  const match = meta.repository.match(/github\.com[:/]([\w-]+\/[\w-]+)(\.git)?/);
-
-  if (!match) {
-    throw new Error(`Invalid GitHub repository format: ${meta.repository}`);
-  }
-
-  return match[1];
-}
 
+export type { ProjectMetadata } from '../../src/infrastructure/filesystem/project-meta.js';
+export {
+  loadProjectMeta,
+  formatProjectInfo,
+  getRepositoryInfo,
+} from '../../src/infrastructure/filesystem/project-meta.js';

package/scripts/utils/safe-file-reader.ts

@@ -0,0 +1,158 @@
+/**
+ * safeReadFile - ファイル読み込み処理の統合ユーティリティ
+ * 一貫したエラーハンドリングとResult型を提供
+ */
+
+import { readFileSync, existsSync } from 'fs';
+import type { Result } from './types/validation.js';
+import { success, failure } from './types/validation.js';
+
+/**
+ * JSON value type - represents any valid JSON value
+ */
+export type JsonValue =
+  | string
+  | number
+  | boolean
+  | null
+  | JsonValue[]
+  | { [key: string]: JsonValue };
+
+/**
+ * File read error types
+ */
+export type FileReadError =
+  | { type: 'FileNotFound'; path: string }
+  | { type: 'PermissionDenied'; path: string }
+  | { type: 'InvalidJSON'; path: string; cause: string }
+  | { type: 'ReadError'; path: string; cause: string };
+
+/**
+ * Safe file reader with Result type
+ *
+ * @param filePath - Path to the file to read
+ * @param encoding - File encoding (default: 'utf-8')
+ * @returns Result<string, FileReadError> - File content or error
+ *
+ * @example
+ * ```typescript
+ * const result = safeReadFile('/path/to/file.txt');
+ * if (result.success) {
+ *   console.log(result.value);
+ * } else {
+ *   console.error(result.errors[0].type);
+ * }
+ * ```
+ */
+export function safeReadFile(
+  filePath: string,
+  encoding: BufferEncoding = 'utf-8'
+): Result<string, FileReadError> {
+  // Check file existence
+  if (!existsSync(filePath)) {
+    return failure([{
+      type: 'FileNotFound',
+      path: filePath
+    }]);
+  }
+
+  try {
+    const content = readFileSync(filePath, encoding);
+    return success(content);
+  } catch (error) {
+    // Check for permission errors
+    if (error instanceof Error && error.message.includes('EACCES')) {
+      return failure([{
+        type: 'PermissionDenied',
+        path: filePath
+      }]);
+    }
+
+    // Generic read error
+    return failure([{
+      type: 'ReadError',
+      path: filePath,
+      cause: error instanceof Error ? error.message : String(error)
+    }]);
+  }
+}
+
+/**
+ * Safe JSON file reader with Result type
+ *
+ * @param filePath - Path to the JSON file to read
+ * @returns Result<any, FileReadError> - Parsed JSON object or error
+ *
+ * @example
+ * ```typescript
+ * const result = safeReadJsonFile('/path/to/config.json');
+ * if (result.success) {
+ *   const config = result.value;
+ * } else {
+ *   console.error(result.errors[0].type);
+ * }
+ * ```
+ */
+export function safeReadJsonFile<T = JsonValue>(
+  filePath: string
+): Result<T, FileReadError> {
+  // First, read the file
+  const readResult = safeReadFile(filePath);
+
+  if (!readResult.success) {
+    return readResult as Result<T, FileReadError>;
+  }
+
+  // Then, parse JSON
+  try {
+    const parsed = JSON.parse(readResult.value as string) as T;
+    return success(parsed);
+  } catch (error) {
+    return failure([{
+      type: 'InvalidJSON',
+      path: filePath,
+      cause: error instanceof Error ? error.message : String(error)
+    }]);
+  }
+}
+
+/**
+ * Safe file reader that throws on error (for compatibility with existing code)
+ *
+ * @param filePath - Path to the file to read
+ * @param encoding - File encoding (default: 'utf-8')
+ * @returns string - File content
+ * @throws Error if file cannot be read
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const content = safeReadFileOrThrow('/path/to/file.txt');
+ *   console.log(content);
+ * } catch (error) {
+ *   console.error('Failed to read file:', error);
+ * }
+ * ```
+ */
+export function safeReadFileOrThrow(
+  filePath: string,
+  encoding: BufferEncoding = 'utf-8'
+): string {
+  const result = safeReadFile(filePath, encoding);
+
+  if (!result.success) {
+    const error = result.errors[0];
+    switch (error.type) {
+    case 'FileNotFound':
+      throw new Error(`File not found: ${error.path}`);
+    case 'PermissionDenied':
+      throw new Error(`Permission denied: ${error.path}`);
+    case 'InvalidJSON':
+      throw new Error(`Invalid JSON in ${error.path}: ${error.cause}`);
+    case 'ReadError':
+      throw new Error(`Failed to read ${error.path}: ${error.cause}`);
+    }
+  }
+
+  return result.value as string;
+}

package/scripts/utils/security-validator.ts

@@ -5,27 +5,19 @@
  * 環境変数やAPIトークンなど機密情報のバリデーションとセキュリティチェックを行います。
  */
 
-import { statSync } from 'fs';
-
-/**
- * バリデーション結果
- */
-export interface ValidationResult {
-  isValid: boolean;
-  errors: string[];
-  warnings: string[];
-}
+import type { Result } from './types/validation.js';
+import { success, failure } from './types/validation.js';
 
 /**
  * APIトークン形式の検証
  */
-export function validateAtlassianToken(token: string): ValidationResult {
+export function validateAtlassianToken(token: string): Result<boolean, string> {
   const errors: string[] = [];
   const warnings: string[] = [];
 
   if (!token || token.trim() === '') {
     errors.push('Atlassian API token is empty');
-    return { isValid: false, errors, warnings };
+    return failure(errors, warnings);
   }
 
   if (token.includes(' ')) {
@@ -40,17 +32,17 @@ export function validateAtlassianToken(token: string): ValidationResult {
     warnings.push('Atlassian API token seems too short (expected >20 characters)');
   }
 
-  return {
-    isValid: errors.length === 0,
-    errors,
-    warnings,
-  };
+  if (errors.length > 0) {
+    return failure(errors, warnings);
+  }
+
+  return success(true, warnings);
 }
 
 /**
  * GitHub Personal Access Token の検証
  */
-export function validateGitHubToken(token: string): ValidationResult {
+export function validateGitHubToken(token: string): Result<boolean, string> {
   const errors: string[] = [];
   const warnings: string[] = [];
 
@@ -66,17 +58,17 @@ export function validateGitHubToken(token: string): ValidationResult {
     warnings.push('GitHub token seems too short');
   }
 
-  return {
-    isValid: errors.length === 0,
-    errors,
-    warnings,
-  };
+  if (errors.length > 0) {
+    return failure(errors, warnings);
+  }
+
+  return success(true, warnings);
 }
 
 /**
  * メールアドレス形式の検証
  */
-export function validateEmail(email: string): ValidationResult {
+export function validateEmail(email: string): Result<boolean, string> {
   const errors: string[] = [];
   const warnings: string[] = [];
 
@@ -95,17 +87,17 @@ export function validateEmail(email: string): ValidationResult {
     }
   }
 
-  return {
-    isValid: errors.length === 0,
-    errors,
-    warnings,
-  };
+  if (errors.length > 0) {
+    return failure(errors, warnings);
+  }
+
+  return success(true, warnings);
 }
 
 /**
  * URL形式の検証
  */
-export function validateUrl(url: string, expectedDomain?: string): ValidationResult {
+export function validateUrl(url: string, expectedDomain?: string): Result<boolean, string> {
   const errors: string[] = [];
   const warnings: string[] = [];
 
@@ -135,25 +127,25 @@ export function validateUrl(url: string, expectedDomain?: string): ValidationRes
     }
   }
 
-  return {
-    isValid: errors.length === 0,
-    errors,
-    warnings,
-  };
+  if (errors.length > 0) {
+    return failure(errors, warnings);
+  }
+
+  return success(true, warnings);
 }
 
 /**
  * Atlassian URL の検証
  */
-export function validateAtlassianUrl(url: string): ValidationResult {
+export function validateAtlassianUrl(url: string): Result<boolean, string> {
   const result = validateUrl(url, 'atlassian.net');
 
-  if (result.isValid) {
+  if (result.success) {
     try {
       const parsedUrl = new URL(url);
       if (!parsedUrl.hostname.endsWith('.atlassian.net')) {
-        result.errors.push('Atlassian URL must end with .atlassian.net');
-        result.isValid = false;
+        const errors = [...result.errors, 'Atlassian URL must end with .atlassian.net'];
+        return failure(errors, result.warnings);
       }
     } catch {
       // Already handled in validateUrl
@@ -166,7 +158,7 @@ export function validateAtlassianUrl(url: string): ValidationResult {
 /**
  * GitHub リポジトリ URL の検証
  */
-export function validateGitHubRepositoryUrl(url: string): ValidationResult {
+export function validateGitHubRepositoryUrl(url: string): Result<boolean, string> {
   const errors: string[] = [];
   const warnings: string[] = [];
 
@@ -188,11 +180,11 @@ export function validateGitHubRepositoryUrl(url: string): ValidationResult {
     }
   }
 
-  return {
-    isValid: errors.length === 0,
-    errors,
-    warnings,
-  };
+  if (errors.length > 0) {
+    return failure(errors, warnings);
+  }
+
+  return success(true, warnings);
 }
 
 /**
@@ -207,7 +199,7 @@ export interface EnvValidationConfig {
   repositoryUrl?: string;
 }
 
-export function validateEnvironmentConfig(config: EnvValidationConfig): ValidationResult {
+export function validateEnvironmentConfig(config: EnvValidationConfig): Result<boolean, string> {
   const allErrors: string[] = [];
   const allWarnings: string[] = [];
 
@@ -249,38 +241,10 @@ export function validateEnvironmentConfig(config: EnvValidationConfig): Validati
     allWarnings.push(...result.warnings.map((w) => `repository: ${w}`));
   }
 
-  return {
-    isValid: allErrors.length === 0,
-    errors: allErrors,
-    warnings: allWarnings,
-  };
-}
-
-/**
- * ファイルパーミッションの検証（Unix系のみ）
- */
-export function validateFilePermissions(filePath: string, expectedMode: number = 0o600): ValidationResult {
-  const errors: string[] = [];
-  const warnings: string[] = [];
-
-  try {
-    const stats = statSync(filePath);
-    const actualMode = stats.mode & 0o777;
-
-    if (actualMode !== expectedMode) {
-      const actualOctal = actualMode.toString(8);
-      const expectedOctal = expectedMode.toString(8);
-      warnings.push(
-        `File permissions are ${actualOctal} but should be ${expectedOctal} for security. Run: chmod ${expectedOctal} ${filePath}`,
-      );
-    }
-  } catch (error) {
-    errors.push(`Failed to check file permissions: ${error instanceof Error ? error.message : error}`);
+  if (allErrors.length > 0) {
+    return failure(allErrors, allWarnings);
   }
 
-  return {
-    isValid: errors.length === 0,
-    errors,
-    warnings,
-  };
+  return success(true, allWarnings);
 }
+

package/scripts/utils/spec-archiver.ts

@@ -3,9 +3,10 @@
  * 完了した仕様書を .kiro/specs/archive/ に移動する
  */
 
-import { existsSync, renameSync, mkdirSync, readdirSync, readFileSync, writeFileSync } from 'fs';
+import { existsSync, renameSync, mkdirSync, readdirSync, writeFileSync } from 'fs';
 import { resolve } from 'path';
 import { validateFeatureName as validateFeatureNameStrict } from './feature-name-validator.js';
+import { safeReadFileOrThrow } from './safe-file-reader.js';
 
 export interface ArchiveResult {
   success: boolean;
@@ -45,7 +46,7 @@ function validateFeatureName(featureName: string): void {
 
   // kebab-case形式の厳密な検証（既存のバリデータを使用）
   const result = validateFeatureNameStrict(featureName);
-  if (!result.valid) {
+  if (!result.success) {
     throw new Error(result.errors.join('\n'));
   }
 }
@@ -79,7 +80,7 @@ export function canArchiveSpec(
   }
 
   try {
-    const specContent = JSON.parse(readFileSync(specJsonPath, 'utf-8'));
+    const specContent = JSON.parse(safeReadFileOrThrow(specJsonPath));
 
     // 既にアーカイブ済みかチェック
     if (specContent.archived) {
@@ -151,7 +152,7 @@ export function archiveSpec(
 
     // spec.json に archived 情報を追加
     const specJsonPath = resolve(targetDir, 'spec.json');
-    const spec = JSON.parse(readFileSync(specJsonPath, 'utf-8'));
+    const spec = JSON.parse(safeReadFileOrThrow(specJsonPath, 'utf-8'));
     spec.archived = {
       at: new Date().toISOString(),
       reason: options?.reason,
@@ -208,7 +209,7 @@ export function listSpecs(
           const specPath = resolve(archiveDir, archivedEntry.name, 'spec.json');
           if (existsSync(specPath)) {
             try {
-              const spec = JSON.parse(readFileSync(specPath, 'utf-8'));
+              const spec = JSON.parse(safeReadFileOrThrow(specPath, 'utf-8'));
               const files = readdirSync(resolve(archiveDir, archivedEntry.name));
 
               specs.push({
@@ -240,7 +241,7 @@ export function listSpecs(
     const specPath = resolve(specsDir, entry.name, 'spec.json');
     if (existsSync(specPath)) {
       try {
-        const spec = JSON.parse(readFileSync(specPath, 'utf-8'));
+        const spec = JSON.parse(safeReadFileOrThrow(specPath, 'utf-8'));
         const files = readdirSync(resolve(specsDir, entry.name));
 
         specs.push({

package/scripts/utils/spec-updater.ts

@@ -3,7 +3,8 @@
  * Confluence/JIRA 同期後に spec.json を更新する
  */
 
-import { readFileSync, writeFileSync, existsSync, mkdirSync } from 'fs';
+import { writeFileSync, existsSync, mkdirSync } from 'fs';
+import { safeReadJsonFile } from './safe-file-reader.js';
 import { resolve } from 'path';
 
 /**
@@ -94,11 +95,14 @@ export function loadSpecJson(featureName: string, projectRoot: string = process.
     };
   }
 
-  try {
-    const content = readFileSync(specPath, 'utf-8');
-    return JSON.parse(content);
-  } catch (error) {
-    console.warn(`⚠️  Failed to load spec.json from ${specPath}: ${error instanceof Error ? error.message : 'Unknown error'}`);
+  const result = safeReadJsonFile<SpecJson>(specPath);
+
+  if (!result.success) {
+    const errorType = result.errors[0].type;
+    const errorMsg = errorType === 'InvalidJSON'
+      ? `Invalid JSON: ${result.errors[0].cause}`
+      : errorType;
+    console.warn(`⚠️  Failed to load spec.json from ${specPath}: ${errorMsg}`);
     return {
       featureName,
       confluence: {},
@@ -106,6 +110,8 @@ export function loadSpecJson(featureName: string, projectRoot: string = process.
       milestones: {},
     };
   }
+
+  return result.value!;
 }
 
 /**

package/scripts/utils/tasks-converter.ts

@@ -15,12 +15,12 @@ import {
   isAIDLCFormat,
   getAIDLCStats,
 } from './aidlc-parser.js';
-import { readFileSync } from 'fs';
 import {
   getWeekdayNotation,
   getWeekdayRangeNotation,
   ensureBusinessDay,
 } from './business-days.js';
+import { safeReadFileOrThrow } from './safe-file-reader.js';
 
 /**
  * 変換オプション
@@ -551,7 +551,7 @@ export function convertTasksFile(
   options: ConversionOptions = {},
 ): ConversionResult {
   // ファイル読み込み
-  const content = readFileSync(inputPath, 'utf-8');
+  const content = safeReadFileOrThrow(inputPath);
 
   // AI-DLC形式かチェック
   if (!isAIDLCFormat(content)) {

package/scripts/utils/tasks-format-validator.ts

@@ -6,7 +6,7 @@
  * - 旧6-Phase構造（Phase 0-5）も互換性のためサポート
  */
 
-import { readFileSync } from 'fs';
+import { safeReadFileOrThrow } from './safe-file-reader.js';
 
 /**
  * tasks.mdのフォーマットを検証
@@ -18,7 +18,7 @@ export function validateTasksFormat(tasksPath: string): void {
   let content: string;
 
   try {
-    content = readFileSync(tasksPath, 'utf-8');
+    content = safeReadFileOrThrow(tasksPath);
   } catch (error) {
     throw new Error(
       `Failed to read tasks.md: ${error instanceof Error ? error.message : 'Unknown error'}`,
@@ -153,7 +153,7 @@ export function isValidTasksFormat(tasksPath: string): boolean {
  */
 export function countPhases(tasksPath: string): number {
   try {
-    const content = readFileSync(tasksPath, 'utf-8');
+    const content = safeReadFileOrThrow(tasksPath);
     const phasePattern = /## Phase \d+:/g;
     const matches = content.match(phasePattern);
     return matches ? matches.length : 0;
@@ -170,7 +170,7 @@ export function countPhases(tasksPath: string): number {
  */
 export function countStories(tasksPath: string): number {
   try {
-    const content = readFileSync(tasksPath, 'utf-8');
+    const content = safeReadFileOrThrow(tasksPath);
     const storyPattern = /### Story \d+\.\d+:/g;
     const matches = content.match(storyPattern);
     return matches ? matches.length : 0;

package/scripts/utils/template-applier.ts

@@ -3,7 +3,8 @@
  * テスト仕様書テンプレートにデータを適用
  */
 
-import { readFileSync, existsSync } from 'fs';
+import { existsSync } from 'fs';
+import { safeReadFileOrThrow } from './safe-file-reader.js';
 import { join, dirname } from 'path';
 import { fileURLToPath } from 'url';
 import type { Component, Flow, Requirement } from './markdown-parser.js';
@@ -64,13 +65,13 @@ export function loadTestSpecTemplate(testType: string, projectRoot: string = pro
     );
     
     if (existsSync(michiTemplatePath)) {
-      return readFileSync(michiTemplatePath, 'utf-8');
+      return safeReadFileOrThrow(michiTemplatePath, 'utf-8');
     }
     
     throw new Error(`テンプレートが見つかりません: ${testType}-test-spec-template.md`);
   }
   
-  return readFileSync(templatePath, 'utf-8');
+  return safeReadFileOrThrow(templatePath, 'utf-8');
 }
 
 /**