git-devflow 1.0.0

package/README.md

@@ -0,0 +1,179 @@
+# DevFlow 🚀
+
+AI-powered Git workflow automation using GitHub Copilot CLI. Streamline your development workflow with intelligent commit messages, PR descriptions, and branch naming.
+
+[![GitHub Copilot CLI Challenge](https://img.shields.io/badge/GitHub-Copilot_CLI_Challenge-blue)](https://dev.to/challenges/github-2026-01-21)
+
+## ✨ Features
+
+- **🤖 Smart Commit Messages** - AI-generated conventional commit messages from your changes
+- **📝 PR Generation** - Automatic pull request descriptions with summary, changes, and testing notes
+- **🌿 Branch Naming** - Semantic branch names from GitHub issues or descriptions
+- **⚙️ Config Management** - Secure token storage with interactive setup wizard
+- **💰 Cost-Aware Model Selection** - Dynamically fetches available models from Copilot CLI with cost info
+- **🔄 Quota Auto-Retry** - Automatically falls back to a free model when premium requests are exhausted
+- **🔐 Security First** - Tokens never displayed, error messages sanitized, config file locked down
+
+## 🎥 Demo
+
+<img width="1178" height="559" alt="image" src="https://github.com/user-attachments/assets/b1f49000-7ecd-4415-bf69-670c7a1c4b36" />
+
+<img width="1372" height="886" alt="image" src="https://github.com/user-attachments/assets/f04027fb-577d-4152-a9c4-2dfbdb3b6242" />
+
+<img width="1372" height="886" alt="image" src="https://github.com/user-attachments/assets/1c185604-9328-4a97-935f-31cf24b92e4a" />
+
+<img width="1372" height="886" alt="image" src="https://github.com/user-attachments/assets/1ad5c64d-5138-4d3d-b9a4-35a994be7383" />
+
+
+## 📦 Installation
+
+```bash
+npm install -g devflow-cli
+```
+
+## 🔧 Setup
+
+```bash
+# Run interactive setup (single source of truth - no .env file needed)
+devflow config setup
+```
+
+The setup wizard will prompt you for:
+- **GitHub Personal Access Token** - for creating PRs and fetching issues
+- **Preferred AI model** - fetched dynamically from Copilot CLI with cost info
+- **Default base branch** - typically `main` or `develop`
+
+All config is stored securely in `~/.devflow/config.json` with restricted file permissions.
+
+## 🎯 Usage
+
+### Generate Commit Messages
+
+```bash
+# Stage your changes
+git add .
+
+# Generate AI-powered commit message
+devflow commit
+
+# Or stage all changes automatically
+devflow commit -a
+```
+
+Each operation shows the model being used and its cost:
+```
+🤖 Model: claude-sonnet-4.5  Balanced  ·  1 premium request(s) per prompt
+```
+
+### Create Pull Requests
+
+```bash
+# On your feature branch
+devflow pr create
+
+# Specify custom base branch
+devflow pr create --base develop
+```
+
+### Create Branches
+
+```bash
+# From GitHub issue
+devflow branch create --issue 123
+
+# From description
+devflow branch create "add user authentication"
+
+# Interactive mode
+devflow branch create
+```
+
+### Configuration
+
+```bash
+# Show current config
+devflow config show
+
+# Update specific setting
+devflow config set copilotModel claude-haiku-4.5
+
+# Get config value
+devflow config get copilotModel
+
+# Re-run full setup wizard
+devflow config setup
+```
+
+## 🏗️ How It Works
+
+DevFlow uses **GitHub Copilot CLI** as its AI engine:
+
+1. **Commit Command**: Reads `git diff`, sends to Copilot CLI with conventional commit format instructions
+2. **PR Command**: Analyzes commits since branch point, generates structured PR description
+3. **Branch Command**: Fetches GitHub issue or uses description, generates semantic branch name
+
+### Quota Handling
+
+When your premium request quota is exceeded, DevFlow automatically:
+1. Detects the quota error from the Copilot CLI
+2. Retries the request with a **free model** (`gpt-4.1`) at no cost
+3. Suggests switching your default model via `devflow config setup`
+
+If the free model also fails, DevFlow falls back to intelligent rule-based generation.
+
+## 🎨 AI Model Selection
+
+During setup, models are **fetched dynamically** from the Copilot CLI — no hardcoded list. Each model is shown with its cost tier, sorted cheapest-first:
+
+| Tier | Examples | Cost |
+|------|----------|------|
+| **Free** | `gpt-4.1`, `gpt-5-mini` | No premium requests |
+| **Cheap** | `claude-haiku-4.5`, `gpt-5.1-codex-mini` | 0.33x per prompt |
+| **Balanced** | `claude-sonnet-4.5`, `gpt-5.1-codex` | 1x per prompt |
+| **Expensive** | `claude-opus-4.5` | 3x per prompt |
+
+As GitHub adds or removes models, DevFlow automatically reflects the changes.
+
+## 🔐 Security
+
+- GitHub tokens stored in `~/.devflow/config.json` with **600 file permissions** (owner-only)
+- Tokens are **never displayed** in config output, error messages, or logs
+- Sensitive config keys are redacted in `config get` and `config set` output
+- Error messages are sanitized to prevent leaking auth headers or request details
+- No `.env` file required — config setup is the single source of truth
+- Environment variables (`GITHUB_TOKEN`, `GH_TOKEN`) supported as fallback for CI
+
+## 📝 Requirements
+
+- Node.js 18+
+- Git
+- [GitHub Copilot CLI](https://docs.github.com/en/copilot/concepts/agents/about-copilot-cli) (`npm install -g @githubnext/github-copilot-cli`)
+- GitHub account with Copilot access
+
+## Future Enhancements
+
+- [ ] Ollama fallback for offline/quota-exceeded scenarios
+- [ ] Custom prompt templates
+- [ ] Team collaboration features
+
+## 🤝 Contributing
+
+Contributions welcome! This project was built for the [GitHub Copilot CLI Challenge](https://dev.to/challenges/github-2026-01-21).
+
+## 📄 License
+
+MIT
+
+## 🙏 Acknowledgments
+
+Built with ❤️ using:
+
+- [GitHub Copilot CLI](https://githubnext.com/projects/copilot-cli)
+- [Commander.js](https://github.com/tj/commander.js)
+- [Inquirer Prompts](https://github.com/SBoudrias/Inquirer.js)
+- [simple-git](https://github.com/steveukx/git-js)
+- [@octokit/rest](https://github.com/octokit/rest.js)
+
+---
+
+**Made for the GitHub Copilot CLI Challenge 2026** 🚀

package/dist/commands/branch.js

@@ -0,0 +1,113 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.branchCommand = void 0;
+const commander_1 = require("commander");
+const chalk_1 = __importDefault(require("chalk"));
+const prompts_1 = require("@inquirer/prompts");
+const git_js_1 = require("../services/git.js");
+const github_js_1 = require("../services/github.js");
+const copilot_js_1 = require("../services/copilot.js");
+const spinner_js_1 = require("../utils/spinner.js");
+exports.branchCommand = new commander_1.Command('branch')
+    .description('Branch management commands');
+// Create branch command
+exports.branchCommand
+    .command('create [description]')
+    .description('Create a new branch with AI-generated name')
+    .option('-i, --issue <number>', 'Create branch from GitHub issue number')
+    .option('-t, --type <type>', 'Branch type (feature/fix/chore/docs)', 'feature')
+    .action(async (description, options) => {
+    try {
+        const git = new git_js_1.GitService();
+        const github = new github_js_1.GitHubService();
+        await github.init();
+        const copilot = new copilot_js_1.CopilotService();
+        // Check if we're in a git repository
+        const isRepo = await git.isGitRepo();
+        if (!isRepo) {
+            console.log(chalk_1.default.red('❌ Not a git repository'));
+            console.log(chalk_1.default.dim('Run: git init'));
+            process.exit(1);
+        }
+        let branchDescription = description;
+        let branchType = options?.type || 'feature';
+        // Scenario 1: Create from GitHub issue
+        if (options?.issue) {
+            console.log(chalk_1.default.cyan(`\n🔍 Fetching issue #${options.issue}...\n`));
+            const spinner = new spinner_js_1.Spinner('Fetching issue from GitHub...');
+            spinner.start();
+            try {
+                const issue = await github.getIssue(parseInt(options.issue));
+                spinner.succeed(`Found issue: ${issue.title}`);
+                branchDescription = issue.title;
+                console.log(chalk_1.default.dim(`\nIssue: ${issue.title}\n`));
+                // Ask for confirmation
+                const useIssue = await (0, prompts_1.confirm)({
+                    message: 'Use this issue title for branch name?',
+                    default: true
+                });
+                if (!useIssue) {
+                    branchDescription = await (0, prompts_1.input)({
+                        message: 'Enter branch description:',
+                        validate: (value) => value.length > 0 || 'Description cannot be empty'
+                    });
+                }
+            }
+            catch (error) {
+                spinner.fail('Failed to fetch issue');
+                const safeMsg = error instanceof Error ? error.message : 'Could not fetch issue';
+                console.log(chalk_1.default.red(`\n❌ ${safeMsg}\n`));
+                process.exit(1);
+            }
+        }
+        // Scenario 2: No description provided - prompt user
+        if (!branchDescription) {
+            console.log(chalk_1.default.cyan('\n🌿 Create New Branch\n'));
+            branchType = await (0, prompts_1.select)({
+                message: 'Branch type:',
+                choices: [
+                    { name: 'feature - New feature', value: 'feature' },
+                    { name: 'fix - Bug fix', value: 'fix' },
+                    { name: 'chore - Maintenance', value: 'chore' },
+                    { name: 'docs - Documentation', value: 'docs' },
+                    { name: 'refactor - Code refactoring', value: 'refactor' }
+                ]
+            });
+            branchDescription = await (0, prompts_1.input)({
+                message: 'Branch description:',
+                validate: (value) => value.length > 0 || 'Description cannot be empty'
+            });
+        }
+        // Generate branch name with Copilot
+        console.log(chalk_1.default.cyan('\n🤖 Generating branch name...\n'));
+        const spinner = new spinner_js_1.Spinner('Asking Copilot for branch name...');
+        spinner.start();
+        const branchName = await copilot.generateBranchName(branchDescription, branchType, options?.issue);
+        spinner.succeed('Branch name generated');
+        // Show generated name and confirm
+        console.log(chalk_1.default.cyan('\n📝 Generated branch name:'));
+        console.log(chalk_1.default.bold(`   ${branchName}\n`));
+        const shouldCreate = await (0, prompts_1.confirm)({
+            message: `Create and checkout branch "${branchName}"?`,
+            default: true
+        });
+        if (!shouldCreate) {
+            console.log(chalk_1.default.yellow('❌ Branch creation cancelled'));
+            process.exit(0);
+        }
+        // Create and checkout branch
+        const createSpinner = new spinner_js_1.Spinner('Creating branch...');
+        createSpinner.start();
+        await git.createAndCheckoutBranch(branchName);
+        createSpinner.succeed(`Switched to new branch: ${branchName}`);
+        console.log(chalk_1.default.green(`\n✨ Successfully created branch: ${chalk_1.default.bold(branchName)}\n`));
+    }
+    catch (error) {
+        const safeMsg = error instanceof Error ? error.message : 'Something went wrong';
+        console.log(chalk_1.default.red(`\n❌ ${safeMsg}\n`));
+        process.exit(1);
+    }
+});

package/dist/commands/commit.js

@@ -0,0 +1,95 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commitCommand = void 0;
+const commander_1 = require("commander");
+const chalk_1 = __importDefault(require("chalk"));
+const prompts_1 = require("@inquirer/prompts");
+const git_js_1 = require("../services/git.js");
+const copilot_js_1 = require("../services/copilot.js");
+const spinner_js_1 = require("../utils/spinner.js");
+// Force TTY mode for inquirer
+process.stdin.isTTY = true;
+process.stdout.isTTY = true;
+exports.commitCommand = new commander_1.Command('commit')
+    .description('Generate AI-powered commit messages using GitHub Copilot CLI')
+    .option('-a, --all', 'Stage all changes before committing')
+    .action(async (options) => {
+    const git = new git_js_1.GitService();
+    const copilot = new copilot_js_1.CopilotService();
+    try {
+        // Check if we're in a git repo
+        if (!(await git.isGitRepo())) {
+            console.log(chalk_1.default.red('❌ Not a git repository!'));
+            process.exit(1);
+        }
+        // Stage all if --all flag is used
+        if (options.all) {
+            const spinner = new spinner_js_1.Spinner('Staging all changes...');
+            spinner.start();
+            await git.stageAll();
+            spinner.succeed('Staged all changes');
+        }
+        // Check if there are staged changes
+        if (!(await git.hasStagedChanges())) {
+            console.log(chalk_1.default.yellow('⚠️  No staged changes to commit'));
+            console.log(chalk_1.default.dim('Tip: Use `git add <files>` or `devflow commit --all`'));
+            process.exit(0);
+        }
+        // Get the diff
+        const spinner = new spinner_js_1.Spinner('Analyzing changes...');
+        spinner.start();
+        const diff = await git.getStagedDiff();
+        if (!diff) {
+            spinner.fail('No changes detected');
+            process.exit(0);
+        }
+        // Generate commit messages using Copilot CLI
+        spinner.update('🤖 Asking GitHub Copilot CLI for suggestions...');
+        const messages = await copilot.generateCommitMessage(diff);
+        spinner.succeed('Generated commit message options');
+        // Show options to user
+        console.log('\n');
+        const choices = messages.map((msg, idx) => ({
+            name: `${idx + 1}. ${msg}`,
+            value: msg
+        }));
+        choices.push({
+            name: chalk_1.default.dim('✏️  Write custom message'),
+            value: '__custom__'
+        });
+        const selectedMessage = await (0, prompts_1.select)({
+            message: 'Select a commit message:',
+            choices: choices,
+            pageSize: 10
+        });
+        // If custom, ask for message
+        let finalMessage = selectedMessage;
+        if (selectedMessage === '__custom__') {
+            finalMessage = await (0, prompts_1.input)({
+                message: 'Enter your commit message:',
+                validate: (value) => value.length > 0 || 'Commit message cannot be empty'
+            });
+        }
+        // Confirm before committing
+        const shouldCommit = await (0, prompts_1.confirm)({
+            message: `Commit with message: "${finalMessage}"?`,
+            default: true
+        });
+        if (!shouldCommit) {
+            console.log(chalk_1.default.yellow('❌ Commit cancelled'));
+            process.exit(0);
+        }
+        // Create the commit
+        const commitSpinner = new spinner_js_1.Spinner('Creating commit...');
+        commitSpinner.start();
+        await git.commit(finalMessage);
+        commitSpinner.succeed(chalk_1.default.green(`✨ Successfully committed: "${finalMessage}"`));
+    }
+    catch (error) {
+        console.log(chalk_1.default.red(`\n❌ Error: ${error instanceof Error ? error.message : 'Unknown error'}`));
+        process.exit(1);
+    }
+});

package/dist/commands/config.js

@@ -0,0 +1,135 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configCommand = void 0;
+const commander_1 = require("commander");
+const chalk_1 = __importDefault(require("chalk"));
+const prompts_1 = require("@inquirer/prompts");
+const config_js_1 = require("../services/config.js");
+const copilot_js_1 = require("../services/copilot.js");
+exports.configCommand = new commander_1.Command('config')
+    .description('Configure DevFlow settings');
+// Setup wizard
+exports.configCommand
+    .command('setup')
+    .description('Interactive setup wizard')
+    .action(async () => {
+    console.log(chalk_1.default.cyan('\n✨ DevFlow Setup Wizard\n'));
+    console.log(chalk_1.default.yellow('🔒 Security Note:'));
+    console.log(chalk_1.default.dim('Your token will be stored in ~/.devflow/config.json'));
+    console.log(chalk_1.default.dim('with restricted permissions (600 - owner access only)\n'));
+    const config = new config_js_1.ConfigService();
+    const currentConfig = config.load();
+    try {
+        // GitHub Token
+        const needsToken = await (0, prompts_1.confirm)({
+            message: 'Do you want to configure a GitHub token?',
+            default: !config.hasToken()
+        });
+        if (needsToken) {
+            const token = await (0, prompts_1.password)({
+                message: 'Enter your GitHub Personal Access Token:',
+                mask: '*',
+                validate: (value) => {
+                    if (!value)
+                        return 'Token cannot be empty';
+                    if (!value.startsWith('ghp_') && !value.startsWith('github_pat_')) {
+                        return 'Token should start with ghp_ or github_pat_';
+                    }
+                    return true;
+                }
+            });
+            config.set('githubToken', token);
+        }
+        // Copilot Model Selection - fetch available models dynamically
+        const copilot = new copilot_js_1.CopilotService();
+        console.log(chalk_1.default.dim('Fetching available models from Copilot CLI...\n'));
+        const availableModels = await copilot.fetchAvailableModels();
+        // Sort: Free first, then Cheap, Balanced, Expensive, New
+        const tagOrder = {
+            'Free': 0, 'Cheap': 1, 'Balanced': 2, 'Expensive': 3, 'New': 4
+        };
+        const sorted = [...availableModels].sort((a, b) => (tagOrder[a.tag] ?? 99) - (tagOrder[b.tag] ?? 99));
+        const tagColor = (tag) => {
+            switch (tag) {
+                case 'Free': return chalk_1.default.green(tag);
+                case 'Cheap': return chalk_1.default.cyan(tag);
+                case 'Balanced': return chalk_1.default.yellow(tag);
+                case 'Expensive': return chalk_1.default.red(tag);
+                default: return chalk_1.default.dim(tag);
+            }
+        };
+        const model = await (0, prompts_1.select)({
+            message: 'Select your preferred Copilot model:',
+            choices: sorted.map(m => ({
+                name: `${m.id}  ${tagColor(m.tag)}`,
+                value: m.id,
+                description: m.description
+            })),
+            default: currentConfig.copilotModel || config_js_1.DEFAULT_COPILOT_MODEL
+        });
+        config.set('copilotModel', model);
+        // Default base branch
+        const baseBranch = await (0, prompts_1.input)({
+            message: 'Default base branch:',
+            default: currentConfig.defaultBaseBranch || 'main'
+        });
+        config.set('defaultBaseBranch', baseBranch);
+        console.log(chalk_1.default.green('\n✓ Setup complete!\n'));
+        config.display();
+    }
+    catch (error) {
+        console.log(chalk_1.default.yellow('\n❌ Setup cancelled'));
+        process.exit(0);
+    }
+});
+// Show current config
+exports.configCommand
+    .command('show')
+    .description('Show current configuration')
+    .action(() => {
+    const config = new config_js_1.ConfigService();
+    config.display();
+});
+// Keys that should never have their values printed
+const SENSITIVE_KEYS = ['githubToken'];
+// Set individual values
+exports.configCommand
+    .command('set <key> <value>')
+    .description('Set a configuration value')
+    .action((key, value) => {
+    const config = new config_js_1.ConfigService();
+    const validKeys = ['githubToken', 'copilotModel', 'defaultBaseBranch'];
+    if (!validKeys.includes(key)) {
+        console.log(chalk_1.default.red(`❌ Invalid key: ${key}`));
+        console.log(chalk_1.default.dim(`Valid keys: ${validKeys.join(', ')}`));
+        process.exit(1);
+    }
+    config.set(key, value);
+    if (SENSITIVE_KEYS.includes(key)) {
+        console.log(chalk_1.default.green(`✓ ${key} updated`));
+    }
+    else {
+        console.log(chalk_1.default.green(`✓ Set ${key} = ${value}`));
+    }
+});
+// Get individual values
+exports.configCommand
+    .command('get <key>')
+    .description('Get a configuration value')
+    .action((key) => {
+    const config = new config_js_1.ConfigService();
+    const value = config.get(key);
+    if (!value) {
+        console.log(chalk_1.default.yellow(`${key} is not set`));
+        return;
+    }
+    if (SENSITIVE_KEYS.includes(key)) {
+        console.log(chalk_1.default.green('Configured'));
+    }
+    else {
+        console.log(value);
+    }
+});