@pc360/chlog 0.1.7 → 0.1.9

package/CHANGELOG.md

@@ -11,6 +11,18 @@ The format is based on Keep a Changelog, and this project follows Semantic Versi
 - Removed Ink card border lines so help and status output no longer render inside a box.
 - Added blank lines before and after help and error output to improve readability.
 
+## [0.1.9] - 2026-02-14
+
+### Changed
+
+- Update docs with a global installation and add --version option
+
+## [0.1.8] - 2026-02-14
+
+### Changed
+
+- Update docs
+
 ## [0.1.7] - 2026-02-14
 
 ### Changed

package/README.md

@@ -17,16 +17,80 @@ Each entry file is automatically:
 
 ---
 
-## 🚀 Usage
+## 📦 Install
+
+```bash
+npm i -g @pc360/chlog
+```
+
+## ✅ After Installation
+
+If `chlog` is not recognized after global install, add your npm global `bin` path to `PATH`.
+
+1. Get your npm prefix:
+
+```bash
+npm get prefix
+```
+
+2. Use the output as `<prefix>`, then add this to your shell config:
+
+```bash
+export PATH="$PATH:<prefix>/bin"
+```
+
+For `zsh`, add it to `~/.zshrc`.
+For `bash`, add it to `~/.bashrc`.
+
+3. Reload your shell config (or open a new terminal):
 
+```bash
+source ~/.zshrc
+# or
+source ~/.bashrc
 ```
+
+Then run:
+
+```bash
+# Dry run (preview only)
+chlog --type <added|changed|fixed|removed> \
+      --scope <scope> \
+      --message "<description>" \
+      [--frontend] \
+      --dry-run
+
+# Dry run short form (preview only)
+chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>" [-f] -d
+
+# Create entry
+chlog --type <added|changed|fixed|removed> \
+      --scope <scope> \
+      --message "<description>" \
+      [--frontend]
+```
+
+You can also run it without global install:
+
+```bash
 npx @pc360/chlog --type <added|changed|fixed|removed> \
-                         --scope <scope> \
-                         --message "<description>" \
-                         [--frontend]
+                 --scope <scope> \
+                 --message "<description>" \
+                 [--frontend]
+```
+
+---
+
+## 🚀 Usage
+
+```bash
+chlog --type <added|changed|fixed|removed> \
+      --scope <scope> \
+      --message "<description>" \
+      [--frontend]
 
 # Short form
-npx @pc360/chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>" [-f]
+chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>" [-f]
 ```
 
 ---
@@ -41,6 +105,7 @@ npx @pc360/chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>"
 | `-f, --frontend` | ❌       | Uses `[Front-End]` instead of `[Back-End]`          |
 | `-d, --dry-run`  | ❌       | Preview file creation without writing               |
 | `-h, --help`     | ❌       | Show help                                           |
+| `-v, --version`  | ❌       | Show CLI version                                    |
 
 ---
 
@@ -49,7 +114,7 @@ npx @pc360/chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>"
 ### Back-End Change (Default)
 
 ```
-npx @pc360/chlog --type added --scope JES-33 --message "Add daily consolidated JE job"
+chlog --type added --scope JES-33 --message "Add daily consolidated JE job"
 ```
 
 Creates:
@@ -69,7 +134,7 @@ File content:
 ### Front-End Change
 
 ```
-npx @pc360/chlog --type fixed --scope JES-45 --frontend --message "Fix table pagination issue"
+chlog --type fixed --scope JES-45 --frontend --message "Fix table pagination issue"
 ```
 
 File content:
@@ -83,7 +148,7 @@ File content:
 ### Module-Based Scope
 
 ```
-npx @pc360/chlog --type changed --scope "Credit Validation" --message "Improve credit limit computation"
+chlog --type changed --scope "Credit Validation" --message "Improve credit limit computation"
 ```
 
 File content:
