@ksw8954/git-ai-commit 1.0.0

package/src/commands/tag.ts

@@ -0,0 +1,230 @@
+import { Command } from 'commander';
+import readline from 'readline';
+import { AIService, AIServiceConfig } from './ai';
+import { ConfigService } from './config';
+import { GitService } from './git';
+import { LogService } from './log';
+
+export interface TagOptions {
+  apiKey?: string;
+  baseUrl?: string;
+  model?: string;
+  message?: string;
+  baseTag?: string;
+  prompt?: string;
+}
+
+export class TagCommand {
+  private program: Command;
+
+  constructor() {
+    this.program = new Command('tag')
+      .description('Create an annotated git tag with optional AI-generated notes')
+      .argument('<name>', 'Tag name to create')
+      .option('-k, --api-key <key>', 'OpenAI API key (overrides env var)')
+      .option('--base-url <url>', 'Custom API base URL (overrides env var)')
+      .option('-m, --model <model>', 'Model to use (overrides env var)')
+      .option('--message <message>', 'Tag message to use directly (skips AI generation)')
+      .option('-t, --base-tag <tag>', 'Existing tag to diff against when generating notes')
+      .option('--prompt <text>', 'Additional instructions to append to the AI prompt for this tag')
+      .action(async (tagName: string, options: TagOptions) => {
+        await this.handleTag(tagName, options);
+      });
+  }
+
+  private resolveAIConfig(options: TagOptions): AIServiceConfig {
+    const storedConfig = ConfigService.getConfig();
+
+    const mergedApiKey = options.apiKey || storedConfig.apiKey;
+    const mergedBaseURL = options.baseUrl || storedConfig.baseURL;
+    const mergedModel = options.model || storedConfig.model;
+
+    ConfigService.validateConfig({
+      apiKey: mergedApiKey,
+      language: storedConfig.language
+    });
+
+    return {
+      apiKey: mergedApiKey!,
+      baseURL: mergedBaseURL,
+      model: mergedModel,
+      language: storedConfig.language
+    };
+  }
+
+  private async handleTag(tagName: string, options: TagOptions): Promise<void> {
+    const trimmedName = tagName?.trim();
+
+    if (!trimmedName) {
+      console.error('Tag name is required.');
+      await LogService.append({
+        command: 'tag',
+        args: { name: tagName, ...options, apiKey: options.apiKey ? '***' : undefined },
+        status: 'failure',
+        details: 'missing tag name'
+      });
+      process.exit(1);
+      return;
+    }
+
+    let tagMessage = options.message?.trim();
+
+    if (!tagMessage) {
+      console.log('Collecting commit history for tag notes...');
+
+      let baseTag = options.baseTag?.trim();
+      if (!baseTag) {
+        const latestTagResult = await GitService.getLatestTag();
+        if (latestTagResult.success && latestTagResult.tag) {
+          baseTag = latestTagResult.tag;
+          console.log(`Using latest tag ${baseTag} as base.`);
+        } else {
+          console.log('No existing tag found; using entire commit history.');
+        }
+      }
+
+      const historyResult = await GitService.getCommitSummariesSince(baseTag);
+      if (!historyResult.success || !historyResult.log) {
+        console.error('Error:', historyResult.error ?? 'Unable to read commit history.');
+        await LogService.append({
+          command: 'tag',
+          args: { name: trimmedName, ...options, apiKey: options.apiKey ? '***' : undefined },
+          status: 'failure',
+          details: historyResult.error ?? 'Unable to read commit history.'
+        });
+        process.exit(1);
+        return;
+      }
+
+      let aiConfig: AIServiceConfig;
+
+      try {
+        aiConfig = this.resolveAIConfig(options);
+      } catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        console.error('Error:', message);
+        await LogService.append({
+          command: 'tag',
+          args: { name: trimmedName, ...options, apiKey: options.apiKey ? '***' : undefined },
+          status: 'failure',
+          details: message
+        });
+        process.exit(1);
+        return;
+      }
+
+      const aiService = new AIService(aiConfig);
+      const aiResult = await aiService.generateTagNotes(trimmedName, historyResult.log, options.prompt);
+
+      if (!aiResult.success || !aiResult.notes) {
+        console.error('Error:', aiResult.error ?? 'Failed to generate tag notes.');
+        await LogService.append({
+          command: 'tag',
+          args: { name: trimmedName, ...options, apiKey: options.apiKey ? '***' : undefined },
+          status: 'failure',
+          details: aiResult.error ?? 'Failed to generate tag notes.'
+        });
+        process.exit(1);
+        return;
+      }
+
+      tagMessage = aiResult.notes;
+    }
+
+    // Show preview and confirm before creating the tag
+    console.log('\nTag message preview:\n');
+    console.log(tagMessage);
+
+    const shouldCreate = await this.confirmTagCreate(trimmedName);
+
+    if (!shouldCreate) {
+      console.log('Tag creation cancelled by user.');
+      await LogService.append({
+        command: 'tag',
+        args: { name: trimmedName, ...options, apiKey: options.apiKey ? '***' : undefined },
+        status: 'cancelled',
+        details: 'user declined tag creation'
+      });
+      return;
+    }
+
+    console.log(`Creating annotated tag ${trimmedName}...`);
+    const created = await GitService.createAnnotatedTag(trimmedName, tagMessage);
+
+    if (!created) {
+      console.error('❌ Failed to create tag');
+      await LogService.append({
+        command: 'tag',
+        args: { name: trimmedName, ...options, apiKey: options.apiKey ? '***' : undefined },
+        status: 'failure',
+        details: 'git tag creation failed'
+      });
+      process.exit(1);
+      return;
+    }
+
+    console.log(`✅ Tag ${trimmedName} created successfully!`);
+
+    const shouldPush = await this.confirmTagPush(trimmedName);
+
+    if (shouldPush) {
+      console.log(`Pushing tag ${trimmedName} to remote...`);
+      const pushSuccess = await GitService.pushTag(trimmedName);
+
+      if (pushSuccess) {
+        console.log(`✅ Tag ${trimmedName} pushed successfully!`);
+      } else {
+        console.error('❌ Failed to push tag to remote');
+        await LogService.append({
+          command: 'tag',
+          args: { name: trimmedName, ...options, apiKey: options.apiKey ? '***' : undefined },
+          status: 'failure',
+          details: 'tag push failed'
+        });
+        process.exit(1);
+      }
+    }
+
+    await LogService.append({
+      command: 'tag',
+      args: { name: trimmedName, ...options, apiKey: options.apiKey ? '***' : undefined },
+      status: 'success'
+    });
+  }
+
+  private async confirmTagPush(tagName: string): Promise<boolean> {
+    const rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout
+    });
+
+    const answer: string = await new Promise(resolve => {
+      rl.question(`Push tag ${tagName} to remote? (y/n): `, resolve);
+    });
+
+    rl.close();
+
+    const normalized = answer.trim().toLowerCase();
+    return normalized === 'y' || normalized === 'yes';
+  }
+
+  private async confirmTagCreate(tagName: string): Promise<boolean> {
+    const rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout
+    });
+
+    const answer: string = await new Promise(resolve => {
+      rl.question(`Create annotated tag ${tagName}? (y/n): `, resolve);
+    });
+
+    rl.close();
+
+    const normalized = answer.trim().toLowerCase();
+    return normalized === 'y' || normalized === 'yes';
+  }
+
+  getCommand(): Command {
+    return this.program;
+  }
+}

