korekt-cli 0.2.0

package/README.md

@@ -0,0 +1,130 @@
+# Korekt CLI
+
+AI-powered code review CLI - Keep your kode korekt ✨
+
+`kk` integrates seamlessly with your local Git workflow to provide intelligent code reviews powered by AI.
+
+## Features
+
+*   **AI-Powered Analysis**: Get instant, intelligent code reviews with severity levels, categories, and actionable suggestions
+*   **Local Git Integration**: Works with committed changes, staged changes, and unstaged modifications
+*   **Ticket System Integration**: Automatically extracts ticket IDs from branch names and commit messages (Jira & Azure DevOps)
+*   **Beautiful Output**: Color-coded issues with severity indicators, file locations, and suggested fixes
+*   **Ultra-Fast**: Short command syntax (`kk`) for maximum developer efficiency
+
+## Installation
+
+```bash
+npm install -g korekt-cli
+```
+
+## Quick Start
+
+Configure the CLI with your API credentials:
+
+```bash
+kk config --key YOUR_API_KEY
+kk config --endpoint https://api.korekt.ai/review/local
+```
+
+Run your first review:
+
+```bash
+# Review committed changes against a target branch
+kk review main
+
+# Review only staged changes
+kk stg
+
+# Review only unstaged changes
+kk diff
+
+# Review all uncommitted changes (staged + unstaged)
+kk all
+```
+
+## Usage
+
+### Configuration
+
+```bash
+# Set API key
+kk config --key YOUR_API_KEY
+
+# Set API endpoint
+kk config --endpoint https://api.korekt.ai/review/local
+
+# Set default ticket system (jira or ado)
+kk config --ticket-system jira
+
+# Show current configuration
+kk config --show
+```
+
+### Review Commands
+
+```bash
+# Review committed changes (auto-detect base branch)
+kk review
+
+# Review against specific branch
+kk review main
+
+# Review with ticket system override
+kk review main --ticket-system ado
+
+# Review with ignored files
+kk review main --ignore "*.lock" "dist/*"
+
+# Dry run (preview payload without sending)
+kk review main --dry-run
+
+# Review staged changes only
+kk stg
+# Aliases: kk staged, kk cached
+
+# Review unstaged changes only
+kk diff
+
+# Review all uncommitted changes
+kk all
+
+# Include untracked files
+kk all --untracked
+```
+
+### Alternative Command
+
+Both `kk` and `korekt` commands are available:
+
+```bash
+korekt review main  # Same as: kk review main
+```
+
+## Environment Variables
+
+You can also configure using environment variables:
+
+```bash
+export KOREKT_API_KEY="your-api-key"
+export KOREKT_API_ENDPOINT="https://api.korekt.ai/review/local"
+export KOREKT_TICKET_SYSTEM="jira"
+```
+
+Note: Config file takes precedence over environment variables.
+
+## Help
+
+For more options and detailed help:
+
+```bash
+kk --help
+kk review --help
+```
+
+## Development
+
+To run tests:
+```bash
+npm test
+```

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "korekt-cli",
+  "version": "0.2.0",
+  "description": "AI-powered code review CLI - Keep your kode korekt",
+  "main": "src/index.js",
+  "bin": {
+    "kk": "src/index.js",
+    "korekt": "src/index.js"
+  },
+  "type": "module",
+  "scripts": {
+    "test": "vitest",
+    "test:watch": "vitest --watch",
+    "test:coverage": "vitest --coverage"
+  },
+  "keywords": [
+    "code-review",
+    "ai",
+    "cli",
+    "git",
+    "korekt",
+    "code-quality",
+    "static-analysis"
+  ],
+  "author": "Vladan Djokic",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vladan-me/korekt-cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/vladan-me/korekt-cli/issues"
+  },
+  "homepage": "https://korekt.ai",
+  "files": [
+    "src"
+  ],
+  "license": "UNLICENSED",
+  "dependencies": {
+    "axios": "^1.12.2",
+    "chalk": "^5.6.2",
+    "commander": "^14.0.1",
+    "conf": "^15.0.2",
+    "dotenv": "^17.2.3",
+    "execa": "^9.6.0",
+    "ora": "^9.0.0"
+  },
+  "devDependencies": {
+    "vitest": "^3.2.4"
+  }
+}

package/src/config.js

@@ -0,0 +1,75 @@
+import Conf from 'conf';
+import dotenv from 'dotenv';
+
+// Load .env file if it exists (quietly)
+dotenv.config({ quiet: true });
+
+// Initialize config
+const config = new Conf({
+  projectName: 'korekt-cli',
+});
+
+/**
+ * Get the API key from config or environment
+ * Priority: 1) config store, 2) .env file
+ */
+export function getApiKey() {
+  const configKey = config.get('apiKey');
+  if (configKey) return configKey;
+
+  return process.env.KOREKT_API_KEY || null;
+}
+
+/**
+ * Set the API key in config store
+ */
+export function setApiKey(key) {
+  config.set('apiKey', key);
+}
+
+/**
+ * Get the API endpoint URL from config or environment
+ * Priority: 1) config store, 2) .env file
+ */
+export function getApiEndpoint() {
+  const configEndpoint = config.get('apiEndpoint');
+  if (configEndpoint) return configEndpoint;
+
+  return process.env.KOREKT_API_ENDPOINT || null;
+}
+
+/**
+ * Set the API endpoint in config store
+ */
+export function setApiEndpoint(endpoint) {
+  config.set('apiEndpoint', endpoint);
+}
+
+/**
+ * Get the ticket system from config or environment
+ * Priority: 1) config store, 2) .env file
+ */
+export function getTicketSystem() {
+  const configTicketSystem = config.get('ticketSystem');
+  if (configTicketSystem) return configTicketSystem;
+
+  return process.env.KOREKT_TICKET_SYSTEM || null;
+}
+
+/**
+ * Set the ticket system in config store
+ */
+export function setTicketSystem(system) {
+  config.set('ticketSystem', system);
+}
+
+/**
+ * Get all configuration
+ */
+export function getConfig() {
+  return {
+    apiKey: getApiKey(),
+    apiEndpoint: getApiEndpoint(),
+    ticketSystem: getTicketSystem(),
+  };
+}