@@ -153,7 +218,7 @@ Fix FR status blocking issue
 Preview without creating file:
 
 ```
-npx @pc360/chlog --type added --scope JES-99 --message "Test entry" --dry-run
+chlog --type added --scope JES-99 --message "Test entry" --dry-run
 ```
 
 ---

package/bin/chlog.js

@@ -3,6 +3,7 @@
 
 const fs = require("fs/promises");
 const path = require("path");
+const { version } = require("../package.json");
 
 const {
   parseArgs,
@@ -39,6 +40,7 @@ Options:
   --tz "<iana>"          Timezone (default: Asia/Manila)
   -d, --dry-run          Preview only
   -h, --help             Show help
+  -v, --version          Show version
 `.trim();
 }
 
@@ -51,6 +53,11 @@ async function main() {
       process.exit(0);
     }
 
+    if (args.version) {
+      process.stdout.write(`${version}\n`);
+      process.exit(0);
+    }
+
     validateArgs(args);
 
     const timestamp = generateTimestamp(new Date(), args.tz);

package/lib/chlog-lib.js

@@ -11,6 +11,7 @@ function parseArgs(argv) {
     frontend: false,
     dryRun: false,
     help: false,
+    version: false,
   };
 
   for (let i = 2; i < argv.length; i++) {
@@ -21,6 +22,11 @@ function parseArgs(argv) {
       break;
     }
 
+    if (arg === "-v" || arg === "--version") {
+      args.version = true;
+      break;
+    }
+
     if (arg === "--dry-run" || arg === "-d") {
       args.dryRun = true;
       continue;

package/lib/chlog-ui.js

@@ -136,7 +136,7 @@ async function renderHelp(helpText) {
 
   const rendered = await renderInkCard(
     {
-      title: "PC360 Changelog CLI - v0.1.7",
+      title: "PC360 Changelog CLI",
       subtitle: "Usage & options",
       lines: styledLines,
       tone: "info",

package/package.json

@@ -1,16 +1,26 @@
 {
   "name": "@pc360/chlog",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "PC360 Changelog CLI Tool",
   "author": "aalmazan@pcdsi.ph",
   "bin": {
     "chlog": "bin/chlog.js"
   },
+  "files": [
+    "bin",
+    "lib",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "license": "UNLICENSED",
   "engines": {
     "node": ">=18"
   },
   "dependencies": {
+    "@pc360/chlog": "^0.1.7",
     "ink": "^4.4.1",
     "react": "^18.3.1"
   },

package/test/chlog-cli.integration.test.js

@@ -1,161 +0,0 @@
-"use strict";
-
-const test = require("node:test");
-const assert = require("node:assert/strict");
-const fs = require("fs");
-const os = require("os");
-const path = require("path");
-const { spawnSync } = require("child_process");
-
-const { generateTimestamp } = require("../lib/chlog-lib");
-
-const BIN_PATH = path.resolve(__dirname, "../bin/chlog.js");
-
-function createTempDir() {
-  return fs.mkdtempSync(path.join(os.tmpdir(), "chlog-cli-"));
-}
-
-function runCli(args, cwd) {
-  return spawnSync(process.execPath, [BIN_PATH, ...args], {
-    cwd,
-    encoding: "utf8",
-  });
-}
-
-function cleanup(dir) {
-  fs.rmSync(dir, { recursive: true, force: true });
-}
-
-test("CLI dry-run previews target path/content and exits 0", () => {
-  const cwd = createTempDir();
-
-  try {
-    const res = runCli(
-      [
-        "--type",
-        "added",
-        "--scope",
-        "JES-99",
-        "--message",
-        "Test entry",
-        "--dry-run",
-      ],
-      cwd,
-    );
-
-    assert.equal(res.status, 0);
-    assert.match(res.stdout, /\[Dry Run\]/);
-    assert.match(
-      res.stdout,
-      /Would create: .*changelog[\/\\]unreleased[\/\\]added[\/\\]\d{14}/,
-    );
-    assert.match(res.stdout, /\[JES-99\] \[Back-End\] Test entry/);
-    assert.equal(fs.existsSync(path.join(cwd, "changelog")), false);
-  } finally {
-    cleanup(cwd);
-  }
-});
-
-test("CLI supports short flags for required values and toggles", () => {
-  const cwd = createTempDir();
-
-  try {
-    const res = runCli(
-      ["-t", "added", "-s", "JES-100", "-m", "Use short options", "-f", "-d"],
-      cwd,
-    );
-
-    assert.equal(res.status, 0);
-    assert.match(res.stdout, /\[Dry Run\]/);
-    assert.match(
-      res.stdout,
-      /Would create: .*changelog[\/\\]unreleased[\/\\]added[\/\\]\d{14}/,
-    );
-    assert.match(res.stdout, /\[JES-100\] \[Front-End\] Use short options/);
-    assert.equal(fs.existsSync(path.join(cwd, "changelog")), false);
-  } finally {
-    cleanup(cwd);
-  }
-});
-
-test("CLI creates changelog file with expected content and exits 0", () => {
-  const cwd = createTempDir();
-
-  try {
-    const res = runCli(
-      [
-        "--type",
-        "fixed",
-        "--scope",
-        "JES-45",
-        "--message",
-        "Fix pagination",
-        "--frontend",
-      ],
-      cwd,
-    );
-
-    assert.equal(res.status, 0);
-    assert.match(
-      res.stdout,
-      /Created: changelog[\/\\]unreleased[\/\\]fixed[\/\\]\d{14}/,
-    );
-
-    const entryDir = path.join(cwd, "changelog", "unreleased", "fixed");
-    const files = fs.readdirSync(entryDir);
-    assert.equal(files.length, 1);
-    assert.match(files[0], /^\d{14}$/);
-
-    const content = fs.readFileSync(path.join(entryDir, files[0]), "utf8");
-    assert.equal(content, "[JES-45] [Front-End] Fix pagination\n");
-  } finally {
-    cleanup(cwd);
-  }
-});
-
-test("CLI returns exit code 1 for missing required flags", () => {
-  const cwd = createTempDir();
-
-  try {
-    const res = runCli(["--type", "added", "--scope", "JES-1"], cwd);
-
-    assert.equal(res.status, 1);
-    assert.match(res.stderr, /--message is required/);
-    assert.match(res.stderr, /Run: chlog --help/);
-  } finally {
-    cleanup(cwd);
-  }
-});
-
-test("CLI surfaces timestamp collision errors and exits 1", () => {
-  const cwd = createTempDir();
-
-  try {
-    const entryDir = path.join(cwd, "changelog", "unreleased", "changed");
-    fs.mkdirSync(entryDir, { recursive: true });
-
-    const now = Date.now();
-    for (let offset = -5; offset <= 5; offset++) {
-      const ts = generateTimestamp(new Date(now + offset * 1000), "Asia/Manila");
-      fs.writeFileSync(path.join(entryDir, ts), "existing\n", "utf8");
-    }
-
-    const res = runCli(
-      [
-        "--type",
-        "changed",
-        "--scope",
-        "JES-77",
-        "--message",
-        "Update report formatting",
-      ],
-      cwd,
-    );
-
-    assert.equal(res.status, 1);
-    assert.match(res.stderr, /EEXIST|file already exists/i);
-    assert.match(res.stderr, /Run: chlog --help/);
-  } finally {
-    cleanup(cwd);
-  }
-});

package/test/chlog-lib.test.js

@@ -1,170 +0,0 @@
-"use strict";
-
-const test = require("node:test");
-const assert = require("node:assert/strict");
-
-const {
-  parseArgs,
-  validateArgs,
-  generateTimestamp,
-  buildLine,
-} = require("../lib/chlog-lib");
-
-test("parseArgs parses required flags and defaults", () => {
-  const args = parseArgs([
-    "node",
-    "chlog",
-    "--type",
-    "added",
-    "--scope",
-    "JES-33",
-    "--message",
-    "Hello",
-  ]);
-
-  assert.equal(args.type, "added");
-  assert.equal(args.scope, "JES-33");
-  assert.equal(args.message, "Hello");
-  assert.equal(args.tz, "Asia/Manila");
-  assert.equal(args.frontend, false);
-  assert.equal(args.dryRun, false);
-  assert.equal(args.help, false);
-});
-
-test("parseArgs supports --frontend and --dry-run", () => {
-  const args = parseArgs([
-    "node",
-    "chlog",
-    "--type",
-    "fixed",
-    "--scope",
-    "JES-45",
-    "--message",
-    "Fix thing",
-    "--frontend",
-    "--dry-run",
-  ]);
-
-  assert.equal(args.frontend, true);
-  assert.equal(args.dryRun, true);
-});
-
-test("parseArgs supports short flags", () => {
-  const args = parseArgs([
-    "node",
-    "chlog",
-    "-t",
-    "changed",
-    "-s",
-    "JES-50",
-    "-m",
-    "Update validation flow",
-    "-f",
-    "-d",
-  ]);
-
-  assert.equal(args.type, "changed");
-  assert.equal(args.scope, "JES-50");
-  assert.equal(args.message, "Update validation flow");
-  assert.equal(args.frontend, true);
-  assert.equal(args.dryRun, true);
-});
-
-test("parseArgs supports mixed long/short flags", () => {
-  const args = parseArgs([
-    "node",
-    "chlog",
-    "--type",
-    "fixed",
-    "-s",
-    "JES-88",
-    "--message",
-    "Mixed flags",
-    "-d",
-  ]);
-
-  assert.equal(args.type, "fixed");
-  assert.equal(args.scope, "JES-88");
-  assert.equal(args.message, "Mixed flags");
-  assert.equal(args.dryRun, true);
-  assert.equal(args.frontend, false);
-});
-
-test("parseArgs supports -h short help flag", () => {
-  const args = parseArgs(["node", "chlog", "-h"]);
-  assert.equal(args.help, true);
-});
-
-test("validateArgs throws if missing scope", () => {
-  assert.throws(
-    () =>
-      validateArgs({
-        type: "added",
-        scope: null,
-        message: "x",
-        tz: "Asia/Manila",
-      }),
-    /--scope is required/,
-  );
-});
-
-test("validateArgs throws if invalid type", () => {
-  assert.throws(
-    () =>
-      validateArgs({
-        type: "nope",
-        scope: "JES-1",
-        message: "x",
-        tz: "Asia/Manila",
-      }),
-    /--type must be one of/,
-  );
-});
-
-test("validateArgs throws if invalid timezone", () => {
-  assert.throws(
-    () =>
-      validateArgs({
-        type: "added",
-        scope: "JES-1",
-        message: "x",
-        tz: "Not/A_Timezone",
-      }),
-    /Invalid time zone|timeZone/i,
-  );
-});
-
-test("generateTimestamp returns 14 digits", () => {
-  const ts = generateTimestamp(new Date("2026-02-13T00:00:00Z"), "Asia/Manila");
-  assert.match(ts, /^\d{14}$/);
-});
-
-test("buildLine defaults to [Back-End] prefix and includes scope", () => {
-  const line = buildLine({
-    scope: "JES-33",
-    message: "Add daily consolidated JE job",
-    frontend: false,
-  });
-
-  assert.equal(line, "[JES-33] [Back-End] Add daily consolidated JE job\n");
-});
-
-test("buildLine uses [Front-End] when frontend=true", () => {
-  const line = buildLine({
-    scope: "JES-45",
-    message: "Fix pagination",
-    frontend: true,
-  });
-
-  assert.equal(line, "[JES-45] [Front-End] Fix pagination\n");
-});
-
-test("buildLine does not double-prefix if message already starts with label", () => {
-  const line = buildLine({
-    scope: "JES-99",
-    message: "[Back-End] Already prefixed",
-    frontend: false,
-  });
-
-  assert.equal(line, "[JES-99] [Back-End] Already prefixed\n");
-});