package/src/index.ts

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+
+import { Command } from 'commander';
+import { CommitCommand } from './commands/commit';
+import { ConfigCommand } from './commands/configCommand';
+import { PullRequestCommand } from './commands/prCommand';
+import { TagCommand } from './commands/tag';
+import { HistoryCommand } from './commands/history';
+
+const program = new Command();
+
+program
+  .name('git-ai-commit')
+  .description('AI-powered git commit message generator')
+  .version('1.0.0');
+
+const commitCommand = new CommitCommand();
+const configCommand = new ConfigCommand();
+const pullRequestCommand = new PullRequestCommand();
+const tagCommand = new TagCommand();
+const historyCommand = new HistoryCommand();
+
+program.addCommand(commitCommand.getCommand());
+program.addCommand(configCommand.getCommand());
+program.addCommand(pullRequestCommand.getCommand());
+program.addCommand(tagCommand.getCommand());
+program.addCommand(historyCommand.getCommand());
+
+program.parse();

package/src/prompts/commit.ts

@@ -0,0 +1,105 @@
+export type CommitPromptLanguage = 'ko' | 'en';
+
+export const generateCommitPrompt = (
+  gitContext: string,
+  customInstructions = '',
+  language: CommitPromptLanguage = 'ko'
+): string => {
+  const languageRequirement = language === 'ko'
+    ? `## Korean Language Requirement
+- All commit messages MUST be written in Korean (한글)
+- Description, body, and footer text must use Korean
+- Keep Korean messages concise`
+    : `## English Language Requirement
+- All commit messages MUST be written in English
+- Description, body, and footer text must use English
+- Keep the tone concise and professional`;
+
+  const bodyGuidelines = language === 'ko'
+    ? `### Body Guidelines (Optional)
+- Insert one blank line after the description and express additional details as
+  markdown bullet points (\`- \`) written in Korean.
+- Each bullet should explain the "what" and "why", not the "how".
+- Wrap at 72 characters per line and keep bullets concise.
+- Use the bullet body only for complex changes that need clarification; omit it
+  when the summary line is sufficient.`
+    : `### Body Guidelines (Optional)
+- Insert one blank line after the description and use markdown bullet points (\`- \`) in English.
+- Each bullet should explain the "what" and "why", not the "how".
+- Wrap at 72 characters per line and keep bullets concise.
+- Include a body only for complex changes that need clarification.`;
+
+  const footerGuidelines = language === 'ko'
+    ? `### Footer Guidelines (Optional)
+- Start one blank line after body
+- **Breaking Changes**: \`BREAKING CHANGE: description\``
+    : `### Footer Guidelines (Optional)
+- Start one blank line after the body
+- **Breaking Changes**: \`BREAKING CHANGE: description\``;
+
+  return `# Conventional Commit Message Generator
+## System Instructions
+You are an expert Git commit message generator that creates conventional commit messages based on staged changes. Analyze the provided git diff output and generate appropriate conventional commit messages following the specification.
+
+${customInstructions}
+
+## CRITICAL: Commit Message Output Rules
+- DO NOT include any memory bank status indicators like "[Memory Bank: Active]" or "[Memory Bank: Missing]"
+- DO NOT include any task-specific formatting or artifacts from other rules
+- ONLY Generate a clean conventional commit message as specified below
+
+${gitContext}
+
+## Conventional Commits Format
+Generate commit messages following this exact structure:
+\n<type>[optional scope]: <description>
+[optional body]
+[optional footer(s)]
+
+### Core Types (Required)
+- **feat**: New feature or functionality (MINOR version bump)
+- **fix**: Bug fix or error correction (PATCH version bump)
+
+### Additional Types (Extended)
+- **docs**: Documentation changes only
+- **style**: Code style changes (whitespace, formatting, semicolons, etc.)
+- **refactor**: Code refactoring without feature changes or bug fixes
+- **perf**: Performance improvements
+- **test**: Adding or fixing tests
+- **build**: Build system or external dependency changes
+- **ci**: CI/CD configuration changes
+- **chore**: Maintenance tasks, tooling changes
+- **revert**: Reverting previous commits
+
+### Scope Guidelines
+- Use parentheses: \`feat(api):\`, \`fix(ui):\`
+- Common scopes: \`api\`, \`ui\`, \`auth\`, \`db\`, \`config\`, \`deps\`, \`docs\`
+- For monorepos: package or module names
+- Keep scope concise and lowercase
+
+### Description Rules
+- Use imperative mood ("add" not "added" or "adds")
+- Start with lowercase letter
+- No period at the end
+- Be concise but descriptive
+- Must be written as a single line without line breaks
+
+${languageRequirement}
+
+${bodyGuidelines}
+
+${footerGuidelines}
+
+## Analysis Instructions
+When analyzing staged changes:
+1. Determine Primary Type based on the nature of changes
+2. Identify Scope from modified directories or modules
+3. Craft Description focusing on the most significant change
+4. Determine if there are Breaking Changes
+5. For complex changes, include a detailed body explaining what and why
+6. Add appropriate footers for issue references or breaking changes
+
+For significant changes, include a detailed body explaining the changes.
+
+Return ONLY the commit message in the conventional format, nothing else.`;
+};

