@sk8metal/michi-cli 0.14.1 → 0.20.0

package/scripts/utils/config-validator.ts

@@ -2,7 +2,7 @@
  * 設定ファイルのバリデーション
  */
 
-import { existsSync, readFileSync } from 'fs';
+import { existsSync } from 'fs';
 import { AppConfigSchema } from '../config/config-schema.js';
 import type { ZodIssue } from 'zod';
 import { getConfig, getConfigPath, getGlobalConfigPath } from './config-loader.js';
@@ -14,23 +14,51 @@ import {
   filterStoryTypes,
   filterSubtaskTypes,
 } from './jira-issue-type-fetcher.js';
+import type { Result } from './types/validation.js';
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import { success, failure } from './types/validation.js';
+import { safeReadFileOrThrow } from './safe-file-reader.js';
 
 /**
- * バリデーション結果
+ * Result型を拡張した情報メッセージ付きバリデーション結果
+ * config-validator固有の拡張型
  */
-export interface ValidationResult {
-  valid: boolean;
-  errors: string[];
-  warnings: string[];
+export interface ResultWithInfo extends Result<boolean, string> {
   info: string[];
 }
 
+/**
+ * ResultWithInfo を作成するヘルパー関数（成功）
+ */
+function successWithInfo(value: boolean, warnings: string[] = [], info: string[] = []): ResultWithInfo {
+  return {
+    success: true,
+    value,
+    errors: [],
+    warnings,
+    info,
+  };
+}
+
+/**
+ * ResultWithInfo を作成するヘルパー関数（失敗）
+ */
+function failureWithInfo(errors: string[], warnings: string[] = [], info: string[] = []): ResultWithInfo {
+  return {
+    success: false,
+    value: undefined,
+    errors,
+    warnings,
+    info,
+  };
+}
+
 /**
  * プロジェクト設定ファイルをバリデーション
  */
 export function validateProjectConfig(
   projectRoot: string = process.cwd(),
-): ValidationResult {
+): ResultWithInfo {
   const errors: string[] = [];
   const warnings: string[] = [];
   const info: string[] = [];
@@ -40,16 +68,11 @@ export function validateProjectConfig(
   if (!existsSync(configPath)) {
     // 設定ファイルが存在しない場合は情報メッセージ（デフォルト設定を使用）
     info.push('Project config file not found. Using default configuration.');
-    return {
-      valid: true,
-      errors: [],
-      warnings: [],
-      info,
-    };
+    return successWithInfo(true, [], info);
   }
 
   try {
-    const content = readFileSync(configPath, 'utf-8');
+    const content = safeReadFileOrThrow(configPath);
     const parsed = JSON.parse(content);
 
     // スキーマでバリデーション
@@ -61,12 +84,7 @@ export function validateProjectConfig(
         errors.push(`${path}: ${error.message}`);
       });
 
-      return {
-        valid: false,
-        errors,
-        warnings: [],
-        info: [],
-      };
+      return failureWithInfo(errors, [], []);
     }
 
     // 追加のバリデーション
@@ -171,12 +189,11 @@ export function validateProjectConfig(
       }
     }
 
-    return {
-      valid: errors.length === 0,
-      errors,
-      warnings,
-      info: [],
-    };
+    if (errors.length > 0) {
+      return failureWithInfo(errors, warnings, []);
+    }
+
+    return successWithInfo(true, warnings, []);
   } catch (error) {
     if (error instanceof SyntaxError) {
       errors.push(`Invalid JSON: ${error.message}`);
@@ -186,12 +203,7 @@ export function validateProjectConfig(
       );
     }
 
-    return {
-      valid: false,
-      errors,
-      warnings: [],
-      info: [],
-    };
+    return failureWithInfo(errors, [], []);
   }
 }
 
@@ -225,11 +237,11 @@ export function validateAndReport(
     return false;
   }
 
