@traisetech/autopilot 0.1.7 → 0.1.8

package/CHANGELOG.md

@@ -1,67 +1,92 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-This project follows [Semantic Versioning](https://semver.org).
-
-## [0.1.7] - 2026-02-01
-
-### Added
-- **CLI Update Notifier**:
-  - Automatically checks for new versions on npm registry (once every 24 hours).
-  - Zero-dependency implementation using native Node.js `https`.
-  - Non-intrusive visual notification box on startup when updates are available.
-- **Documentation**:
-  - Added live NPM download statistics to landing page and documentation sidebar.
-  - Enhanced install command widget with one-click copy.
-
-## [0.1.6] - 2026-02-01
-
-### Added
-- **Smart Commit Generator 2.0**:
-  - Offline diff parsing using `git diff` (no external APIs).
-  - Conventional Commits compliance (`feat`, `fix`, `docs`, `style`, `test`).
-  - Intelligent scope detection for UI, Theme, Search, and Docs.
-  - Golden Test Suite with 10 fixtures for guaranteed message quality.
-- **Developer Experience**:
-  - Added `npm run verify` script for pre-release checks.
-  - Improved Windows path normalization for reliable cross-platform usage.
-
-### Changed
-- **Performance**: Switched from file-based status checks to staged diff analysis for commit messages.
-- **Logic**: Reordered commit type priority (Style > Src > Test > Docs) to prevent misclassification of mixed changes.
-- **Fix**: Resolved issue where new files were incorrectly flagged as `fix` instead of `feat`.
-
-## [0.1.4] - 2026-02-01
-
-### Fixed
-- **Windows Compatibility**: Fixed critical issue where absolute paths on Windows caused ignore rules to fail.
-- **Watcher Noise**: Fixed infinite commit loops caused by `.vscode/time-analytics.json` and self-logging.
-- **CLI Crash**: Resolved `autopilot start` failure due to miswired Commander action handlers.
-
-### Added
-- **Release Gates**: Added `npm run verify` and `prepublishOnly` hooks to prevent broken releases.
-- **Integration Tests**: Added full end-to-end test suite using `node:test`.
-- **Smart Init**: `autopilot init` now automatically adds `autopilot.log` to `.gitignore`.
-- **Diagnostics**: Added `autopilot doctor` for environment health checks.
-
-## [0.1.3] - 2026-01-31
-
-### Added
-- **Initial Public Release**: First stable release on npm as `@traisetech/autopilot`.
-- **Core Features**:
-  - Intelligent auto commit & push.
-  - Background watcher with debouncing.
-  - Branch protection (blocks commits to `main`/`master` by default).
-  - Remote-ahead safety checks.
-  - Per-project configuration via `.autopilotrc.json`.
-
-## [0.1.1]
-
-### Changed
-- **Package Hygiene**: Renamed package scope.
-- **Distribution**: Added `files` whitelist to `package.json` to reduce install size.
-
-## [0.1.0]
-
-### Added
-- **Prototype**: Initial development release with core architecture.
+# Changelog
+
+All notable changes to this project will be documented in this file.
+This project follows [Semantic Versioning](https://semver.org).
+
+## [0.1.8] - 2026-02-04
+
+### Reliability & Core
+- **Watcher Engine Overhaul**:
+  - Implemented dual ignore checks (chokidar + internal matcher) to guarantee no ignored files trigger builds.
+  - Added "Max Wait" fallback (60s) to prevent debounce starvation on busy repos.
+  - Hardcoded critical ignores (`.git`, `node_modules`, `autopilot.log`) to prevent infinite loops.
+- **Git Safety**:
+  - Added graceful fallback for push failures (logs warning instead of crashing).
+  - Enforced "tracked only" commits using `git status --porcelain`.
+- **Test Mode**:
+  - Added `AUTOPILOT_TEST_MODE=1` flag for deterministic CI testing (foreground run + auto-exit).
+
+### CI/CD & Standards
+- **GitHub Workflows**:
+  - `ci.yml`: Automated testing on Windows, Ubuntu, and macOS for every PR.
+  - `release.yml`: Automated GitHub Releases with changelog generation and tarball assets.
+  - `publish.yml`: Secure npm publishing via OIDC provenance.
+- **Repository Standards**:
+  - Added Issue Templates (Bug/Feature), PR Template, `SECURITY.md`, and `CODEOWNERS`.
+
+### Fixed
+- **Windows Paths**: Fixed path normalization issues causing ignore rules to fail on Windows.
+- **Self-Triggering**: Fixed issue where writing `autopilot.log` could trigger a new commit loop.
+
+## [0.1.7] - 2026-02-01
+
+### Added
+- **CLI Update Notifier**:
+  - Automatically checks for new versions on npm registry (once every 24 hours).
+  - Zero-dependency implementation using native Node.js `https`.
+  - Non-intrusive visual notification box on startup when updates are available.
+- **Documentation**:
+  - Added live NPM download statistics to landing page and documentation sidebar.
+  - Enhanced install command widget with one-click copy.
+
+## [0.1.6] - 2026-02-01
+
+### Added
+- **Smart Commit Generator 2.0**:
+  - Offline diff parsing using `git diff` (no external APIs).
+  - Conventional Commits compliance (`feat`, `fix`, `docs`, `style`, `test`).
+  - Intelligent scope detection for UI, Theme, Search, and Docs.
+  - Golden Test Suite with 10 fixtures for guaranteed message quality.
+- **Developer Experience**:
+  - Added `npm run verify` script for pre-release checks.
+  - Improved Windows path normalization for reliable cross-platform usage.
+
+### Changed
+- **Performance**: Switched from file-based status checks to staged diff analysis for commit messages.
+- **Logic**: Reordered commit type priority (Style > Src > Test > Docs) to prevent misclassification of mixed changes.
+- **Fix**: Resolved issue where new files were incorrectly flagged as `fix` instead of `feat`.
+
+## [0.1.4] - 2026-02-01
+
+### Fixed
+- **Windows Compatibility**: Fixed critical issue where absolute paths on Windows caused ignore rules to fail.
+- **Watcher Noise**: Fixed infinite commit loops caused by `.vscode/time-analytics.json` and self-logging.
+- **CLI Crash**: Resolved `autopilot start` failure due to miswired Commander action handlers.
+
+### Added
+- **Release Gates**: Added `npm run verify` and `prepublishOnly` hooks to prevent broken releases.
+- **Integration Tests**: Added full end-to-end test suite using `node:test`.
+- **Smart Init**: `autopilot init` now automatically adds `autopilot.log` to `.gitignore`.
+- **Diagnostics**: Added `autopilot doctor` for environment health checks.
+
+## [0.1.3] - 2026-01-31
+
+### Added
+- **Initial Public Release**: First stable release on npm as `@traisetech/autopilot`.
+- **Core Features**:
+  - Intelligent auto commit & push.
+  - Background watcher with debouncing.
+  - Branch protection (blocks commits to `main`/`master` by default).
+  - Remote-ahead safety checks.
+  - Per-project configuration via `.autopilotrc.json`.
+
+## [0.1.1]
+
+### Changed
+- **Package Hygiene**: Renamed package scope.
+- **Distribution**: Added `files` whitelist to `package.json` to reduce install size.
+
+## [0.1.0]
+
+### Added
+- **Prototype**: Initial development release with core architecture.

package/README.md

@@ -1,227 +1,233 @@
-# 🚀 Autopilot
-
-<div align="center">
-
-![Autopilot Logo](https://img.shields.io/badge/Autopilot-blue?style=for-the-badge&logo=git&logoColor=white)
-
-**Intelligent Git automation that commits and pushes your code, so you can focus on building.**
-
-[![npm version](https://img.shields.io/npm/v/@traisetech/autopilot?style=flat-square&color=success)](https://www.npmjs.com/package/@traisetech/autopilot)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
-[![Node Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen?style=flat-square)](https://nodejs.org)
-[![Downloads](https://img.shields.io/npm/dm/@traisetech/autopilot?style=flat-square&color=blue)](https://www.npmjs.com/package/@traisetech/autopilot)
-[![GitHub Stars](https://img.shields.io/github/stars/PraiseTechzw/autopilot?style=flat-square&color=gold)](https://github.com/PraiseTechzw/autopilot/stargazers)
-[![Build Status](https://img.shields.io/github/actions/workflow/status/PraiseTechzw/autopilot/ci.yml?style=flat-square)](https://github.com/PraiseTechzw/autopilot/actions)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
-
-**Built by [Praise Masunga](https://github.com/PraiseTechzw) (PraiseTechzw)**
-
-[Features](#-features) • [Installation](#-installation) • [Quick Start](#-quick-start) • [Configuration](#-configuration) • [Commands](#-commands)
-
-</div>
-
----
-
-## 📖 Table of Contents
-
-- [Why Autopilot?](#-why-autopilot)
-- [Features](#-features)
-- [Installation](#-installation)
-- [Quick Start](#-quick-start)
-- [Commands](#-commands)
-- [Configuration](#-configuration)
-- [Safety Features](#-safety-features)
-- [Troubleshooting](#-troubleshooting)
-- [Contributing](#-contributing)
-- [License](#-license)
-
----
-
-## 🎯 Why Autopilot?
-
-Autopilot is designed for developers who want to stay in the flow. It solves manual Git workflow fatigue by handling the repetitive cycle of staging, committing, and pushing changes, allowing you to focus entirely on writing code.
-
-<table>
-<tr>
-<td width="50%">
-
-### ❌ Before Autopilot
-
-```bash
-# Every. Single. Time.
-git add .
-git commit -m "update stuff"
-git push
-
-# Repeat 50+ times a day...
-# Lose focus on coding
-# Forget to commit
-# Inconsistent messages
-```
-
-</td>
-<td width="50%">
-
-### ✅ With Autopilot
-
-```bash
-# One time setup
-autopilot init
-autopilot start
-
-# That's it! 
-# Focus on coding
-# Auto-commits with smart messages
-# Never lose work again
-```
-
-</td>
-</tr>
-</table>
-
----
-
-## ✨ Features
-
-- **🧠 Smart Commits**: Generates professional conventional commit messages automatically.
-- **⚡ Watcher Engine**: Real-time file monitoring with smart debouncing using `chokidar`.
-- **🛡️ Safety First**: Blocks commits on protected branches and checks remote status.
-- **🔄 Automated Flow**: Fetches, stages, commits, and pushes (optional) automatically.
-- **⚙️ Zero Config**: Works out of the box, but fully configurable via `.autopilotrc.json`.
-- **🩺 Self-Healing**: Includes a `doctor` command to diagnose and fix issues.
-
----
-
-## ⬇️ Installation
-
-Install Autopilot globally using npm:
-
-```bash
-npm install -g @traisetech/autopilot
-```
-
----
-
-## 🚀 Quick Start
-
-### 1. Initialize
-Navigate to your Git repository and initialize Autopilot:
-
-```bash
-cd my-project
-autopilot init
-```
-
-### 2. Start Watching
-Start the background daemon to begin monitoring your files:
-
-```bash
-autopilot start
-```
-
-### 3. Check Status
-Verify that Autopilot is running:
-
-```bash
-autopilot status
-```
-
-### 4. Stop
-When you're done for the day:
-
-```bash
-autopilot stop
-```
-
----
-
-## 💻 Commands
-
-| Command | Description |
-|---------|-------------|
-| `autopilot init` | Initializes configuration and ignore files in the current directory. |
-| `autopilot start` | Starts the background watcher daemon. |
-| `autopilot stop` | Stops the running watcher daemon. |
-| `autopilot status` | Shows the current status of the watcher process. |
-| `autopilot doctor` | Runs diagnostics to verify environment and configuration. |
-| `autopilot --help` | Displays help information. |
-
----
-
-## ⚙️ Configuration
-
-Autopilot uses a `.autopilotrc.json` file for configuration. It is created automatically when you run `autopilot init`.
-
-```json
-{
-  "minInterval": 30,
-  "autoPush": true,
-  "blockedBranches": ["main", "production"],
-  "requireChecks": false,
-  "ignore": [
-    "*.log",
-    "temp/",
-    "dist/",
-    "node_modules"
-  ]
-}
-```
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `minInterval` | `number` | `30` | Minimum seconds between commits. |
-| `autoPush` | `boolean` | `true` | Whether to push changes automatically after commit. |
-| `blockedBranches` | `array` | `[]` | List of branches to disable auto-commit on. |
-| `requireChecks` | `boolean` | `false` | Run custom checks before committing. |
-| `ignore` | `array` | `[]` | Additional glob patterns to ignore. |
-
----
-
-## 🛡️ Safety Features
-
-Autopilot includes several safety mechanisms to prevent accidents:
-
-1.  **Branch Protection**: Will not run on branches listed in `blockedBranches`.
-2.  **Remote Sync**: Checks if local branch is behind remote before acting.
-3.  **Debouncing**: Waits for file changes to settle before committing.
-4.  **PID Management**: Ensures only one instance runs per repository.
-
----
-
-## 🔧 Troubleshooting
-
-If you encounter issues, run the doctor command:
-
-```bash
-autopilot doctor
-```
-
-This will check for:
-- Git repository status
-- Configuration validity
-- Node.js version
-- Permissions
-
----
-
-## 🤝 Contributing
-
-Contributions are welcome! Please feel free to submit a Pull Request.
-
-1.  Fork the repository
-2.  Create your feature branch (`git checkout -b feature/AmazingFeature`)
-3.  Commit your changes (`git commit -m 'Add some AmazingFeature'`)
-4.  Push to the branch (`git push origin feature/AmazingFeature`)
-5.  Open a Pull Request
-
----
-
-## 📜 License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
----
-
-<div align="center">
-  <b>Built by <a href="https://github.com/PraiseTechzw">Praise Masunga (PraiseTechzw)</a></b>
-</div>
+# 🚀 Autopilot
+
+<div align="center">
+
+![Autopilot Logo](https://img.shields.io/badge/Autopilot-blue?style=for-the-badge&logo=git&logoColor=white)
+
+**Intelligent Git automation that commits and pushes your code, so you can focus on building.**
+
+[![npm version](https://img.shields.io/npm/v/@traisetech/autopilot?style=flat-square&color=success)](https://www.npmjs.com/package/@traisetech/autopilot)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
+[![Node Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen?style=flat-square)](https://nodejs.org)
+[![Downloads](https://img.shields.io/npm/dm/@traisetech/autopilot?style=flat-square&color=blue)](https://www.npmjs.com/package/@traisetech/autopilot)
+[![GitHub Stars](https://img.shields.io/github/stars/PraiseTechzw/autopilot-cli?style=flat-square&color=gold)](https://github.com/PraiseTechzw/autopilot-cli/stargazers)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/PraiseTechzw/autopilot-cli/ci.yml?style=flat-square)](https://github.com/PraiseTechzw/autopilot-cli/actions)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+
+**Built by [Praise Masunga](https://github.com/PraiseTechzw) (PraiseTechzw)**
+
+[Features](#-features) • [Installation](#-installation) • [Quick Start](#-quick-start) • [Configuration](#-configuration) • [Commands](#-commands)
+
+</div>
+
+---
+
+## 📖 Table of Contents
+
+- [Why Autopilot?](#-why-autopilot)
+- [Features](#-features)
+- [Installation](#-installation)
+- [Quick Start](#-quick-start)
+- [Commands](#-commands)
+- [Configuration](#-configuration)
+- [Safety Features](#-safety-features)
+- [Troubleshooting](#-troubleshooting)
+- [Contributing](#-contributing)
+- [License](#-license)
+
+---
+
+## 🎯 Why Autopilot?
+
+Autopilot is designed for developers who want to stay in the flow. It solves manual Git workflow fatigue by handling the repetitive cycle of staging, committing, and pushing changes, allowing you to focus entirely on writing code.
+
+<table>
+<tr>
+<td width="50%">
+
+### ❌ Before Autopilot
+
+```bash
+# Every. Single. Time.
+git add .
+git commit -m "update stuff"
+git push
+
+# Repeat 50+ times a day...
+# Lose focus on coding
+# Forget to commit
+# Inconsistent messages
+```
+
+</td>
+<td width="50%">
+
+### ✅ With Autopilot
+
+```bash
+# One time setup
+autopilot init
+autopilot start
+
+# That's it! 
+# Focus on coding
+# Auto-commits with smart messages
+# Never lose work again
+```
+
+</td>
+</tr>
+</table>
+
+---
+
+## ✨ Features
+
+- **🧠 Smart Commits**: Generates professional conventional commit messages automatically.
+- **⚡ Watcher Engine**: Real-time file monitoring with smart debouncing using `chokidar`.
+- **🛡️ Safety First**: Blocks commits on protected branches and checks remote status.
+- **🔄 Automated Flow**: Fetches, stages, commits, and pushes (optional) automatically.
+- **⚙️ Zero Config**: Works out of the box, but fully configurable via `.autopilotrc.json`.
+- **🩺 Self-Healing**: Includes a `doctor` command to diagnose and fix issues.
+
+---
+
+## ⬇️ Installation
+
+Install Autopilot globally using npm:
+
+```bash
+npm install -g @traisetech/autopilot
+```
+
+---
+
+## 🚀 Quick Start
+
+### 1. Initialize
+Navigate to your Git repository and initialize Autopilot:
+
+```bash
+cd my-project
+autopilot init
+```
+
+### 2. Start Watching
+Start the background daemon to begin monitoring your files:
+
+```bash
+autopilot start
+```
+
+### 3. Check Status
+Verify that Autopilot is running:
+
+```bash
+autopilot status
+```
+
+### 4. Stop
+When you're done for the day:
+
+```bash
+autopilot stop
+```
+
+---
+
+## 💻 Commands
+
+| Command | Description |
+|---------|-------------|
+| `autopilot init` | Initializes configuration and ignore files in the current directory. |
+| `autopilot start` | Starts the background watcher daemon. |
+| `autopilot stop` | Stops the running watcher daemon. |
+| `autopilot status` | Shows the current status of the watcher process. |
+| `autopilot doctor` | Runs diagnostics to verify environment and configuration. |
+| `autopilot --help` | Displays help information. |
+
+---
+
+## ⚙️ Configuration
+
+Autopilot uses a `.autopilotrc.json` file for configuration. It is created automatically when you run `autopilot init`.
+
+```json
+{
+  "minInterval": 30,
+  "autoPush": true,
+  "blockedBranches": ["main", "production"],
+  "requireChecks": false,
+  "ignore": [
+    "*.log",
+    "temp/",
+    "dist/",
+    "node_modules"
+  ]
+}
+```
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `minInterval` | number | 30 | Minimum seconds between commits. |
+| `autoPush` | boolean | true | Whether to push changes automatically after commit. |
+| `blockedBranches` | array | `[]` | List of branches to disable auto-commit on. |
+| `requireChecks` | boolean | false | Run custom checks before committing. |
+| `ignore` | array | `[]` | Additional glob patterns to ignore. |
+
+---
+
+## 🛡️ Safety Features
+
+Autopilot includes several safety mechanisms to prevent accidents:
+
+- **Branch Protection**: Will not run on branches listed in `blockedBranches`.
+- **Remote Sync**: Checks if local branch is behind remote before acting.
+- **Debouncing**: Waits for file changes to settle before committing.
+- **PID Management**: Ensures only one instance runs per repository.
+
+---
+
+## 🔧 Troubleshooting
+
+If you encounter issues, run the `doctor` command:
+
+```bash
+autopilot doctor
+```
+
+This will check for:
+- Git repository status
+- Configuration validity
+- Node.js version
+- Permissions
+- **Common Issue**: If commits aren't triggering, check if you are editing ignored files (e.g. `.vscode`, `node_modules`).
+- **Autopilot detects changes but never commits**: This can happen if files are constantly changing (resetting the debounce timer) or if you are on a blocked branch. Check `autopilot.log` for details.
+
+For more details, visit our [Documentation Site](https://autopilot-cli.vercel.app/docs/troubleshooting).
+
+---
+
+## 🧪 Verification (Smoke Test)
+
+To verify that Autopilot is working correctly on your machine or in a CI environment, you can run the built-in verification suite. This runs the linter, the doctor diagnostic tool, and the full test suite.
+
+```bash
+# Run the full verification suite
+npm run verify
+```
+
+If everything is green, you are good to go!
+
+---
+
+## 🤝 Contributing
+
+Contributions, issues, and feature requests are welcome!
+Feel free to check the [issues page](https://github.com/PraiseTechzw/autopilot-cli/issues).
+
+Please read our [Contributing Guide](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
+
+## 📝 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.