package/src/prompts/pr.ts

@@ -0,0 +1,64 @@
+export type PullRequestPromptLanguage = 'ko' | 'en';
+
+export const generatePullRequestPrompt = (
+  baseBranch: string,
+  compareBranch: string,
+  customInstructions = '',
+  language: PullRequestPromptLanguage = 'ko'
+): string => {
+  const languageRequirement = language === 'ko'
+    ? 'Write the entire pull request title and body in Korean.'
+    : 'Write the entire pull request title and body in English.';
+
+  const titleGuidelines = language === 'ko'
+    ? `### 제목 작성 규칙
+- 한 줄짜리 명령형 문장으로 작성합니다 (예: "Refactor validator 로직 정리").
+- 접두사는 사용하지 않습니다 (예: "Feat:" 금지).
+- 72자를 넘지 않도록 합니다.`
+    : `### Title Guidelines
+- Use a single imperative sentence (e.g., "Refactor validator handling").
+- Do not prefix with labels like "Feat:".
+- Keep the title under 72 characters.`;
+
+  const summaryGuidelines = language === 'ko'
+    ? `### 본문 구성
+- "## Summary" 헤딩 아래에 핵심 변경 사항을 강조하는 불릿 리스트를 작성합니다.
+- 각 불릿은 "무엇을"과 "왜"를 포함하고, 한국어로 1줄 내로 작성합니다.
+- 영향이 큰 변경은 별도의 불릿으로 구분합니다.`
+    : `### Body Structure
+- Under a "## Summary" heading, add bullet points that explain what changed and why.
+- Keep each bullet to a single concise English sentence.
+- Separate large areas of impact into individual bullets.`;
+
+  const testingGuidelines = language === 'ko'
+    ? `### 테스트 정보
+- "## Testing" 헤딩 아래에 검증 방법을 불릿으로 정리합니다.
+- 수동 테스트, 자동 테스트, 혹은 "테스트 필요 없음"을 명시합니다.`
+    : `### Testing Details
+- Under a "## Testing" heading, list how the changes were verified.
+- Call out manual steps, automated checks, or "Not tested" when applicable.`;
+
+  return `You are an expert software engineer preparing a pull request description.
+Compare the git history and code changes between the base branch "${baseBranch}" and the compare branch "${compareBranch}" and summarise the meaningful differences in a PR-friendly format.
+
+${customInstructions}
+
+## Output Contract
+- Return ONLY markdown suitable for pasting into a pull request form.
+- First line MUST be the pull request title, adhering to the title guidelines below.
+- After one blank line, include the sections exactly as shown:
+  - "## Summary"
+  - "## Testing"
+- If a section has no content, provide a single bullet: "- 없음" in Korean or "- None" in English (use language-appropriate wording).
+- Do not invent changes that are not present in the provided diff.
+
+${languageRequirement}
+
+${titleGuidelines}
+
+${summaryGuidelines}
+
+${testingGuidelines}
+
+Focus on user-facing impact, breaking changes, and notable refactors. Avoid raw diff dumps.`;
+};

