git-it-done 1.0.3 → 1.1.1

package/readme.md

@@ -1,303 +1,75 @@
-# 🚀 Git-it-done
+# Git-it-Done
 
-A smart, interactive CLI tool that automatically generates meaningful commit messages and streamlines your Git workflow. Built with TypeScript and Clack.js for a beautiful command-line experience.
+Git-it-Done is a guided, interactive Git workspace for the terminal. Choose the task you want to accomplish instead of remembering Git commands; the CLI explains the target, checks for common risks, and asks before it changes anything.
 
-## ✨ Features
+## Install
 
-- 🧠 **Smart Commit Message Generation** - Analyzes your changes to create conventional commit messages
-- 🎨 **Beautiful Interactive CLI** - Modern prompts with colors, spinners, and emojis
-- 🔍 **File Selection** - Choose which files to stage and commit
-- ✏️ **Flexible Messaging** - Use generated, custom, or edited commit messages
-- 🚀 **Auto-Push** - Optionally push changes to remote repository
-- 🛡️ **Comprehensive Error Handling** - Handles edge cases gracefully
-- 📊 **Visual Status Display** - Color-coded file changes and status
-
-## 🎯 Use Cases
-
-**Perfect for:**
-- ✅ Ongoing projects with existing Git repositories
-- ✅ Quick commits with meaningful messages
-- ✅ Streamlined development workflow
-- ✅ Teams following conventional commit standards
-
-**Not intended for:**
-- ❌ Setting up new repositories (follow GitHub's setup instructions)
-- ❌ Complex Git operations (pull, rebase, revert, merge conflicts)
-- ❌ Repository initialization or first commits
-
-## 📋 Prerequisites
-
-- **Node.js** >= 16.0.0
-- **Git** installed and configured
-- **Existing Git repository** with proper setup
-
-### Git Configuration Required
+```bash
+npm install -g git-it-done
+```
 
-Ensure your Git user is configured:
+Git-it-Done requires Node.js 16+, Git, and a configured Git name and email.
 
 ```bash
 git config --global user.name "Your Name"
-git config --global user.email "your.email@example.com"
+git config --global user.email "you@example.com"
 ```
 
-## 🛠️ Installation
-
+Run it from any existing Git repository:
 
 ```bash
-
-npm install -g git-it-done
-
+git-it-done
 ```
 
+Run it in a normal folder to initialize Git through the same guided UI. It can configure a repository-local identity, create an initial `README.md` for an empty folder, make the first commit, and optionally add and push to a remote.
 
+## The guided workspace
 
-## 🚦 Quick Start
-
-1. **Navigate to your project directory** (must be a Git repository):
-   ```bash
-   cd your-project
-   ```
-
-2. **Run the auto-committer**:
-   ```bash
-   auto-commit
-   ```
-
-3. **Follow the interactive prompts**:
-   - View repository status
-   - Choose files to stage (if needed)
-   - Select commit message option
-   - Confirm and commit
-   - Optionally push to remote
+The default screen shows your branch, working-tree state, remote/upstream, sync status, and any in-progress Git operation. Choose from:
 
-## 🎮 Usage Examples
+- **Commit changes** — select files, generate or write a Conventional Commit message, confirm, and optionally push.
+- **Sync with remote** — fetches first, then safely offers a fast-forward-only pull or a push. Diverged branches are explained instead of changed automatically.
+- **Push current branch** — detects the upstream, warns when pushing directly to protected branch names, and can create a missing upstream.
+- **Manage branches** — list, switch, or create validated branch names. It never deletes, merges, or rebases branches.
+- **Save or restore work** — create, list, apply, pop, or drop stashes through prompts.
+- **Resolve an in-progress operation** — guides merge, rebase, cherry-pick, revert, and bisect recovery.
+- **Inspect repository** — shows recent commits, remotes, conflict files, and a plain-language state summary.
 
-### Basic Workflow
+For a direct commit-only entry point, use:
 
 ```bash
-$ auto-commit
-
-┌  Auto Commit Tool
-│
-◇  📁 Repository Status:
-│  
-│  Unstaged files:
-│    ~ modified src/auth.ts
-│    + added tests/auth.test.ts
-│
-◇  No files are staged. What would you like to do?
-│  ● Stage all changes
-│  ○ Select files to stage
-│  ○ Cancel
-│
-◇  How would you like to create the commit message?
-│  ● Use generated: "feat(src): add authentication functionality"
-│  ○ Write custom message
-│  ○ Edit generated message
-│
-◇  Commit with message: "feat(src): add authentication functionality"?
-│  Yes
-│
-◆  ✅ Changes committed successfully!
-│  Last commit: abc1234 feat(src): add authentication functionality
-│
-◇  Push to remote repository?
-│  Yes
-│
-◆  🚀 Changes pushed successfully!
-│
-└  🎉 All done!
-```
-
-### Generated Commit Message Examples
-
-The tool analyzes your changes and generates conventional commit messages:
-
-- `feat(auth): add user authentication system`
-- `fix(api): resolve validation errors`
-- `docs: update API documentation`
-- `style(ui): improve button styling`
-- `test(auth): add authentication tests`
-- `deps: update dependencies`
-- `config: update build configuration`
-
-## 🏗️ Project Structure
-
-```
-auto-committer/
-├── index.ts                     # Main entry point
-├── package.json                 # Dependencies and scripts
-├── utils/
-│   ├── checkGitStatus.ts        # Git validation
-│   ├── displayStatus.ts         # Repository status display
-│   ├── fileStaging.ts          # File staging logic
-│   ├── commitMessage.ts        # Commit message handling
-│   ├── performCommit.ts        # Commit execution
-│   ├── pushToRemote.ts         # Push to remote logic
-│   ├── gitCommand.ts           # Git command utilities
-│   ├── getFileChanges.ts       # File change detection
-│   ├── generateCommitMessage.ts # Smart message generation
-│   ├── formatFileStatus.ts     # File status formatting
-│   ├── process_interruption.ts # Process handling
-│   └── types/
-│       └── types.ts            # TypeScript definitions
+git-it-done commit
 ```
 
-## 🔧 Configuration
-
-The tool works out of the box but respects your Git configuration:
-
-- **Git user settings** - Uses your configured name and email
-- **Remote repositories** - Detects and uses existing remotes
-- **Branch settings** - Works with your current branch
-
-## 🎨 Commit Message Generation
-
-The smart commit message generator analyzes:
-
-### File Types
-- `.js`, `.ts` → JavaScript/TypeScript changes
-- `.css`, `.scss` → Styling changes
-- `.md` → Documentation changes
-- `.json`, `.yaml` → Configuration changes
-- `test/`, `spec/` → Test changes
-
-### Change Patterns
-- **New files** → `feat:` (feature)
-- **Modified files** → `fix:` or `feat:` based on content
-- **Deleted files** → `remove:`
-- **Test files** → `test:`
-- **Documentation** → `docs:`
-- **Dependencies** → `deps:`
-
-### Content Analysis
-- Function/class additions → `feat:`
-- Bug fixes → `fix:`
-- Refactoring → `refactor:`
-- Style changes → `style:`
-
-## 🚨 Error Handling
+## Conflict recovery
 
-The tool handles common scenarios gracefully:
+When a merge, rebase, cherry-pick, or revert is already in progress, Git-it-Done surfaces it in the menu rather than leaving you to decipher Git status output. It lists unresolved files and lets you:
 
-### Repository Issues
-- **Not in Git repo** → Clear error message
-- **Git not installed** → Installation guidance
-- **User not configured** → Configuration commands
+1. Open a selected file in `GIT_EDITOR`, `VISUAL`, or `EDITOR`.
+2. Mark a manually resolved file as staged.
+3. Continue after every conflict is staged.
+4. Abort the operation after a clear confirmation.
 
-### File Issues
-- **No changes** → Friendly "nothing to commit" message
-- **Staging failures** → Retry suggestions
-- **Empty commits** → Prevention and guidance
+Git-it-Done does not guess how code should be merged. You decide the correct resolution; the CLI keeps the Git state and next steps visible.
 
-### Remote Issues
-- **No remote configured** → Skip push with notification
-- **Push failures** → Helpful error messages and suggestions
-- **Network issues** → Clear error reporting
+## Safety guarantees
 
-## 🛡️ Limitations
+- Git commands run with literal argument arrays, never through a shell.
+- Every state-changing workflow identifies its branch, stash, file, or remote target and requests confirmation.
+- It will not force-push, delete branches, automate a merge/rebase, or overwrite local work.
+- Pulls use `--ff-only`; a dirty worktree is asked to be committed or stashed first.
+- Git failures are shown with the native Git output plus a plain-language next step where one is known.
 
-This tool is designed for **ongoing projects** and has intentional limitations:
-
-### What it DOES NOT handle:
-- ❌ **Repository initialization** - Use `git init` and follow GitHub's setup guide
-- ❌ **First commits** - Use standard Git commands for initial setup
-- ❌ **Pulling changes** - Use `git pull` manually
-- ❌ **Rebasing** - Use `git rebase` for complex history management
-- ❌ **Reverting commits** - Use `git revert` for undoing changes
-- ❌ **Merge conflicts** - Resolve manually with Git tools
-- ❌ **Branch management** - Use Git commands for branch operations
-
-### What it DOES handle:
-- ✅ **Smart commit message generation**
-- ✅ **File staging and selection**
-- ✅ **Commit execution**
-- ✅ **Push to existing remotes**
-- ✅ **Error prevention and guidance**
-
-## 🤝 Contributing
-
-We welcome contributions! Please follow these steps:
-
-1. Fork the repository
-2. Create a feature branch: `git checkout -b feature/amazing-feature`
-3. Make your changes
-4. Test thoroughly
-5. Commit with conventional messages: `feat: add amazing feature`
-6. Push to your branch: `git push origin feature/amazing-feature`
-7. Open a Pull Request
-
-### Development Setup
+## Development
 
 ```bash
-# Clone your fork
-git clone <your-fork-url>
-cd auto-committer
-
-# Install dependencies
 npm install
-
-# Run in development mode
+npm test
 npm run dev
-
-# Build for production
-npm run build
-```
-
-## 📊 Dependencies
-
-- **[@clack/prompts](https://github.com/natemoo-re/clack)** - Beautiful CLI prompts
-- **[chalk](https://github.com/chalk/chalk)** - Terminal colors and styling
-- **TypeScript** - Type safety and modern JavaScript features
-
-## 📝 License
-
-MIT License - see [LICENSE](LICENSE) file for details.
-
-## 🆘 Troubleshooting
-
-### Common Issues
-
-**"Not in a git repository"**
-```bash
-# Make sure you're in a Git repository
-git status
-# If not initialized, use:
-git init
-```
-
-**"Git user not configured"**
-```bash
-git config --global user.name "Your Name"
-git config --global user.email "your.email@example.com"
-```
-
-**"No remote repository configured"**
-```bash
-# Add a remote repository
-git remote add origin <repository-url>
-```
-
-**"Failed to push"**
-```bash
-# Set upstream branch
-git push --set-upstream origin main
 ```
 
-### Getting Help
-
-1. Check this README for common solutions
-2. Ensure your Git repository is properly set up
-3. Verify you have the required Node.js version
-4. Check that Git is installed and in your PATH
-
-
-## 🙏 Acknowledgments
-
-- [Clack.js](https://github.com/natemoo-re/clack) for the beautiful CLI interface
-- [Conventional Commits](https://www.conventionalcommits.org/) for the commit message standard
-- The open-source community for inspiration and tools
+`npm test` compiles TypeScript and runs the Node test suite.
 
----
+## License
 
-**Made with ❤️ for developers who love clean commit histories**
+[MIT](LICENSE)

package/dist/utils/isGitrepo.d.ts

@@ -1 +0,0 @@
-export declare function isGitRepo(): boolean;

package/dist/utils/isGitrepo.js

@@ -1,6 +0,0 @@
-import { gitCommand } from "./gitCommand.js";
-// Check if we're in a git repository
-export function isGitRepo() {
-    return !!gitCommand('rev-parse --git-dir');
-}
-//# sourceMappingURL=isGitrepo.js.map

package/dist/utils/isGitrepo.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"isGitrepo.js","sourceRoot":"","sources":["../../src/utils/isGitrepo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,qCAAqC;AACrC,MAAM,UAAU,SAAS;IACvB,OAAO,CAAC,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAC7C,CAAC"}