-  if (result.valid) {
+  if (result.success) {
     console.log('✅ Configuration is valid');
   }
 
-  return result.valid;
+  return result.success;
 }
 
 /**
@@ -241,7 +253,7 @@ export function validateAndReport(
 export function validateForConfluenceSync(
   docType: 'requirements' | 'design' | 'tasks',
   projectRoot: string = process.cwd(),
-): ValidationResult {
+): ResultWithInfo {
   const errors: string[] = [];
   const warnings: string[] = [];
   const info: string[] = [];
@@ -319,12 +331,11 @@ export function validateForConfluenceSync(
     }
   }
 
-  return {
-    valid: errors.length === 0,
-    errors,
-    warnings,
-    info,
-  };
+  if (errors.length > 0) {
+    return failureWithInfo(errors, warnings, info);
+  }
+
+  return successWithInfo(true, warnings, info);
 }
 
 /**
@@ -334,7 +345,7 @@ export function validateForConfluenceSync(
  */
 export function validateForJiraSync(
   projectRoot: string = process.cwd(),
-): ValidationResult {
+): ResultWithInfo {
   const errors: string[] = [];
   const warnings: string[] = [];
   const info: string[] = [];
@@ -419,12 +430,11 @@ export function validateForJiraSync(
     }
   }
 