package/src/prompts/tag.ts

@@ -0,0 +1,48 @@
+export type TagPromptLanguage = 'ko' | 'en';
+
+export const generateTagPrompt = (
+  tagName: string,
+  customInstructions = '',
+  language: TagPromptLanguage = 'ko'
+): string => {
+  const summaryInstruction = language === 'ko'
+    ? 'Begin with a short summary sentence (in Korean) that captures the overall impact of the release.'
+    : 'Begin with a short summary sentence (in English) that captures the overall impact of the release.';
+
+  const listInstruction = language === 'ko'
+    ? 'After the summary, list every change as a markdown bullet (-) grouped by category: 사용자 기능, 버그 수정, 유지 보수.'
+    : 'After the summary, list every change as a markdown bullet (-) grouped by category: User Features, Bug Fixes, Maintenance.';
+
+  const emptyCategoryInstruction = language === 'ko'
+    ? 'If a category has no changes, include a bullet stating - 해당 사항 없음.'
+    : 'If a category has no changes, include a bullet stating - None.';
+
+  const noChangesInstruction = language === 'ko'
+    ? 'If no changes exist at all, state "변경 사항 없음" plainly.'
+    : 'If no changes exist at all, state "No changes to report." plainly.';
+
+  const outputLanguageLine = language === 'ko'
+    ? 'Write the release notes in Korean using concise markdown.'
+    : 'Write the release notes in English using concise markdown.';
+
+  return `You are an experienced release manager. Produce clear, user-facing release notes that describe the differences between the previous tag and ${tagName}.
+
+## Objective
+Summarize the meaningful changes that occurred between the prior release tag and ${tagName}. Treat the commit log provided by the user message as the complete history of changes since the previous tag.
+
+## Input Context
+- Target tag to publish: ${tagName}
+- Commit history between the previous tag and ${tagName} will be supplied in the user message (most recent first).
+
+${customInstructions}
+
+## Output Requirements
+- ${outputLanguageLine}
+- ${summaryInstruction}
+- ${listInstruction}
+- Use short phrases for each bullet and include scope/component names when helpful, without copying commit messages verbatim.
+- ${emptyCategoryInstruction}
+- ${noChangesInstruction}
+- Do not invent work beyond what appears in the commit log.
+- Return only the release notes content with no surrounding commentary.`;
+};

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": ["ES2020"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "resolveJsonModule": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "**/*.test.ts"]
+}