@pc360/chlog 0.1.6 → 0.1.8

package/CHANGELOG.md

@@ -7,32 +7,50 @@ The format is based on Keep a Changelog, and this project follows Semantic Versi
 ## [Unreleased]
 
 ### Changed
+
 - 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.8] - 2026-02-14
+
+### Changed
+
+- Update docs
+
+## [0.1.7] - 2026-02-14
+
+### Changed
+
+- Bumped package version to `0.1.7`.
+
 ## [0.1.6] - 2026-02-14
 
 ### Changed
+
 - Bumped package version to `0.1.6`.
 
 ## [0.1.5] - 2026-02-14
 
 ### Changed
+
 - Bumped package version to `0.1.5`.
 
 ## [0.1.4] - 2026-02-14
 
 ### Changed
+
 - Cleaned project files and repository content.
 
 ## [0.1.3] - 2026-02-14
 
 ### Added
+
 - Improved help-menu text styling for better readability.
 
 ## [0.1.2] - 2026-02-14
 
 ### Added
+
 - Added short CLI flags:
   - `-t` for `--type`
   - `-s` for `--scope`
@@ -42,17 +60,20 @@ The format is based on Keep a Changelog, and this project follows Semantic Versi
 - Expanded unit and integration test coverage for short flag handling.
 
 ### Changed
+
 - Enhanced `chlog --help` content with clearer tool description and usage details.
 
 ## [0.1.1] - 2026-02-14
 
 ### Changed
+
 - Refactored CLI terminal rendering to use `ink` with styled output cards.
 
 ## [0.1.0] - 2026-02-13
 
 ### Added
-- Initial release of `pc360-changelog-cli`.
+
+- Initial release of `@pc360/chlog`.
 - Core CLI flow for creating changelog entry files under:
   - `changelog/unreleased/added`
   - `changelog/unreleased/changed`
@@ -64,4 +85,5 @@ The format is based on Keep a Changelog, and this project follows Semantic Versi
 - Unit test coverage for parser, validation, timestamp, and output line formatting.
 
 ### Changed
+
 - Standardized output path naming from `changelogs/` to `changelog/`.

package/README.md

@@ -17,34 +17,16 @@ Each entry file is automatically:
 
 ---
 
-## 📦 Installation
-
-### Option 1 — Install from `.tgz` package
-
-```
-npm install -g pc360-changelog-cli-0.1.6.tgz
-```
-
-### Option 2 — Install from project folder
-
-```
-npm install -g .
-```
-
-After installation, the `chlog` command will be globally available.
-
----
-
 ## 🚀 Usage
 
 ```
-chlog --type <added|changed|fixed|removed> \
-      --scope <scope> \
-      --message "<description>" \
-      [--frontend]
+npx @pc360/chlog --type <added|changed|fixed|removed> \
+                         --scope <scope> \
+                         --message "<description>" \
+                         [--frontend]
 
 # Short form
-chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>" [-f]
+npx @pc360/chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>" [-f]
 ```
 
 ---
@@ -67,7 +49,7 @@ chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>" [-f]
 ### Back-End Change (Default)
 
 ```
-chlog --type added --scope JES-33 --message "Add daily consolidated JE job"
+npx @pc360/chlog --type added --scope JES-33 --message "Add daily consolidated JE job"
 ```
 
 Creates:
@@ -87,7 +69,7 @@ File content:
 ### Front-End Change
 
 ```
-chlog --type fixed --scope JES-45 --frontend --message "Fix table pagination issue"
+npx @pc360/chlog --type fixed --scope JES-45 --frontend --message "Fix table pagination issue"
 ```
 
 File content:
@@ -101,7 +83,7 @@ File content:
 ### Module-Based Scope
 
 ```
-chlog --type changed --scope "Credit Validation" --message "Improve credit limit computation"
+npx @pc360/chlog --type changed --scope "Credit Validation" --message "Improve credit limit computation"
 ```
 
 File content:
@@ -171,7 +153,7 @@ Fix FR status blocking issue
 Preview without creating file:
 
 ```
-chlog --type added --scope JES-99 --message "Test entry" --dry-run
+npx @pc360/chlog --type added --scope JES-99 --message "Test entry" --dry-run
 ```
 
 ---

package/lib/chlog-ui.js

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

package/package.json

@@ -1,16 +1,26 @@
 {
   "name": "@pc360/chlog",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "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");
-});