guito 0.2.1 → 0.3.0

package/QUICK_START.md

@@ -0,0 +1,223 @@
+# Guito - Quick Reference Guide
+
+## Getting Started
+
+### Launch the App
+```bash
+npm run dev        # Development with hot reload
+npm run build:start # Build and start production
+npm start          # Start pre-built server
+```
+
+The app opens automatically in your browser at `http://localhost:8080`
+
+## Features by Category
+
+### 📝 Staging & Commits
+**Header Icon:** Check Circle
+
+1. **Stage/Unstage Files**
+   - Click "Stage/Unstage Files" button
+   - Select files to stage or unstage
+   - Supports partial file staging via patch mode
+
+2. **Create Commit**
+   - Click "Commit" button
+   - Enter commit message (required)
+   - Add optional description
+   - Click "Commit" to save
+
+3. **Amend Last Commit**
+   - Click "Amend" button
+   - Modify the message/description
+   - Changes are applied to the last commit
+
+4. **Revert Commit**
+   - Click "Revert" button
+   - Enter commit hash to revert
+   - Creates new commit that undoes changes
+
+### 🌿 Branch Management
+**Header Icon:** Fork
+
+1. **View & Switch Branches**
+   - Click "Branches" button
+   - Current branch highlighted in blue
+   - Click "Checkout" to switch branches
+   - Click delete icon to remove branches
+   - Click "New Branch" to create
+
+2. **Create Branch**
+   - Click "New Branch" in Branches dialog
+   - Enter branch name
+   - Branches from current commit
+
+3. **Merge Branch**
+   - Click "Merge" button
+   - Enter branch name to merge
+   - Current branch gets merged changes
+
+4. **Rebase Branch**
+   - Click "Rebase" button
+   - Enter branch to rebase onto
+   - Replays current commits on target branch
+
+### 📦 Stash
+**Header Icon:** Inventory Box
+
+1. **Create Stash**
+   - Click "Stash" button
+   - Enter description for changes
+   - Click "Save"
+   - Working directory is cleaned
+
+2. **Restore from Stash**
+   - Click "Stash" button
+   - Click "Apply" to keep stash or "Pop" to remove it
+   - Changes are restored to working directory
+
+3. **Preview Stash**
+   - Click "Stash" button
+   - Click eye icon to see what's in stash
+   - Shows file diffs without applying
+
+4. **Delete Stash**
+   - Click "Stash" button
+   - Click delete icon to permanently remove
+
+### 🏷️ Tags
+**Header Icon:** Label
+
+1. **Create Tag**
+   - Click "Tags" button
+   - Enter tag name
+   - Optionally check "Annotated tag" for message
+   - Click "Create Tag"
+
+2. **View Tags**
+   - Click "Tags" button
+   - All tags listed with delete option
+   - Tags mark specific commits for releases
+
+3. **Delete Tag**
+   - Click "Tags" button
+   - Click delete icon next to tag name
+
+### 🔄 Remote Operations
+**Header Icons:** Cloud icons (Fetch, Pull, Push)
+
+1. **Fetch from Remote**
+   - Click "Fetch" button
+   - Updates remote tracking branches
+   - Safe operation - no local changes
+
+2. **Pull from Remote**
+   - Click "Pull" button
+   - Fetches and merges remote changes
+   - Equivalent to fetch + merge
+
+3. **Push to Remote**
+   - Click "Push" button
+   - Sends local commits to remote
+   - Updates remote branch
+
+## Header Layout
+
+```
+[Menu] Guito               Branch: main
+
+[Staging]      [Commits]              [Branches]         [Stash/Tags]  [Remote]
+ 📋            📝 📝(Amend) ↩️        🌿  🔀  ↻          📦  🏷️      ☁️↓ ☁️↑ ☁️↔️
+Stage          Commit Amend  Revert   Branches Merge Rebase Stash Tags Fetch Pull Push
+```
+
+## Keyboard Tips
+
+- **Commit Dialog**: Enter to submit (with valid message)
+- **Selection**: Click checkboxes to select files
+- **Dialogs**: Escape to close (on most)
+
+## Error Handling
+
+All operations show error messages if something goes wrong:
+- Missing required info (message, branch names)
+- Git command failures
+- Network issues with remote operations
+
+## Common Workflows
+
+### Create & Commit Work
+1. Make changes to files
+2. Click "Stage/Unstage Files"
+3. Select files you want to commit
+4. Click "Commit"
+5. Enter message and click "Commit"
+
+### Create a Feature Branch
+1. Click "Branches"
+2. Click "New Branch"
+3. Enter branch name (e.g., "feature/new-ui")
+4. Click "Create Branch"
+
+### Save Work Temporarily
+1. Click "Stash"
+2. Enter description
+3. Click "Save"
+4. Switch to another branch or pull
+5. Come back and click "Pop" to restore
+
+### Release with Tag
+1. Make sure commits are pushed
+2. Click "Tags"
+3. Enter tag name (e.g., "v1.0.0")
+4. Check "Annotated tag" for release notes
+5. Click "Create Tag"
+
+### Merge Completed Feature
+1. Click "Branches"
+2. Checkout main/master branch
+3. Go back to header
+4. Click "Merge"
+5. Enter feature branch name
+6. Resolve any conflicts if needed
+
+## Status Indicators
+
+- **Branch Name (Blue, Bold)**: Currently checked out branch
+- **Green Files**: Staged files ready to commit
+- **(current)**: Shows which branch you're on
+- **Preview**: Shows what changes are in a stash
+
+## Tips & Tricks
+
+- Always review what you're staging before committing
+- Use stash to save incomplete work before switching branches
+- Annotated tags with messages are better for releases
+- Fetch regularly to stay updated with remote changes
+- Use descriptive commit messages and branch names
+
+## Troubleshooting
+
+**"Checkout failed"** 
+- Ensure working directory is clean (stage/stash changes)
+- Branch might not exist
+
+**"Merge failed"**
+- Might have conflicts to resolve
+- Ensure both branches have commits
+
+**"Push failed"**
+- Check network connection
+- Ensure you have permissions on remote
+- May need to pull first
+
+**"No changes to stage"**
+- Working directory is clean
+- All changes are already staged
+
+## Next Steps
+
+- Explore stash for temporary work
+- Use branches for different features
+- Tag releases for easy reference
+- Push/Pull regularly to stay in sync

