@pc360/chlog 0.1.10 → 0.1.12

package/CHANGELOG.md

@@ -1,4 +1,4 @@
-# Changelog
+#Changelog
 
 All notable changes to this project are documented in this file.
 
@@ -10,6 +10,18 @@ The format is based on Keep a Changelog, and this project follows Semantic Versi
 
 - No changes yet.
 
+## [0.1.11] - 2026-02-15
+
+### Added
+
+- Added explicit terminal environment requirements in README (macOS Terminal, iTerm2, Git Bash for Windows, WSL2, Linux)
+- Added detailed Git Bash login shell configuration guide
+- Added cross-platform npm global PATH setup instructions
+- Added structured shell setup section per environment
+- Improved documentation clarity for Windows users
+- Standardized installation and verification steps
+- Refined README structure for better onboarding experience
+
 ## [0.1.10] - 2026-02-15
 
 ### Changed

package/README.md

@@ -11,13 +11,21 @@ Each entry is automatically:
 - Named with Asia/Manila timestamp (`YYYYMMDDHHmmss`)
 - Placed in the correct type directory
 - Written as one clean line
-- Prefixed with scope and layer (`Back-End` or `Front-End`)
+- Prefixed with scope and layer (`[Back-End]` or `[Front-End]`)
 
-## 1. Installation
+---
+
+# 1. Installation
 
-Requirements:
+## Requirements
 
 - Node.js `>= 18`
+- One of the following terminals:
+  - macOS Terminal
+  - iTerm2 (macOS)
+  - Git Bash (Windows)
+  - Linux bash/zsh
+  - WSL2 (Windows Subsystem for Linux)
 
 Install globally:
 
@@ -31,7 +39,9 @@ Alternative (without global install):
 npx @pc360/chlog --type <added|changed|fixed|removed> --scope <scope> --message "<description>"
 ```
 
-## 2. First-Time Usage (Dry Run First)
+---
+
+# 2. First-Time Usage (Dry Run Recommended)
 
 For first use, always run a dry run to preview output without creating a file:
 
@@ -51,42 +61,140 @@ If the preview is correct, run the actual command:
 chlog --type added --scope JES-99 --message "Test entry"
 ```
 
-## 3. If `chlog` Is Not Found
+---
+
+# 3. If `chlog` Is Not Found
 
 If you see `command not found: chlog` after installation, add npm global `bin` to your `PATH`.
 
-1. Get npm prefix:
+Check npm prefix:
 
 ```bash
 npm get prefix
 ```
 
-2. Add this line to your shell config (replace `<prefix>` with output above):
+Then follow the setup instructions below depending on your environment.
+
+---
+
+# 🖥 Shell Setup Per Environment
+
+If `chlog` is installed globally but not found, ensure your npm global `bin` directory is included in your `PATH`.
+
+---
+
+## 🍎 macOS Terminal / iTerm2
+
+If using **zsh** (default on macOS):
 
 ```bash
-export PATH="$PATH:<prefix>/bin"
+echo 'export PATH="$PATH:$(npm get prefix)/bin"' >> ~/.zshrc
+source ~/.zshrc
 ```
 
-3. Save to the right file:
+If using **bash**:
 
-- `zsh`: `~/.zshrc` (or `~/.zhsrc` if your environment uses that filename)
-- `bash`: `~/.bashrc`
+```bash
+echo 'export PATH="$PATH:$(npm get prefix)/bin"' >> ~/.bashrc
+source ~/.bashrc
+```
 
-4. Reload shell:
+Verify:
+
+```bash
+chlog --version
+```
+
+---
+
+## 🪟 Git Bash (Windows)
+
+Git Bash runs as a **login shell**, which means it loads:
+
+```
+~/.bash_profile
+```
+
+If `.bash_profile` exists, it may NOT automatically load `.bashrc`.
+
+### Recommended Setup
+
+### Step 1: Ensure `.bash_profile` Loads `.bashrc`
+
+Open Git Bash:
+
+```bash
+nano ~/.bash_profile
+```
+
+Add:
+
+```bash
+# Load .bashrc if it exists
+if [ -f ~/.bashrc ]; then
+  . ~/.bashrc
+fi
+```
+
+Save and exit.
+
+---
+
+### Step 2: Add npm Global Path to `.bashrc`
+
+```bash
+nano ~/.bashrc
+```
+
+Add:
+
+```bash
+export PATH="$PATH:$(npm get prefix)/bin"
+```
+
+Save and restart Git Bash.
+
+---
+
+### Verify
+
+```bash
+chlog --version
+```
+
+If the version prints, setup is successful.
+
+---
+
+## 🐧 WSL2 / Linux
+
+Add npm global path to:
+
+```bash
+~/.bashrc
+```
+
+Add:
+
+```bash
+export PATH="$PATH:$(npm get prefix)/bin"
+```
+
+Reload:
 
 ```bash
-source ~/.zshrc
-# or
 source ~/.bashrc
 ```
 
-5. Verify:
+Verify:
 
 ```bash
 chlog --version
 ```
 
-## Usage
+---
+
+# Usage
 
 ```bash
 chlog --type <added|changed|fixed|removed> \
@@ -101,7 +209,9 @@ Short form:
 chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>" [-f]
 ```
 
-## Parameters
+---
+
+# Parameters
 
 | Flag             | Required | Description                                         |
 | ---------------- | -------- | --------------------------------------------------- |
@@ -113,27 +223,31 @@ chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>" [-f]
 | `-h, --help`     | No       | Show help                                           |
 | `-v, --version`  | No       | Show CLI version                                    |
 
-## Examples
+---
+
+# Examples
 
-Back-End (default):
+### Back-End (default)
 
 ```bash
 chlog --type added --scope JES-33 --message "Add daily consolidated JE job"
 ```
 
-Front-End:
+### Front-End
 
 ```bash
 chlog --type fixed --scope JES-45 --frontend --message "Fix table pagination issue"
 ```
 
-Module scope:
+### Module Scope
 
 ```bash
 chlog --type changed --scope "Credit Validation" --message "Improve credit limit computation"
 ```
 
-## Output Structure
+---
+
+# Output Structure
 
 ```text
 changelog/
@@ -152,7 +266,9 @@ YYYYMMDDHHmmss
 
 Timezone used: `Asia/Manila`
 
-## CLI Rules
+---
+
+# CLI Rules
 
 - `--type` is required
 - `--scope` is required
@@ -162,25 +278,23 @@ Timezone used: `Asia/Manila`
 
 ---
 
-## 🧪 Running Unit Tests
+# 🧪 Running Unit Tests
 
 This project uses Node.js built-in test runner (`node:test`). No external test framework is required.
 
-### Run Tests
+## Run Tests
 
-From the project root:
-
-```
+```bash
 npm test
 ```
 
-Or directly with Node:
+Or directly:
 
-```
+```bash
 node --test
 ```
 
-### What Is Tested
+## What Is Tested
 
 - Argument parsing (`parseArgs`)
 - Required flag validation (`validateArgs`)

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@pc360/chlog",
-  "version": "0.1.10",
+  "version": "0.1.12",
   "description": "PC360 Changelog CLI Tool",
-  "author": "aalmazan@pcdsi.ph",
+  "keywords": [
+    "changelog",
+    "cli"
+  ],
+  "author": "almerleoalmazan@gmail.com",
   "bin": {
     "chlog": "bin/chlog.js"
   },