{"_id":"@3roland59/gawk","_rev":"3-f2a52ad05282874dbff45903572ace38","name":"@3roland59/gawk","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"@3roland59/gawk","version":"1.0.0","author":{"name":"Roland Amartey"},"license":"MIT","_id":"@3roland59/gawk@1.0.0","maintainers":[{"name":"3roland59","email":"amarteyroland359@gmail.com"}],"bin":{"gawk-install":"bin/install-hook.js"},"dist":{"shasum":"d5915089080d3dddf9c683405cdfbdb6d2b33cf0","tarball":"https://registry.npmjs.org/@3roland59/gawk/-/gawk-1.0.0.tgz","fileCount":3,"integrity":"sha512-8Z6NWUg1OZyTav5wCWlBbJF+zT2SHFNXV/HukyTCiBi8RIwMErYH3HgxbtVag++8e6bdjnL5cQMk27NztElRPA==","signatures":[{"sig":"MEUCIDwHwVHtvB3V6R7DW3npauB/H8V7UAvyf6Cbx4sa4ULiAiEA04ftrpeoodUbx0uicW9juNyNc4QidXU5XLUvjwjQ4nE=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1532},"main":"index.js","scripts":{"postinstall":"node ./bin/install-hook.js"},"_npmUser":{"name":"3roland59","actor":{"name":"3roland59","type":"user","email":"amarteyroland359@gmail.com"},"email":"amarteyroland359@gmail.com"},"_npmVersion":"10.9.2","description":"Logs Git commit messages to a markdown file.","directories":{},"_nodeVersion":"23.10.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/gawk_1.0.0_1750600739018_0.911447823554592","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@3roland59/gawk","version":"1.0.1","author":{"name":"Roland Amartey"},"license":"MIT","_id":"@3roland59/gawk@1.0.1","maintainers":[{"name":"3roland59","email":"amarteyroland359@gmail.com"}],"bin":{"gawk-install":"bin/install-hook.js"},"dist":{"shasum":"2e5cbd5e970846e548e8d8aa822088bed24dd10f","tarball":"https://registry.npmjs.org/@3roland59/gawk/-/gawk-1.0.1.tgz","fileCount":5,"integrity":"sha512-0VrCLZumK4EZi2Y8NFJNXBvaMxRZYkNzUPo1imgYsBca9dSZWz6QFWYhNe9sQJ1bKFgcvTsa4eDU2j1E6J7aPg==","signatures":[{"sig":"MEQCIEXg3vqNWnVJpWdYCrd1Vf+oLgbCF8ZZyFlxRtmkVWgwAiArvH+LQOsqH2qTmG73dwQ5uZBkn6GtQC4z1Jq9mHioLA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":5905},"main":"index.js","gitHead":"49d79f809c962693c9baa8c6dad9b5ef63a7b6b0","scripts":{"postinstall":"node ./bin/install-hook.js"},"_npmUser":{"name":"3roland59","actor":{"name":"3roland59","type":"user","email":"amarteyroland359@gmail.com"},"email":"amarteyroland359@gmail.com"},"_npmVersion":"10.9.2","description":"Logs Git commit messages to a markdown file.","directories":{},"_nodeVersion":"23.10.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/gawk_1.0.1_1750603467065_0.8131505485277755","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@3roland59/gawk","version":"1.0.2","description":"Logs Git commit messages to a markdown file.","main":"index.js","bin":{"gawk-install":"bin/install-hook.js"},"scripts":{"postinstall":"node ./bin/install-hook.js"},"author":{"name":"Roland Amartey"},"license":"MIT","_id":"@3roland59/gawk@1.0.2","gitHead":"4eea799b868197706e435515e719b1c5ab583ac1","_nodeVersion":"23.10.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-iVdwUK/S7oEQHSwZqZ8PWGCMsbip3gS2/nynPb0YLlttYRJzGAftcVyXs2jBj1MjL3a3bfew44k6t8fmnuxxnw==","shasum":"8709c95e9f9931a0485145b7d6aeb25209a114b6","tarball":"https://registry.npmjs.org/@3roland59/gawk/-/gawk-1.0.2.tgz","fileCount":5,"unpackedSize":5780,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIDzAHjFE+odllqMLq0mmt6mWz4Vo4tfsXhql0/9q0gQFAiEAgFb+IFeQdrz1EfjR4JQWJEyD8NqDztpACFU4KaN+3mM="}]},"_npmUser":{"name":"3roland59","email":"amarteyroland359@gmail.com","actor":{"name":"3roland59","email":"amarteyroland359@gmail.com","type":"user"}},"directories":{},"maintainers":[{"name":"3roland59","email":"amarteyroland359@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/gawk_1.0.2_1750603972301_0.13996972325185864"},"_hasShrinkwrap":false}},"time":{"created":"2025-06-22T13:58:58.895Z","modified":"2025-06-22T14:52:53.040Z","1.0.0":"2025-06-22T13:58:59.193Z","1.0.1":"2025-06-22T14:44:27.243Z","1.0.2":"2025-06-22T14:52:52.534Z"},"author":{"name":"Roland Amartey"},"license":"MIT","description":"Logs Git commit messages to a markdown file.","maintainers":[{"name":"3roland59","email":"amarteyroland359@gmail.com"}],"readme":"![Gawk Logo](https://user-images.githubusercontent.com/placeholder/gawk-logo.png)\n[![npm version](https://img.shields.io/npm/v/@3roland59/gawk.svg)](https://www.npmjs.com/package/@3roland59/gawk)\n\n# 🐙 gawk - Git Commit Logger to Markdown\n\n**@3roland59/gawk** is a lightweight NPM package that logs every Git commit into a `.commit-log.md` file automatically.  \nIt uses a Git `post-commit` hook that is installed automatically during installation.\n\n---\n\n## 🚀 Installation\n\n### 🔧 Automatic Hook Installation (Recommended)\n\nIn any Git-initialized Node.js project:\n\n```bash\nnpm install @3roland59/gawk\n```\n\nThat’s it! The hook will install itself and start logging your commits.\n\n---\n\n### ⚙️ Manual Hook Install (Optional)\n\nIf for any reason the auto-install fails (e.g., Git isn’t initialized during install), you can manually install the hook:\n\n#### Run via npx:\n```bash\nnpx commit-md-install\n```\n\n#### Or if installed globally:\n```bash\nnpm install -g @3roland59/gawk\ncommit-md-install\n```\n\n---\n\n## 🧠 What It Logs\n\nEach time you commit, a new entry is appended to `.commit-log.md` in this format:\n\n```md\n### Commit: **abc1234**\n- **Author:** Jane Doe\n- **Date:** Sat Jun 22 13:45:01 2025\n- **Message:** Fix login bug\n- **Files Changed:**\n  - `src/components/Login.js`\n  - `README.md`\n```\n\n---\n\n## 🧪 Example Test\n\n```bash\n# Create or change a file\necho \"Test Gawk\" > test.txt\n\n# Stage and commit\ngit add test.txt\ngit commit -m \"Add test file\"\n\n# Check log\ncat .commit-log.md\n```\n\n---\n\n## 📦 What Happens on Install\n\n1. The `postinstall` script runs.\n2. It checks if Git is initialized (`.git` exists).\n3. If yes, it installs a `post-commit` hook to `.git/hooks/`.\n4. On every commit, the hook logs:\n   - Commit hash\n   - Author name\n   - Date & time\n   - Commit message\n   - List of changed files\n\n---\n\n## 📂 Files Created\n\n- `.commit-log.md`: Markdown file containing your project's commit history.\n\n---\n\n## ✅ Requirements\n\n- Git must be initialized (`git init` already run).\n- Node.js installed (v12+ is fine).\n- Works in macOS, Linux, and Git Bash on Windows.\n\n---\n\n## 📈 Future Features (Planned)\n\n- Custom output file name\n- Optional diff or stats\n- Config via `.gawkrc` or package.json\n- Date format customization\n- Ignoring specific files or commit messages\n\n---\n\n## 🙌 Author\n\nMade with 💻 by [@3roland59](https://www.npmjs.com/~3roland59)\n\n---\n\n## 📜 License\n\nMIT License\n","readmeFilename":"README.md"}