package/README.md

@@ -32,6 +32,10 @@ No arguments for now.
 
 ## Changelog
 
+**Version 0.3:**
+
+- added more git functionalities
+
 **Version 0.2:**
 
 - added header and table components

package/bin/index.js

@@ -1,50 +1,400 @@
-#! /usr/bin/env node
-import { dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
-import fastify from 'fastify';
-import fastifyStatic from '@fastify/static';
-import fastifyCors from '@fastify/cors';
-import open from 'open';
-import simpleGit from 'simple-git';
-void (async function main() {
-    // Calculate dirname
-    const __dirname = dirname(fileURLToPath(import.meta.url));
-    // Get port number
-    const portArgIndex = process.argv.findIndex((a) => a.toLowerCase() === '--port');
-    const port = portArgIndex !== -1 ? +process.argv[portArgIndex + 1] : 8080;
-    // Get if should not open browser
-    const shouldOpenBrowser = process.argv.findIndex((a) => a.toLowerCase() === '--no-open') === -1;
-    // Initialize server
-    const app = fastify({
-        logger: false,
-    });
-    // Register cors
-    await app.register(fastifyCors);
-    // Register static file provider
-    app.register(fastifyStatic, {
-        root: join(__dirname, 'ui'),
-    });
-    // Serve UI
-    app.get('/', (_req, resp) => resp.sendFile('index.html'));
-    // Initialize git lib
-    const git = simpleGit(process.cwd());
-    // Git Api
-    app.get('/api/commits', (_req, resp) => {
-        git.log({}, (err, data) => {
-            resp.type('application/json').send(data.all);
-        });
-    });
-    app.get('/api/fetch', (_req, resp) => {
-        git.fetch({}, (err, data) => {
-            resp.type('application/json').send();
-        });
-    });
-    // Run the server
-    app.listen({ port }, (err, address) => {
-        if (err)
-            throw err;
-        console.log(`Visit "${address}" to see git explorer.`);
-        if (shouldOpenBrowser)
-            open(address);
-    });
-})();
+#! /usr/bin/env node
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import fastify from 'fastify';
+import fastifyStatic from '@fastify/static';
+import fastifyCors from '@fastify/cors';
+import open from 'open';
+import simpleGit from 'simple-git';
+void (async function main() {
+    // Calculate dirname
+    const __dirname = dirname(fileURLToPath(import.meta.url));
+    // Get port number
+    const portArgIndex = process.argv.findIndex((a) => a.toLowerCase() === '--port');
+    const port = portArgIndex !== -1 ? +process.argv[portArgIndex + 1] : 8080;
+    // Get if should not open browser
+    const shouldOpenBrowser = process.argv.findIndex((a) => a.toLowerCase() === '--no-open') === -1;
+    // Initialize server
+    const app = fastify({
+        logger: false,
+    });
+    // Register cors
+    await app.register(fastifyCors);
+    // Register static file provider
+    app.register(fastifyStatic, {
+        root: join(__dirname, 'ui'),
+    });
+    // Serve UI
+    app.get('/', (_req, resp) => resp.sendFile('index.html'));
+    // Initialize git lib
+    const git = simpleGit(process.cwd());
+    // ==================== Commits ====================
+    app.get('/api/commits', (_req, resp) => {
+        git.log({}, (err, data) => {
+            resp.type('application/json').send(data.all);
+        });
+    });
+    app.post('/api/commit', async (req, resp) => {
+        try {
+            const { message, description } = req.body;
+            await git.commit([message, ...(description ? [description] : [])], { '--allow-empty': null });
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/amend', async (req, resp) => {
+        try {
+            const { message, description } = req.body;
+            await git.commit([message, ...(description ? [description] : [])], {
+                '--amend': null,
+                '--no-edit': null,
+            });
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/revert', async (req, resp) => {
+        try {
+            const { commit } = req.body;
+            await git.revert(commit);
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    // ==================== Staging ====================
+    app.get('/api/status', async (_req, resp) => {
+        try {
+            const status = await git.status();
+            resp.type('application/json').send(status);
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/stage', async (req, resp) => {
+        try {
+            const { files } = req.body;
+            if (Array.isArray(files) && files.length > 0) {
+                await git.add(files);
+            }
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/unstage', async (req, resp) => {
+        try {
+            const { files } = req.body;
+            if (Array.isArray(files) && files.length > 0) {
+                await git.reset(['HEAD', ...files]);
+            }
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/stage-lines', async (req, resp) => {
+        try {
+            const { file, patch } = req.body;
+            // Stage specific lines using git add -p equivalent (patch mode)
+            await git.raw('add --patch', { input: patch });
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    // ==================== Branches ====================
+    app.get('/api/branches', async (_req, resp) => {
+        try {
+            const branchSummary = await git.branchLocal();
+            resp.type('application/json').send(branchSummary);
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/branch/create', async (req, resp) => {
+        try {
+            const { name, startPoint } = req.body;
+            await git.branch([...(startPoint ? [name, startPoint] : [name])]);
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/branch/delete', async (req, resp) => {
+        try {
+            const { name, force } = req.body;
+            await git.deleteLocalBranch(name, force);
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/branch/rename', async (req, resp) => {
+        try {
+            const { oldName, newName } = req.body;
+            await git.branch(['-m', oldName, newName]);
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/checkout', async (req, resp) => {
+        try {
+            const { ref } = req.body;
+            await git.checkout(ref);
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    // ==================== Merge & Rebase ====================
+    app.post('/api/merge', async (req, resp) => {
+        try {
+            const { branch } = req.body;
+            await git.merge([branch]);
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/rebase', async (req, resp) => {
+        try {
+            const { branch } = req.body;
+            await git.rebase([branch]);
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/squash', async (req, resp) => {
+        try {
+            const { commits } = req.body;
+            // Squash: rebase -i with squash operation
+            await git.rebase(['-i', 'HEAD~' + commits]);
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    // ==================== Stash ====================
+    app.get('/api/stash/list', async (_req, resp) => {
+        try {
+            const stashList = await git.stashList();
+            resp.type('application/json').send(stashList);
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/stash/save', async (req, resp) => {
+        try {
+            const { message } = req.body;
+            await git.stash(['save', message || '']);
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/stash/apply', async (req, resp) => {
+        try {
+            const { index } = req.body;
+            await git.stash(['apply', `stash@{${index}}`]);
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/stash/pop', async (req, resp) => {
+        try {
+            const { index } = req.body;
+            await git.stash(['pop', `stash@{${index}}`]);
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/stash/drop', async (req, resp) => {
+        try {
+            const { index } = req.body;
+            await git.stash(['drop', `stash@{${index}}`]);
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/stash/show', async (req, resp) => {
+        try {
+            const { index } = req.body;
+            const show = await git.stash(['show', '-p', `stash@{${index}}`]);
+            resp.type('application/json').send({ preview: show });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    // ==================== Tags ====================
+    app.get('/api/tags', async (_req, resp) => {
+        try {
+            const tags = await git.tags();
+            resp.type('application/json').send(tags);
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/tag/create', async (req, resp) => {
+        try {
+            const { name, message, commit } = req.body;
+            if (message) {
+                await git.tag(['-a', name, '-m', message, ...(commit ? [commit] : [])]);
+            }
+            else {
+                await git.tag([name, ...(commit ? [commit] : [])]);
+            }
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/tag/delete', async (req, resp) => {
+        try {
+            const { name } = req.body;
+            await git.tag(['-d', name]);
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    // ==================== Remote Operations ====================
+    app.get('/api/fetch', (_req, resp) => {
+        git.fetch({}, (err, data) => {
+            resp.type('application/json').send();
+        });
+    });
+    app.post('/api/pull', async (req, resp) => {
+        try {
+            const { remote, branch } = req.body;
+            await git.pull(remote || 'origin', branch || undefined);
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/push', async (req, resp) => {
+        try {
+            const { remote, branch, force } = req.body;
+            await git.push(remote || 'origin', branch || undefined, force ? { '-f': null } : {});
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    app.post('/api/prune', async (req, resp) => {
+        try {
+            const { remote } = req.body;
+            await git.remote(['prune', remote || 'origin']);
+            resp.type('application/json').send({ success: true });
+        }
+        catch (err) {
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    // ==================== Diff Viewer ====================
+    app.post('/api/commit/diff', async (req, resp) => {
+        try {
+            const { hash } = req.body;
+            if (!hash) {
+                return resp.status(400).type('application/json').send({ error: 'hash required' });
+            }
+            // Get raw diff using git show
+            const rawDiff = await git.show([hash]);
+            // Split by file sections (diff --git lines)
+            const files = [];
+            const sections = rawDiff.split(/(?=^diff --git)/m);
+            for (const section of sections) {
+                if (!section.trim())
+                    continue;
+                // Extract filename from "diff --git a/path b/path"
+                const fileMatch = section.match(/^diff --git a\/(.*?) b\/(.*)$/m);
+                if (!fileMatch)
+                    continue;
+                const filepath = fileMatch[2];
+                // Extract the actual diff content
+                const contentMatch = section.match(/^@@ .+? @@\s*\n([\s\S]*?)(?=^diff --git|$)/m);
+                if (!contentMatch) {
+                    // File may be binary or new
+                    files.push({
+                        path: filepath,
+                        original: '',
+                        modified: '',
+                        isBinary: section.includes('Binary files'),
+                    });
+                    continue;
+                }
+                const diffContent = contentMatch[1];
+                let original = '';
+                let modified = '';
+                // Parse unified diff format
+                const diffLines = diffContent.split('\n');
+                for (const line of diffLines) {
+                    if (line.startsWith('-') && !line.startsWith('---')) {
+                        original += line.substring(1) + '\n';
+                    }
+                    else if (line.startsWith('+') && !line.startsWith('+++')) {
+                        modified += line.substring(1) + '\n';
+                    }
+                    else if (!line.startsWith('\\')) {
+                        // Context lines appear in both
+                        const contextLine = line.substring(1) + '\n';
+                        original += contextLine;
+                        modified += contextLine;
+                    }
+                }
+                files.push({
+                    path: filepath,
+                    original: original.trimEnd(),
+                    modified: modified.trimEnd(),
+                });
+            }
+            resp.type('application/json').send({ hash, files });
+        }
+        catch (err) {
+            console.error('Diff error:', err.message);
+            resp.status(400).type('application/json').send({ error: err.message });
+        }
+    });
+    // Run the server
+    app.listen({ port }, (err, address) => {
+        if (err)
+            throw err;
+        console.log(`Visit "${address}" to see git explorer.`);
+        if (shouldOpenBrowser)
+            open(address);
+    });
+})();