-  return {
-    valid: errors.length === 0,
-    errors,
-    warnings,
-    info,
-  };
+  if (errors.length > 0) {
+    return failureWithInfo(errors, warnings, info);
+  }
+
+  return successWithInfo(true, warnings, info);
 }
 
 /**
@@ -434,10 +444,14 @@ export function validateForJiraSync(
  */
 export async function validateForJiraSyncAsync(
   projectRoot: string = process.cwd(),
-): Promise<ValidationResult> {
+): Promise<ResultWithInfo> {
   // まず同期版のバリデーションを実行
   const result = validateForJiraSync(projectRoot);
 
+  // 追加のエラーと警告を収集
+  const additionalErrors: string[] = [];
+  const additionalWarnings: string[] = [];
+
   // JIRA認証情報とプロジェクトキーが設定されている場合、Issue Type IDの存在チェックを実行
   if (hasJiraCredentials()) {
     try {
@@ -467,7 +481,7 @@ export async function validateForJiraSyncAsync(
                     .join('\n')
                   : '  （Storyタイプが見つかりませんでした）';
 
-              result.errors.push(
+              additionalErrors.push(
                 `設定されたStory Issue Type ID (${storyId}) がプロジェクト '${projectKey}' に存在しません。\n` +
                   '\n利用可能なStoryタイプ:\n' +
                   suggestions +
@@ -478,7 +492,6 @@ export async function validateForJiraSyncAsync(
                   '  2. または、対話的設定を再実行:\n' +
                   '     npm run setup:interactive',
               );
-              result.valid = false;
             }
           }
 
@@ -493,7 +506,7 @@ export async function validateForJiraSyncAsync(
                     .join('\n')
                   : '  （Subtaskタイプが見つかりませんでした）';
 
-              result.warnings.push(
+              additionalWarnings.push(
                 `設定されたSubtask Issue Type ID (${subtaskId}) がプロジェクト '${projectKey}' に存在しません。\n` +
                   '\n利用可能なSubtaskタイプ:\n' +
                   suggestions +
@@ -509,7 +522,7 @@ export async function validateForJiraSyncAsync(
         } else {
           // Issue Types取得に失敗した場合（認証エラー、ネットワークエラーなど）
           // エラーにはしないが、警告として記録
-          result.warnings.push(
+          additionalWarnings.push(
             `JIRAプロジェクト '${projectKey}' のIssue Typesを取得できませんでした。` +
               '設定されたIssue Type IDの存在確認をスキップします。',
           );
@@ -518,20 +531,32 @@ export async function validateForJiraSyncAsync(
     } catch (error) {
       // プロジェクトメタデータの読み込みに失敗した場合など
       // エラーにはしないが、警告として記録
-      result.warnings.push(
+      additionalWarnings.push(
         `プロジェクトメタデータの読み込みに失敗しました: ${error instanceof Error ? error.message : error}` +
           '設定されたIssue Type IDの存在確認をスキップします。',
       );
     }
   }
 
+  // 追加のエラーや警告があれば、新しいResultWithInfoを作成
+  if (additionalErrors.length > 0 || additionalWarnings.length > 0) {
+    const allErrors = [...result.errors, ...additionalErrors];
+    const allWarnings = [...result.warnings, ...additionalWarnings];
+
+    if (allErrors.length > 0) {
+      return failureWithInfo(allErrors, allWarnings, result.info);
+    }
+
+    return successWithInfo(true, allWarnings, result.info);
+  }
+
   return result;
 }
 
 /**
  * グローバル設定ファイルをバリデーション
  */
-export function validateGlobalConfig(): ValidationResult {
+export function validateGlobalConfig(): ResultWithInfo {
   const errors: string[] = [];
   const warnings: string[] = [];
   const info: string[] = [];
@@ -540,16 +565,11 @@ export function validateGlobalConfig(): ValidationResult {
 
   if (!existsSync(globalConfigPath)) {
     info.push('Global config file not found. This is optional.');
-    return {
-      valid: true,
-      errors: [],
-      warnings: [],
-      info,
-    };
+    return successWithInfo(true, [], info);
   }
 
   try {
-    const content = readFileSync(globalConfigPath, 'utf-8');
+    const content = safeReadFileOrThrow(globalConfigPath);
     const parsed = JSON.parse(content);
 
     // スキーマでバリデーション
@@ -561,20 +581,14 @@ export function validateGlobalConfig(): ValidationResult {
         errors.push(`${path}: ${error.message}`);
       });
 
-      return {
-        valid: false,
-        errors,
-        warnings: [],
-        info: [],
-      };
+      return failureWithInfo(errors, [], []);
+    }
+
+    if (errors.length > 0) {
+      return failureWithInfo(errors, warnings, []);
     }
 
-    return {
-      valid: errors.length === 0,
-      errors,
-      warnings,
-      info: [],
-    };
+    return successWithInfo(true, warnings, []);
   } catch (error) {
     if (error instanceof SyntaxError) {
       errors.push(`Invalid JSON in global config: ${error.message}`);
@@ -584,12 +598,7 @@ export function validateGlobalConfig(): ValidationResult {
       );
     }
 
-    return {
-      valid: false,
-      errors,
-      warnings: [],
-      info: [],
-    };
+    return failureWithInfo(errors, [], []);
   }
 }
 

package/scripts/utils/docker-requirement-detector.ts

@@ -3,7 +3,8 @@
  * design.md、requirements.md、test-type-selectionからDocker Composeの必要性を自動判断
  */
 
-import { readFileSync, existsSync } from 'fs';
+import { existsSync } from 'fs';
+import { safeReadFileOrThrow } from './safe-file-reader.js';
 import { join } from 'path';
 import { extractSection } from './markdown-parser.js';
 
@@ -25,7 +26,7 @@ export function analyzeDockerRequirement(feature: string, projectRoot: string =
   // design.mdを解析
   const designPath = join(projectRoot, '.kiro', 'specs', feature, 'design.md');
   if (existsSync(designPath)) {
-    const design = readFileSync(designPath, 'utf-8');
+    const design = safeReadFileOrThrow(designPath, 'utf-8');
     
     // Technology Stackセクションを確認
     const techStack = extractSection(design, 'Technology Stack');
@@ -90,7 +91,7 @@ export function analyzeDockerRequirement(feature: string, projectRoot: string =
   const testSelectionPath = join(projectRoot, '.kiro', 'specs', feature, 'test-type-selection.json');
   if (existsSync(testSelectionPath)) {
     try {
-      const testSelection = JSON.parse(readFileSync(testSelectionPath, 'utf-8'));
+      const testSelection = JSON.parse(safeReadFileOrThrow(testSelectionPath, 'utf-8'));
       const testTypes = testSelection.selectedTypes || [];
       
       // 統合テストが選択されている
@@ -118,7 +119,7 @@ export function analyzeDockerRequirement(feature: string, projectRoot: string =
   // requirements.mdを解析
   const requirementsPath = join(projectRoot, '.kiro', 'specs', feature, 'requirements.md');
   if (existsSync(requirementsPath)) {
-    const requirements = readFileSync(requirementsPath, 'utf-8');
+    const requirements = safeReadFileOrThrow(requirementsPath, 'utf-8');
     
     // データ永続化の要件
     if (requirements.match(/データベース|database|永続化|persist/i)) {

package/scripts/utils/env-config.ts

@@ -8,7 +8,7 @@
  * - .envファイルの生成
  */
 
-import { readFileSync, existsSync } from 'fs';
+import { existsSync } from 'fs';
 import * as readline from 'readline';
 import {
   getProjectIssueTypes,
@@ -17,6 +17,7 @@ import {
   filterStoryTypes,
   filterSubtaskTypes,
 } from './jira-issue-type-fetcher.js';
+import { safeReadFileOrThrow } from './safe-file-reader.js';
 
 /**
  * 環境変数の設定項目定義
@@ -112,7 +113,7 @@ export function parseEnvFile(filePath: string): Map<string, string> {
   }
 
   try {
-    const content = readFileSync(filePath, 'utf-8');
+    const content = safeReadFileOrThrow(filePath);
     const lines = content.split('\n');
 
     for (const line of lines) {
@@ -316,28 +317,37 @@ async function promptJiraIssueTypeId(
       ? '   値を入力（Enter=デフォルト）: '
       : '   値を入力: ';
 
-  const input = await question(rl, promptText);
+  const MAX_RETRIES = 5;
+  let retryCount = 0;
 
-  // 入力が空の場合
-  if (!input) {
-    // 既存値があればそれを使用
-    if (existingValue) {
-      return existingValue;
-    }
-    // デフォルト値があればそれを使用
-    if (config.defaultValue) {
-      return config.defaultValue;
-    }
-    // 必須項目で値がない場合はエラー
-    if (config.required) {
-      console.log('   ⚠️  必須項目です。値を入力してください。');
-      return promptJiraIssueTypeId(rl, config, projectKey, existingValue);
+  while (true) {
+    const input = await question(rl, promptText);
+
+    // 入力が空の場合
+    if (!input) {
+      // 既存値があればそれを使用
+      if (existingValue) {
+        return existingValue;
+      }
+      // デフォルト値があればそれを使用
+      if (config.defaultValue) {
+        return config.defaultValue;
+      }
+      // 必須項目で値がない場合はエラー
+      if (config.required) {
+        retryCount++;
+        if (retryCount >= MAX_RETRIES) {
+          throw new Error(`必須項目 ${config.key} の入力が ${MAX_RETRIES} 回失敗しました`);
+        }
+        console.log(`   ⚠️  必須項目です。値を入力してください。(残り ${MAX_RETRIES - retryCount} 回)`);
+        continue;
+      }
+      // オプション項目は空文字を返す
+      return '';
     }
-    // オプション項目は空文字を返す
-    return '';
-  }
 
-  return input;
+    return input;
+  }
 }
 
 /**
@@ -384,28 +394,37 @@ export async function promptEnvValue(
       ? '   値を入力（Enter=デフォルト）: '
       : '   値を入力: ';
 
-  const input = await question(rl, promptText);
+  const MAX_RETRIES = 5;
+  let retryCount = 0;
 
-  // 入力が空の場合
-  if (!input) {
-    // 既存値があればそれを使用
-    if (existingValue) {
-      return existingValue;
-    }
-    // デフォルト値があればそれを使用
-    if (config.defaultValue) {
-      return config.defaultValue;
-    }
-    // 必須項目で値がない場合はエラー
-    if (config.required) {
-      console.log('   ⚠️  必須項目です。値を入力してください。');
-      return promptEnvValue(rl, config, existingValue, projectKey);
+  while (true) {
+    const input = await question(rl, promptText);
+
+    // 入力が空の場合
+    if (!input) {
+      // 既存値があればそれを使用
+      if (existingValue) {
+        return existingValue;
+      }
+      // デフォルト値があればそれを使用
+      if (config.defaultValue) {
+        return config.defaultValue;
+      }
+      // 必須項目で値がない場合はエラー
+      if (config.required) {
+        retryCount++;
+        if (retryCount >= MAX_RETRIES) {
+          throw new Error(`必須項目 ${config.key} の入力が ${MAX_RETRIES} 回失敗しました`);
+        }
+        console.log(`   ⚠️  必須項目です。値を入力してください。(残り ${MAX_RETRIES - retryCount} 回)`);
+        continue;
+      }
+      // オプション項目は空文字を返す
+      return '';
     }
-    // オプション項目は空文字を返す
-    return '';
-  }
 
-  return input;
+    return input;
+  }
 }
 
 /**

package/scripts/utils/feature-name-validator.ts

@@ -3,10 +3,8 @@
  * kebab-case形式を強制
  */
 
-export interface ValidationResult {
-  valid: boolean;
-  errors: string[];
-}
+import type { Result } from './types/validation.js';
+import { success, failure } from './types/validation.js';
 
 /**
  * kebab-case形式の正規表現
@@ -19,23 +17,26 @@ const KEBAB_CASE_PATTERN = /^[a-z0-9]+(-[a-z0-9]+)*$/;
 
 /**
  * feature名がkebab-case形式か検証
+ *
+ * @returns Result<boolean, string> - 成功時は true、失敗時は false
  */
-export function validateFeatureName(featureName: string): ValidationResult {
+export function validateFeatureName(featureName: string): Result<boolean, string> {
   const errors: string[] = [];
-  
+  const warnings: string[] = [];
+
   // 空文字チェック
   if (!featureName || featureName.trim().length === 0) {
     errors.push('❌ feature名が空です');
-    return { valid: false, errors };
+    return failure(errors);
   }
-  
+
   const trimmed = featureName.trim();
-  
+
   // kebab-case形式チェック
   if (!KEBAB_CASE_PATTERN.test(trimmed)) {
     errors.push(`❌ feature名が無効な形式です: "${trimmed}"`);
     errors.push('   必須形式: 英語、kebab-case（ハイフン区切り）、小文字のみ');
-    
+
     // 具体的な問題を特定
     if (/[A-Z]/.test(trimmed)) {
       errors.push('   → 大文字が含まれています（小文字に変換してください）');
@@ -59,29 +60,30 @@ export function validateFeatureName(featureName: string): ValidationResult {
       const invalidChars = trimmed.match(/[^a-z0-9-]/g);
       errors.push(`   → 使用できない文字が含まれています: ${[...new Set(invalidChars)].join(', ')}`);
     }
-    
+
     // 修正案を提示
     const suggestion = suggestFeatureName(trimmed);
     if (suggestion && suggestion !== trimmed) {
       errors.push(`   💡 修正案: "${suggestion}"`);
     }
   }
-  
+
   // 長さチェック（推奨）
   if (trimmed.length > 50) {
-    errors.push(`⚠️  feature名が長すぎます（${trimmed.length}文字）。50文字以内を推奨`);
+    warnings.push(`⚠️  feature名が長すぎます（${trimmed.length}文字）。50文字以内を推奨`);
   }
-  
+
   // 単語数チェック（推奨）
   const wordCount = trimmed.split('-').length;
   if (wordCount > 5) {
-    errors.push(`⚠️  単語数が多すぎます（${wordCount}単語）。2-4単語を推奨`);
+    warnings.push(`⚠️  単語数が多すぎます（${wordCount}単語）。2-4単語を推奨`);
+  }
+
+  if (errors.length > 0) {
+    return failure(errors, warnings);
   }
-  
-  return {
-    valid: errors.length === 0,
-    errors
-  };
+
+  return success(true, warnings);
 }
 
 /**
@@ -103,8 +105,8 @@ export function suggestFeatureName(input: string): string {
  */
 export function validateFeatureNameOrThrow(featureName: string): void {
   const result = validateFeatureName(featureName);
-  
-  if (!result.valid) {
+
+  if (!result.success) {
     const errorMessage = [
       `Invalid feature name: "${featureName}"`,
       '',
@@ -112,24 +114,7 @@ export function validateFeatureNameOrThrow(featureName: string): void {
       '',
       'ヘルプ: README.md#機能名（feature）の命名規則 を参照してください'
     ].join('\n');
-    
-    throw new Error(errorMessage);
-  }
-}
 
-/**
- * feature名をバリデートし、警告を表示（続行可能）
- */
-export function validateFeatureNameWithWarning(featureName: string): boolean {
-  const result = validateFeatureName(featureName);
-  
-  if (!result.valid) {
-    console.error('\n⚠️  Feature name validation failed:');
-    result.errors.forEach(err => console.error(err));
-    console.error('\nヘルプ: README.md#機能名（feature）の命名規則 を参照してください\n');
-    return false;
+    throw new Error(errorMessage);
   }
-  
-  return true;
 }
-