@san-siva/gitsy 1.0.0 → 1.0.1

package/README.md

@@ -2,52 +2,190 @@
 
 A set of bash utilities for managing Git repositories with ease. Provides user-friendly commands with helpful prompts, color-coded outputs, and automation.
 
+## Documentation
+
+For complete documentation, usage examples, and detailed command reference, visit the [gitsy documentation website](https://gitsy-56895.web.app).
+
+## System Requirements
+
+- Node.js >= 12.0.0
+- Bash shell
+- Git
+- Supported OS: macOS, Linux
+
 ## Available Commands
 
-- `g-co` - Checkout branch
-- `g-pull` - Pull changes from remote
-- `g-push` - Push changes to remote
-- `g-wa` - Create git worktree
-- `g-wr` - Remove git worktree
-- `g-db` - Delete branch
-- `g-dlc` - Discard last commit
-- `g-rmf` - Stash working directory
-- `g-rto` - Reset to remote branch
-- `g-cb` - Show current branch
-- `g-s` - Show git status
-- `g-diff` - Compare branches
+| Command | Description |
+|---------|-------------|
+| `g-s` | Show git status with colorful output |
+| `g-cb` | Display current branch name |
+| `g-co` | Checkout branch with optional stashing |
+| `g-pull` | Pull changes from remote branch |
+| `g-push` | Push changes to remote (supports force push) |
+| `g-wa` | Create git worktree for a branch |
+| `g-wr` | Remove git worktree |
+| `g-db` | Delete branch locally and remotely |
+| `g-dlc` | Discard last commit |
+| `g-rmf` | Stash working directory changes |
+| `g-rto` | Reset to remote branch |
+| `g-diff` | Compare changes between branches |
 
 ## Installation
 
+Install gitsy globally with npm:
+
 ```bash
-git clone https://github.com/san-siva/gitsy.git
-cd gitsy
+npm install -g gitsy
+```
 
-# Add to your PATH in .bashrc or .zshrc
-export PATH="$PATH:/path/to/gitsy"
+That's it! All commands (`g-s`, `g-co`, `g-pull`, etc.) will be available immediately.
+
+### Prerequisites
+
+You'll also need these dependencies installed:
+
+```bash
+# macOS
+brew install git figlet lolcat
+
+# Ubuntu/Debian
+sudo apt-get install git figlet lolcat
+
+# Fedora/RHEL
+sudo dnf install git figlet lolcat
 ```
 
-**Dependencies:** `git`, `figlet`, `lolcat`
+### Verify Installation
 
-## Documentation
+```bash
+g-s --help
+```
 
-For complete documentation, usage examples, and detailed command reference, visit the [gitsy documentation website](https://gitsy-56895.web.app).
+### Troubleshooting
+
+**Commands not found:**
+- Ensure npm global bin directory is in your PATH
+- Try: `npm uninstall -g gitsy && npm install -g gitsy`
+
+**Missing dependencies:**
+- Verify with: `git --version`, `figlet --version`, `lolcat --version`
+
+**Permission errors:**
+- Use `sudo npm install -g gitsy` on some systems
+- Or configure npm user directory: `npm config set prefix ~/.npm-global`
+
+## Usage
+
+All gitsy commands support the `--help` flag for detailed usage information:
 
-Quick start:
 ```bash
-# Run any command with --help to see available options
 g-co --help
 ```
 
+### Quick Examples
+
+**Check git status:**
+```bash
+g-s
+```
+
+**Checkout a branch:**
+```bash
+g-co -t feature-branch
+```
+
+**Create a new worktree:**
+```bash
+g-wa -t new-feature
+```
+
+**Pull latest changes:**
+```bash
+g-pull
+```
+
+**Push changes to remote:**
+```bash
+g-push
+```
+
+**Compare branches:**
+```bash
+g-diff -s main -t feature-branch
+```
+
+For complete command documentation and advanced usage examples, visit the [gitsy documentation website](https://gitsy-56895.web.app).
+
+## Features
+
+- **Interactive prompts** - User-friendly command-line prompts guide you through operations
+- **Color-coded output** - Easy-to-read, colorful terminal output powered by lolcat
+- **Safety checks** - Built-in validations prevent common git mistakes
+- **Automation** - Streamlines complex git workflows into single commands
+- **Worktree management** - Simplified git worktree creation and removal
+- **Branch operations** - Quick branch switching, creation, and deletion
+
 ## Contributing
 
-Contributions are welcome! Please fork the repo and submit pull requests. For bugs or feature requests, open an issue on the repository.
+Contributions are welcome! Here's how to contribute:
+
+### Development Setup
+
+1. **Fork and clone** the repository:
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/gitsy.git
+   cd gitsy
+   ```
+
+2. **Install dependencies** (git, figlet, lolcat)
+
+3. **Link for local development**:
+   ```bash
+   npm link
+   ```
+   This creates symlinks so you can test your changes globally.
+
+4. **Create a feature branch**:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+5. **Make your changes** and test thoroughly
+
+6. **Validate syntax**:
+   ```bash
+   npm test
+   ```
+
+7. **Commit and push**:
+   ```bash
+   git commit -m "Description of your changes"
+   git push origin feature/your-feature-name
+   ```
+
+8. **Create a Pull Request** on GitHub
+
+### Reporting Issues
+
+Found a bug or have a feature request? Please [open an issue](https://github.com/san-siva/gitsy/issues) with:
+- A clear description of the problem or suggestion
+- Steps to reproduce (for bugs)
+- Expected vs actual behavior
+- Your environment (OS, Node version, shell)
 
 ## License
 
-This project is licensed under the MIT License.
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+## Author
+
+**Santhosh Siva**
+- GitHub: [@san-siva](https://github.com/san-siva)
+- Documentation: [gitsy-56895.web.app](https://gitsy-56895.web.app)
 
-## Contact
+## Acknowledgments
 
-Author: Santhosh Siva
-GitHub: https://github.com/san-siva
+Built with:
+- [figlet](http://www.figlet.org/) - ASCII art text generator
+- [lolcat](https://github.com/busyloop/lolcat) - Rainbow colorizer
+- Bash - The GNU Bourne Again Shell

package/g-cb

@@ -6,7 +6,15 @@
 # Description:
 # This script returns the current branch name in a git repository.
 
-source "$(dirname "${BASH_SOURCE[0]}")/utils"
+# Resolve script directory (works with symlinks for npm global install)
+SOURCE="${BASH_SOURCE[0]}"
+while [ -L "$SOURCE" ]; do
+  DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+  SOURCE="$(readlink "$SOURCE")"
+  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE"
+done
+SCRIPT_DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+source "$SCRIPT_DIR/utils"
 
 set_flags() {
 	while [ $# -gt 0 ]; do

package/g-co

@@ -6,7 +6,15 @@
 # Description:
 # A script to checkout branches, optionally stash changes, and manage git workflow efficiently.
 
-source "$(dirname "${BASH_SOURCE[0]}")/utils"
+# Resolve script directory (works with symlinks for npm global install)
+SOURCE="${BASH_SOURCE[0]}"
+while [ -L "$SOURCE" ]; do
+  DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+  SOURCE="$(readlink "$SOURCE")"
+  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE"
+done
+SCRIPT_DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+source "$SCRIPT_DIR/utils"
 
 # Default Values
 stash=false

package/g-db

@@ -6,7 +6,15 @@
 # Description:
 # A script to delete a branch locally and push the deletion to remote.
 
-source "$(dirname "${BASH_SOURCE[0]}")/utils"
+# Resolve script directory (works with symlinks for npm global install)
+SOURCE="${BASH_SOURCE[0]}"
+while [ -L "$SOURCE" ]; do
+  DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+  SOURCE="$(readlink "$SOURCE")"
+  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE"
+done
+SCRIPT_DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+source "$SCRIPT_DIR/utils"
 
 # Default Values
 target_branch=

package/g-diff

@@ -6,7 +6,15 @@
 # Description:
 # A script to compare changes between two git branches.
 
-source "$(dirname "${BASH_SOURCE[0]}")/utils"
+# Resolve script directory (works with symlinks for npm global install)
+SOURCE="${BASH_SOURCE[0]}"
+while [ -L "$SOURCE" ]; do
+  DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+  SOURCE="$(readlink "$SOURCE")"
+  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE"
+done
+SCRIPT_DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+source "$SCRIPT_DIR/utils"
 
 target_branch=""
 source_branch=""

package/g-dlc

@@ -6,7 +6,15 @@
 # Description:
 # A script to discard the last commit with optional force mode.
 
-source "$(dirname "${BASH_SOURCE[0]}")/utils"
+# Resolve script directory (works with symlinks for npm global install)
+SOURCE="${BASH_SOURCE[0]}"
+while [ -L "$SOURCE" ]; do
+  DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+  SOURCE="$(readlink "$SOURCE")"
+  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE"
+done
+SCRIPT_DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+source "$SCRIPT_DIR/utils"
 
 # Default Values
 force_mode=false

package/g-pull

@@ -6,9 +6,15 @@
 # Description:
 # A script to checkout branches, optionally stash changes, and manage git workflow efficiently.
 
-source "$(dirname "${BASH_SOURCE[0]}")/utils"
-
-script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+# Resolve script directory (works with symlinks for npm global install)
+SOURCE="${BASH_SOURCE[0]}"
+while [ -L "$SOURCE" ]; do
+  DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+  SOURCE="$(readlink "$SOURCE")"
+  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE"
+done
+SCRIPT_DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+source "$SCRIPT_DIR/utils"
 
 target_branch=
 do_fetch=false

package/g-push

@@ -6,9 +6,15 @@
 # Description:
 # A script to checkout branches, optionally stash changes, and manage git workflow efficiently.
 
-source "$(dirname "${BASH_SOURCE[0]}")/utils"
-
-script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+# Resolve script directory (works with symlinks for npm global install)
+SOURCE="${BASH_SOURCE[0]}"
+while [ -L "$SOURCE" ]; do
+  DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+  SOURCE="$(readlink "$SOURCE")"
+  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE"
+done
+SCRIPT_DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+source "$SCRIPT_DIR/utils"
 
 target_branch=
 should_force_push=false

package/g-rmf

@@ -7,7 +7,15 @@
 # A script to clear your working directory by stashing changes.
 # The stashed changes is tagged with the current date and time.
 
-source "$(dirname "${BASH_SOURCE[0]}")/utils"
+# Resolve script directory (works with symlinks for npm global install)
+SOURCE="${BASH_SOURCE[0]}"
+while [ -L "$SOURCE" ]; do
+  DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+  SOURCE="$(readlink "$SOURCE")"
+  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE"
+done
+SCRIPT_DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+source "$SCRIPT_DIR/utils"
 
 # Default Values
 tag_message=

package/g-rto

@@ -7,7 +7,15 @@
 # A script to quickly reset your working directory to the latest changes from the remote branch.
 # In case you ran this command by mistake, you can use the `git stash apply` command to restore your changes.
 
-source "$(dirname "${BASH_SOURCE[0]}")/utils"
+# Resolve script directory (works with symlinks for npm global install)
+SOURCE="${BASH_SOURCE[0]}"
+while [ -L "$SOURCE" ]; do
+  DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+  SOURCE="$(readlink "$SOURCE")"
+  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE"
+done
+SCRIPT_DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+source "$SCRIPT_DIR/utils"
 
 set_flags() {
 	while [ $# -gt 0 ]; do

package/g-s

@@ -6,7 +6,15 @@
 # Description:
 # This script returns the current status of the git repository.
 
-source "$(dirname "${BASH_SOURCE[0]}")/utils"
+# Resolve script directory (works with symlinks for npm global install)
+SOURCE="${BASH_SOURCE[0]}"
+while [ -L "$SOURCE" ]; do
+  DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+  SOURCE="$(readlink "$SOURCE")"
+  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE"
+done
+SCRIPT_DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+source "$SCRIPT_DIR/utils"
 
 set_flags() {
 	while [ $# -gt 0 ]; do

package/g-wa

@@ -7,7 +7,15 @@
 # This script creates a new git worktree for a specified branch.
 # If the branch does not exist, it prompts the user to create it.
 
-source "$(dirname "${BASH_SOURCE[0]}")/utils"
+# Resolve script directory (works with symlinks for npm global install)
+SOURCE="${BASH_SOURCE[0]}"
+while [ -L "$SOURCE" ]; do
+  DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+  SOURCE="$(readlink "$SOURCE")"
+  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE"
+done
+SCRIPT_DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+source "$SCRIPT_DIR/utils"
 
 # Default Values
 stash=false

package/g-wr

@@ -7,9 +7,15 @@
 # This script removes a git worktree for a specified branch.
 # It searches through the worktrees directory and removes matching worktrees.
 
-source "$(dirname "${BASH_SOURCE[0]}")/utils"
-
-script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+# Resolve script directory (works with symlinks for npm global install)
+SOURCE="${BASH_SOURCE[0]}"
+while [ -L "$SOURCE" ]; do
+  DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+  SOURCE="$(readlink "$SOURCE")"
+  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE"
+done
+SCRIPT_DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
+source "$SCRIPT_DIR/utils"
 
 # Default Values
 target_branch=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@san-siva/gitsy",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A set of bash utilities for managing Git repositories with ease",
   "keywords": [
     "git",
@@ -57,7 +57,7 @@
   ],
   "scripts": {
     "test": "bash -c 'for script in g-*; do bash -n \"$script\" || exit 1; done'",
-    "postinstall": "echo '\\n✓ gitsy installed successfully!\\n\\nDependencies required: git, figlet, lolcat\\n\\nRun any command with --help to get started:\\n  g-co --help\\n\\nDocumentation: https://gitsy-56895.web.app\\n'"
+    "postinstall": "echo '\\n✓ gitsy installed successfully!\\n\\nDependencies required: git, figlet, lolcat\\n\\nRun any command with --help to get started:\\n  g-s --help\\n\\nQuick example:\\n  g-s      # Show git status\\n\\nDocumentation: https://gitsy-56895.web.app\\n'"
   },
   "engines": {
     "node": ">=12.0.0"