package/src/formatter.js

@@ -0,0 +1,143 @@
+import chalk from 'chalk';
+import path from 'path';
+import { execaSync } from 'execa';
+
+// Emojis and colors inspired by the provided ADO script
+const SEVERITY_ICONS = {
+  critical: '🟣',
+  high: '🔴',
+  medium: '🟠',
+  low: '🟡',
+};
+
+const SEVERITY_COLORS = {
+  critical: chalk.magenta.bold,
+  high: chalk.red.bold,
+  medium: chalk.yellow.bold,
+  low: chalk.gray.bold,
+};
+
+const CATEGORY_ICONS = {
+  bug: '🐞',
+  security: '🛡️',
+  best_practice: '✨',
+  dependency: '📦',
+  performance: '🚀',
+  rbac: '🔑',
+  syntax: '📝',
+  clean_code: '🧼',
+  documentation: '📝',
+  test_coverage: '🧪',
+  readability: '📖',
+  default: '⚙️', // Default icon
+};
+
+/**
+ * Capitalize and replace underscores for category display.
+ * @param {string} category
+ * @returns {string}
+ */
+function formatCategory(category) {
+  if (!category) return '';
+  return category
+    .replace(/_/g, ' ')
+    .replace(/\b\w/g, char => char.toUpperCase());
+}
+
+/**
+ * Get the git repository root directory.
+ * @returns {string} - Absolute path to the git repository root
+ */
+function getGitRoot() {
+  try {
+    const { stdout } = execaSync('git', ['rev-parse', '--show-toplevel']);
+    return stdout.trim();
+  } catch (error) {
+    // Fallback to current working directory if not in a git repo
+    return process.cwd();
+  }
+}
+
+/**
+ * Convert a relative file path to an absolute path for better IDE integration.
+ * @param {string} filePath - The file path from the API response
+ * @returns {string} - Absolute file path
+ */
+function toAbsolutePath(filePath) {
+  if (path.isAbsolute(filePath)) {
+    return filePath;
+  }
+  const gitRoot = getGitRoot();
+  return path.join(gitRoot, filePath);
+}
+
+/**
+ * Format and display the API response in the new, detailed style.
+ * @param {Object} data - The API response data
+ */
+export function formatReviewOutput(data) {
+  const { review, summary } = data.analysis;
+
+  console.log(chalk.bold.blue('🤖 Automated Code Review Results\n'));
+
+  // --- Praises Section ---
+  if (review && review.praises && review.praises.length > 0) {
+    console.log(chalk.bold.magenta(`✨ Praises (${summary.total_praises})`));
+    review.praises.forEach(praise => {
+      const categoryIcon = CATEGORY_ICONS[praise.category] || CATEGORY_ICONS.default;
+      const formattedCategory = formatCategory(praise.category);
+      const absolutePath = toAbsolutePath(praise.file_path);
+      console.log(`  ✅ ${chalk.green.bold(formattedCategory)} in ${absolutePath}:${praise.line_number}`);
+      console.log(`     ${praise.message}\n`);
+    });
+  }
+
+  // --- Issues Section ---
+  if (review && review.issues && review.issues.length > 0) {
+    console.log(chalk.bold.red(`⚠️  Issues Found (${summary.total_issues})`));
+
+    // Severity Summary Table
+    console.log(chalk.underline('Severity Count:'));
+    const severities = ['critical', 'high', 'medium', 'low'];
+    severities.forEach(severity => {
+      const count = summary[severity] || 0;
+      if (count > 0) {
+        const icon = SEVERITY_ICONS[severity];
+        const color = SEVERITY_COLORS[severity];
+        const label = severity.charAt(0).toUpperCase() + severity.slice(1);
+        console.log(`${icon} ${color(label)}: ${count}`);
+      }
+    });
+    console.log(''); // Newline for spacing
+
+    // Issues Details
+    review.issues.forEach((issue, index) => {
+      const severityIcon = SEVERITY_ICONS[issue.severity] || '❓';
+      const severityColor = SEVERITY_COLORS[issue.severity] || chalk.white;
+      const categoryIcon = CATEGORY_ICONS[issue.category] || CATEGORY_ICONS.default;
+      const formattedCategory = formatCategory(issue.category);
+      const absolutePath = toAbsolutePath(issue.file_path);
+
+      console.log(
+        `${severityIcon} ${severityColor(
+          issue.severity.toUpperCase()
+        )} in ${absolutePath}:${issue.line_number} (${categoryIcon} ${formattedCategory})`
+      );
+      console.log(`   ${issue.message}`);
+
+      if (issue.suggested_fix) {
+        console.log(chalk.bold('\n💡 Suggested Fix:'));
+        // Indent the suggested fix for readability
+        const indentedFix = issue.suggested_fix.split('\n').map(line => `   ${line}`).join('\n');
+        console.log(chalk.green(indentedFix));
+      }
+
+      // Add separator between issues (but not after the last one)
+      if (index < review.issues.length - 1) {
+        const terminalWidth = process.stdout.columns || 80;
+        console.log(chalk.gray('─'.repeat(terminalWidth)));
+      }
+      console.log(); // Add a blank line for spacing
+    });
+  }
+}