Merge pull request #37 from cawpea/feature/#36_unify-style-prompts

Feature/#36 unify style prompts

Author: cawpea

docs/user-guide/cli-usage.md

@@ -1,5 +1,7 @@
 # CLI Usage
 
+Both `validate` and `fix` commands provide color-coded output with consistent formatting to help you quickly identify issues and track progress. Messages use standardized colors (errors in red, warnings in yellow, success in green, etc.) and contextual emoji indicators for improved readability.
+
 ## Validate Command
 
 ### Basic Usage

src/cli/fix.ts

@@ -20,6 +20,7 @@ import { formatFixOptions } from '@/utils/styles';
 import type { CodeRefError, FixOptions, FixResult } from '@/utils/types';
 import { extractCodeRefs, findMarkdownFiles, validateCodeRef } from '@/core/validate';
 import { loadFixConfig, getDocsPath, type CodeRefFixConfig } from '@/config';
+import { msg } from '@/utils/message-formatter';
 
 // Parse command line arguments
 function parseArgs(): FixOptions {
@@ -86,23 +87,28 @@ export async function main(): Promise<void> {
     verbose: options.verbose,
   });
 
-  console.log('🔧 Starting CODE_REF error fixes...\n');
+  // Set verbose mode for message formatter
+  msg.setVerbose(options.verbose);
+
+  console.log(`${msg.startFix('Starting CODE_REF error fixes...')}\n`);
 
   if (options.dryRun) {
-    console.log('⚠️  DRY RUN mode: No actual changes will be made\n');
+    console.log(`${msg.warning('DRY RUN mode: No actual changes will be made')}\n`);
   }
 
   // Collect errors
   const errorGroups = collectErrors(config);
 
   if (errorGroups.length === 0) {
-    console.log('✅ No fixable errors found');
+    console.log(msg.success('No fixable errors found'));
     process.exit(0);
   }
 
   // Statistics
   const totalErrors = errorGroups.reduce((sum, g) => sum + g.errors.length, 0);
-  console.log(`📊 Detected ${totalErrors} fixable error(s) in ${errorGroups.length} file(s)\n`);
+  console.log(
+    `${msg.info(`Detected ${totalErrors} fixable error(s) in ${errorGroups.length} file(s)`)}\n`
+  );
 
   // Interactive interface
   const rl = createPromptInterface();
@@ -111,8 +117,8 @@ export async function main(): Promise<void> {
 
   try {
     for (const group of errorGroups) {
-      console.log(`\n📄 ${path.relative(config.projectRoot, group.docFile)}`);
-      console.log(`   ${group.errors.length} error(s)\n`);
+      console.log(`\n${msg.file(path.relative(config.projectRoot, group.docFile))}`);
+      console.log(`${msg.context(`${group.errors.length} error(s)`)}\n`);
 
       // Sort errors in descending order by docLineNumber (bottom to top)
       // To prevent fixes at the bottom from affecting line numbers at the top
@@ -125,10 +131,8 @@ export async function main(): Promise<void> {
       let _lineOffset = 0; // Track cumulative offset (for future edge case handling)
 
       for (const error of sortedErrors) {
-        console.log(`\n❌ ${error.type}: ${error.message}`);
-        console.log(
-          `   Reference: ${path.relative(config.projectRoot, error.ref.docFile)}${error.ref.docLineNumber ? `:${error.ref.docLineNumber}` : ''}`
-        );
+        const location = `${path.relative(config.projectRoot, error.ref.docFile)}${error.ref.docLineNumber ? `:${error.ref.docLineNumber}` : ''}`;
+        console.log(`\n${msg.errorDetail(error.type, error.message, location)}`);
 
         // Create fix action
         let action;
@@ -141,12 +145,12 @@ export async function main(): Promise<void> {
 
           // If there are multiple options, let the user choose
           if (Array.isArray(fixActionResult)) {
-            console.log('\n🛠️ Please select a fix method:\n');
+            console.log(`\n${msg.info('Please select a fix method:')}\n`);
             console.log(formatFixOptions(fixActionResult));
 
             if (options.auto) {
               // Auto-select first option in auto mode
-              console.log('   ℹ️  Auto-selecting option 1 in auto mode\n');
+              console.log(`${msg.context('Auto-selecting option 1 in auto mode')}\n`);
               action = fixActionResult[0];
             } else {
               // Let user choose
@@ -156,14 +160,14 @@ export async function main(): Promise<void> {
                   if (num >= 1 && num <= fixActionResult.length) {
                     resolve(num - 1);
                   } else {
-                    console.log('   ⚠️  Invalid selection. Skipping.');
+                    console.log(msg.context('Invalid selection. Skipping.'));
                     resolve(-1);
                   }
                 });
               });
 
               if (selection === -1) {
-                console.log('   ⏭️  Skipped');
+                console.log(msg.context('Skipped'));
                 continue;
               }
 
@@ -175,7 +179,7 @@ export async function main(): Promise<void> {
         }
 
         if (!action) {
-          console.log('   ⚠️  This error cannot be fixed');
+          console.log(msg.context('This error cannot be fixed'));
           continue;
         }
 
@@ -191,13 +195,13 @@ export async function main(): Promise<void> {
         }
 
         if (!shouldFix) {
-          console.log('   ⏭️  Skipped');
+          console.log(msg.context('Skipped'));
           continue;
         }
 
         // Dry run check
         if (options.dryRun) {
-          console.log('   ✅ [DRY RUN] Simulated fix');
+          console.log(msg.context('[DRY RUN] Simulated fix'));
           fixResults.push({ success: true, action });
           continue;
         }
@@ -207,7 +211,7 @@ export async function main(): Promise<void> {
         if (!options.noBackup && !backupFiles.has(group.docFile)) {
           backupPath = createBackup(group.docFile);
           backupFiles.add(group.docFile);
-          console.log(`   💾 Backup created: ${path.basename(backupPath)}`);
+          console.log(msg.context(`Backup created: ${path.basename(backupPath)}`));
         }
 
         // Apply fix
@@ -216,15 +220,15 @@ export async function main(): Promise<void> {
           _lineOffset += lineDelta; // Accumulate offset
 
           // Debug log
-          if (lineDelta !== 0) {
-            console.log(`   📊 Line delta: ${lineDelta > 0 ? '+' : ''}${lineDelta}`);
+          if (lineDelta !== 0 && options.verbose) {
+            console.log(msg.debug(`   Line delta: ${lineDelta > 0 ? '+' : ''}${lineDelta}`));
           }
 
-          console.log('   ✅ Fix applied');
+          console.log(msg.context('Fix applied'));
           fixResults.push({ success: true, action, backupPath });
         } catch (err) {
           const errorMsg = err instanceof Error ? err.message : String(err);
-          console.log(`   ❌ Fix failed: ${errorMsg}`);
+          console.log(msg.context(`Fix failed: ${errorMsg}`));
           fixResults.push({ success: false, action, error: errorMsg, backupPath });
         }
       }
@@ -234,30 +238,23 @@ export async function main(): Promise<void> {
   }
 
   // Result summary
-  console.log(`\n${'='.repeat(60)}`);
-  console.log('📊 Fix Results Summary\n');
-
   const successful = fixResults.filter((r) => r.success).length;
   const failed = fixResults.filter((r) => !r.success).length;
 
-  console.log(`✅ Successful: ${successful}`);
-  console.log(`❌ Failed: ${failed}`);
+  const backupPaths =
+    !options.noBackup && backupFiles.size > 0
+      ? Array.from(backupFiles).map((file) => path.relative(config.projectRoot, `${file}.backup`))
+      : [];
 
-  if (backupFiles.size > 0 && !options.noBackup) {
-    console.log(`\n💾 Backup files: ${backupFiles.size}`);
-    for (const file of backupFiles) {
-      const backupPath = `${file}.backup`;
-      console.log(`   ${path.relative(config.projectRoot, backupPath)}`);
-    }
-  }
+  console.log(msg.summary(successful, failed, backupPaths));
 
   process.exit(failed > 0 ? 1 : 0);
 }
 
 // When executed as a script
 if (require.main === module) {
   main().catch((error) => {
-    console.error('\n❌ An error occurred:', error);
+    console.error(`\n${msg.error(`An error occurred: ${error}`)}`);
     process.exit(1);
   });
 }

src/cli/validate.ts

@@ -18,6 +18,7 @@ import { findMarkdownFiles, extractCodeRefs, validateCodeRef } from '@/core/vali
 import { isIgnored, loadDocsignorePatterns } from '@/utils/ignore-pattern';
 import { displayLineRangeDiff } from '@/utils/diff-display';
 import { extractLinesFromFile } from '@/utils/code-comparison';
+import { msg } from '@/utils/message-formatter';
 
 /**
  * CLI options
@@ -74,7 +75,7 @@ function resolveTargetFiles(targets: string[], projectRoot: string, docsPath: st
         resolvedFiles.add(absolutePath);
       }
     } else {
-      console.warn(`⚠️  File not found: ${target}`);
+      console.warn(msg.warning(`File not found: ${target}`));
     }
   }
 
@@ -87,7 +88,9 @@ function resolveTargetFiles(targets: string[], projectRoot: string, docsPath: st
 export async function main(args: string[] = process.argv.slice(2)): Promise<void> {
   const options = parseCliArgs(args);
 
-  console.log('🔍 Validating CODE_REF references in documentation...\n');
+  msg.setVerbose(options.verbose);
+
+  console.log(`${msg.startValidation('Validating CODE_REF references in documentation...')}\n`);
 
   // Load configuration
   const config = loadConfig({
@@ -100,14 +103,14 @@ export async function main(args: string[] = process.argv.slice(2)): Promise<void
   const allMarkdownFiles = resolveTargetFiles(options.files, config.projectRoot, docsPath);
 
   if (options.files.length > 0 && options.verbose) {
-    console.log(`📋 Specified files/directories: ${options.files.join(', ')}\n`);
+    console.log(`${msg.debug(`Specified files/directories: ${options.files.join(', ')}`)}\n`);
   }
 
   // Load ignore patterns
   const ignoreFilePath = getIgnoreFilePath(config);
   const ignorePatterns = ignoreFilePath ? loadDocsignorePatterns(ignoreFilePath) : [];
   if (options.verbose) {
-    console.log(`📋 Loaded ${ignorePatterns.length} ignore patterns\n`);
+    console.log(`${msg.debug(`Loaded ${ignorePatterns.length} ignore patterns`)}\n`);
   }
 
   // Filter files not excluded by ignore patterns
@@ -118,11 +121,11 @@ export async function main(args: string[] = process.argv.slice(2)): Promise<void
 
   if (options.verbose && allMarkdownFiles.length > markdownFiles.length) {
     console.log(
-      `📋 ${allMarkdownFiles.length - markdownFiles.length} files excluded by ignore patterns\n`
+      `${msg.debug(`${allMarkdownFiles.length - markdownFiles.length} files excluded by ignore patterns`)}\n`
     );
   }
 
-  console.log(`📄 Found ${markdownFiles.length} markdown files\n`);
+  console.log(`${msg.file(`Found ${markdownFiles.length} markdown files`)}\n`);
 
   // Extract all CODE_REF references
   let totalRefs = 0;
@@ -137,15 +140,15 @@ export async function main(args: string[] = process.argv.slice(2)): Promise<void
       refs.forEach((ref) => allRefs.push({ ref, file }));
 
       if (options.verbose) {
-        console.log(`  ${path.relative(docsPath, file)}: ${refs.length} references`);
+        console.log(msg.debug(`  ${path.relative(docsPath, file)}: ${refs.length} references`));
       }
     }
   }
 
-  console.log(`\n📌 Found ${totalRefs} CODE_REF references\n`);
+  console.log(`\n${msg.info(`Found ${totalRefs} CODE_REF references`)}\n`);
 
   if (totalRefs === 0) {
-    console.log('✅ No CODE_REF references found (no validation needed)');
+    console.log(msg.success('No CODE_REF references found (no validation needed)'));
     process.exit(0);
   }
 
@@ -156,10 +159,10 @@ export async function main(args: string[] = process.argv.slice(2)): Promise<void
 
   // Display results
   if (allErrors.length === 0) {
-    console.log('✅ All CODE_REF references are valid!');
+    console.log(msg.success('All CODE_REF references are valid!'));
     process.exit(0);
   } else {
-    console.log(`❌ Found ${allErrors.length} errors:\n`);
+    console.log(`${msg.error(`Found ${allErrors.length} errors:`)}\n`);
 
     // Group errors by document
     const errorsByDoc: Record<string, any[]> = {};
@@ -176,15 +179,15 @@ export async function main(args: string[] = process.argv.slice(2)): Promise<void
 
     // Display error details
     for (const [docFile, errors] of Object.entries(errorsByDoc)) {
-      console.log(`📄 ${docFile}:`);
+      console.log(`${msg.file(docFile)}:`);
 
       for (const error of errors) {
-        console.log(`  ❌ ${error.type}: ${error.message}`);
+        console.log(`   ${msg.error(`${error.type}: ${error.message}`)}`);
 
         // Display line number in document
         const filePath = path.relative(config.projectRoot, error.ref.docFile);
         const lineInfo = error.ref.docLineNumber ? `:${error.ref.docLineNumber}` : '';
-        console.log(`     ${filePath}${lineInfo}: ${error.ref.fullMatch}`);
+        console.log(msg.context(`   ${filePath}${lineInfo}: ${error.ref.fullMatch}`));
 
         // Display diff for CODE_LOCATION_MISMATCH in verbose mode
         if (error.type === 'CODE_LOCATION_MISMATCH' && error.suggestedLines && options.verbose) {
@@ -212,7 +215,7 @@ export async function main(args: string[] = process.argv.slice(2)): Promise<void
 // Run CLI if this file is executed directly
 if (require.main === module) {
   main().catch((error) => {
-    console.error('Error:', error);
+    console.error(msg.error(`Error: ${error}`));
     process.exit(1);
   });
 }

src/utils/backup.test.ts

@@ -69,7 +69,7 @@ describe('backup', () => {
       mockedFs.existsSync.mockReturnValue(false);
 
       expect(() => restoreBackup(backupPath, originalPath)).toThrow(
-        'バックアップファイルが見つかりません'
+        'Backup file not found: /test/file.txt.backup'
       );
     });
   });

src/utils/backup.ts

@@ -1,19 +1,20 @@
 /**
- * バックアップ管理ユーティリティ
+ * Backup management utilities
  */
 
 import * as fs from 'fs';
 import * as path from 'path';
 
 /**
- * ファイルのバックアップを作成
- * @returns バックアップファイルのパス
+ * Create a backup of a file
+ * @param filePath Path to the file to backup
+ * @returns Path to the backup file
  */
 export function createBackup(filePath: string): string {
   let backupPath = `${filePath}.backup`;
   let counter = 1;
 
-  // ユニークなバックアップファイル名を検索
+  // Find a unique backup filename
   while (fs.existsSync(backupPath)) {
     backupPath = `${filePath}.backup.${counter}`;
     counter++;
@@ -24,18 +25,21 @@ export function createBackup(filePath: string): string {
 }
 
 /**
- * バックアップから復元
+ * Restore a file from backup
+ * @param backupPath Path to the backup file
+ * @param originalPath Path where the file should be restored
  */
 export function restoreBackup(backupPath: string, originalPath: string): void {
   if (!fs.existsSync(backupPath)) {
-    throw new Error(`バックアップファイルが見つかりません: ${backupPath}`);
+    throw new Error(`Backup file not found: ${backupPath}`);
   }
 
   fs.copyFileSync(backupPath, originalPath);
 }
 
 /**
- * バックアップファイルを削除
+ * Delete a backup file
+ * @param backupPath Path to the backup file to delete
  */
 export function deleteBackup(backupPath: string): void {
   if (fs.existsSync(backupPath)) {
@@ -44,7 +48,9 @@ export function deleteBackup(backupPath: string): void {
 }
 
 /**
- * 指定ファイルの全バックアップファイルをリスト
+ * List all backup files for a given file
+ * @param filePath Path to the original file
+ * @returns Array of backup file paths
  */
 export function listBackups(filePath: string): string[] {
   const dir = path.dirname(filePath);