@pc360/chlog 0.1.11 → 0.2.0

package/CHANGELOG.md

@@ -10,6 +10,18 @@ The format is based on Keep a Changelog, and this project follows Semantic Versi
 
 - No changes yet.
 
+## [0.2.0] - 2026-02-16
+
+### Added
+
+- Added graceful interactive cancel handling: pressing `Ctrl + C` now exits cleanly with `Operation cancelled by user.`
+- Added unit tests for prompt cancellation detection.
+
+### Changed
+
+- Updated README CLI rules to document interactive cancellation behavior and the exact cancellation message.
+- Simplified unit tests by removing redundant parser test cases already covered by CLI integration tests.
+
 ## [0.1.11] - 2026-02-15
 
 ### Added

package/README.md

@@ -36,7 +36,7 @@ npm i -g @pc360/chlog
 Alternative (without global install):
 
 ```bash
-npx @pc360/chlog --type <added|changed|fixed|removed> --scope <scope> --message "<description>"
+npx @pc360/chlog
 ```
 
 ---
@@ -46,19 +46,13 @@ npx @pc360/chlog --type <added|changed|fixed|removed> --scope <scope> --message
 For first use, always run a dry run to preview output without creating a file:
 
 ```bash
-chlog --type added --scope JES-99 --message "Test entry" --dry-run
+chlog --dry-run
 ```
 
-Short form:
+Then run interactively:
 
 ```bash
-chlog -t added -s JES-99 -m "Test entry" -d
-```
-
-If the preview is correct, run the actual command:
-
-```bash
-chlog --type added --scope JES-99 --message "Test entry"
+chlog
 ```
 
 ---
@@ -194,56 +188,14 @@ chlog --version
 
 ---
 
-# Usage
-
-```bash
-chlog --type <added|changed|fixed|removed> \
-      --scope <scope> \
-      --message "<description>" \
-      [--frontend]
-```
-
-Short form:
-
-```bash
-chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>" [-f]
-```
-
----
-
 # Parameters
 
-| Flag             | Required | Description                                         |
-| ---------------- | -------- | --------------------------------------------------- |
-| `-t, --type`     | Yes      | Change type: `added`, `changed`, `fixed`, `removed` |
-| `-s, --scope`    | Yes      | Jira ticket or module name                          |
-| `-m, --message`  | Yes      | Description of the change                           |
-| `-f, --frontend` | No       | Uses `[Front-End]` instead of `[Back-End]`          |
-| `-d, --dry-run`  | No       | Preview file creation without writing               |
-| `-h, --help`     | No       | Show help                                           |
-| `-v, --version`  | No       | Show CLI version                                    |
-
----
-
-# Examples
-
-### Back-End (default)
-
-```bash
-chlog --type added --scope JES-33 --message "Add daily consolidated JE job"
-```
-
-### Front-End
-
-```bash
-chlog --type fixed --scope JES-45 --frontend --message "Fix table pagination issue"
-```
-
-### Module Scope
-
-```bash
-chlog --type changed --scope "Credit Validation" --message "Improve credit limit computation"
-```
+| Flag            | Required | Description                                              |
+| --------------- | -------- | -------------------------------------------------------- |
+| `-d, --dry-run` | No       | Preview file creation without writing                    |
+| `--tz`          | No       | Timezone for filename timestamp (default: `Asia/Manila`) |
+| `-h, --help`    | No       | Show help                                                |
+| `-v, --version` | No       | Show CLI version                                         |
 
 ---
 
@@ -270,9 +222,12 @@ Timezone used: `Asia/Manila`
 
 # CLI Rules
 
-- `--type` is required
-- `--scope` is required
-- `--message` is required
+- Type, scope, message, and layer are collected interactively
+- Type is selected inline/horizontally (`added / changed / fixed / removed`)
+- Layer uses a `Is frontend?` toggle (`No` by default = `Back-End`)
+- After message input in interactive mode, a toggle asks `Display preview?` (`Yes/No`)
+- If preview is shown, a second toggle asks `Do you want to create changelog?` (`Yes/No`)
+- Pressing `Ctrl + C` during interactive prompts cancels the operation and prints `Operation cancelled by user.`
 - Existing files are not overwritten
 - Layer tag is auto-added (`[Back-End]` or `[Front-End]`)
 

package/bin/chlog.js

@@ -17,6 +17,12 @@ const {
   renderSuccess,
   renderError,
 } = require("../lib/chlog-ui");
+const {
+  promptForMissingArgs,
+  promptYesNo,
+  isInteractiveTerminal,
+  isPromptCancelled,
+} = require("../lib/chlog-prompts");
 
 function getHelpText() {
   return `
@@ -29,14 +35,10 @@ Each entry is formatted as:
   [<scope>] [Back-End|Front-End] <message>
 
 Usage:
-  chlog --type <added|changed|fixed|removed> --scope <ticket> --message "<text>" [--frontend]
-  chlog -t <added|changed|fixed|removed> -s <ticket> -m "<text>" [-f]
+  chlog
 
 Options:
-  -t, --type <t>         Entry type (required)
-  -s, --scope <ticket>   Jira ticket or scope (required)
-  -m, --message "<msg>"  Entry message (required)
-  -f, --frontend         Use [Front-End] instead of [Back-End]
+  (type, scope, message, and layer are collected interactively)
   --tz "<iana>"          Timezone (default: Asia/Manila)
   -d, --dry-run          Preview only
   -h, --help             Show help
@@ -46,7 +48,7 @@ Options:
 
 async function main() {
   try {
-    const args = parseArgs(process.argv);
+    let args = parseArgs(process.argv);
 
     if (args.help) {
       await renderHelp(getHelpText());
@@ -58,6 +60,10 @@ async function main() {
       process.exit(0);
     }
 
+    if (isInteractiveTerminal()) {
+      args = await promptForMissingArgs(args);
+    }
+
     validateArgs(args);
 
     const timestamp = generateTimestamp(new Date(), args.tz);
@@ -82,6 +88,17 @@ async function main() {
       process.exit(0);
     }
 
+    if (isInteractiveTerminal() && !args.dryRunSet) {
+      const shouldPreview = await promptYesNo("Display preview?", false);
+      if (shouldPreview) {
+        await renderDryRun({ entryPath, content });
+        const shouldExecute = await promptYesNo("Do you want to create changelog?", true);
+        if (!shouldExecute) {
+          process.exit(0);
+        }
+      }
+    }
+
     await fs.mkdir(entryDir, { recursive: true });
 
     await fs.writeFile(entryPath, content, {
@@ -91,6 +108,11 @@ async function main() {
 
     await renderSuccess({ entryPath });
   } catch (err) {
+    if (isPromptCancelled(err)) {
+      process.stdout.write("Operation cancelled by user.\n");
+      process.exit(0);
+    }
+
     await renderError(err);
     process.exit(1);
   }

package/lib/chlog-lib.js

@@ -9,7 +9,9 @@ function parseArgs(argv) {
     message: null,
     tz: "Asia/Manila",
     frontend: false,
+    layerSet: false,
     dryRun: false,
+    dryRunSet: false,
     help: false,
     version: false,
   };
@@ -29,26 +31,7 @@ function parseArgs(argv) {
 
     if (arg === "--dry-run" || arg === "-d") {
       args.dryRun = true;
-      continue;
-    }
-
-    if (arg === "--frontend" || arg === "-f") {
-      args.frontend = true;
-      continue;
-    }
-
-    if (arg === "--type" || arg === "-t") {
-      args.type = argv[++i];
-      continue;
-    }
-
-    if (arg === "--scope" || arg === "-s") {
-      args.scope = argv[++i];
-      continue;
-    }
-
-    if (arg === "--message" || arg === "-m") {
-      args.message = argv[++i];
+      args.dryRunSet = true;
       continue;
     }
 
@@ -67,13 +50,19 @@ function validateArgs(args) {
   if (!args.type || !VALID_TYPES.has(args.type)) {
     throw new Error(`--type must be one of: added, changed, fixed, removed`);
   }
-  if (!args.scope) {
+  const normalizedScope = String(args.scope ?? "").trim();
+  const normalizedMessage = String(args.message ?? "").trim();
+
+  if (!normalizedScope) {
     throw new Error(`--scope is required (e.g. JES-33)`);
   }
-  if (!args.message) {
+  if (!normalizedMessage) {
     throw new Error(`--message is required`);
   }
 
+  args.scope = normalizedScope;
+  args.message = normalizedMessage;
+
   // Validate timezone (throws RangeError if invalid)
   new Intl.DateTimeFormat("en-US", { timeZone: args.tz }).format(new Date());
 

package/lib/chlog-prompts.js

@@ -0,0 +1,200 @@
+"use strict";
+
+const { VALID_TYPES } = require("./chlog-lib");
+
+class InlineChoicePrompt {
+  constructor({ message, choices, initial = 0 }) {
+    const Prompt = require("enquirer/lib/prompt");
+
+    this.Prompt = class extends Prompt {
+      constructor(options) {
+        super(options);
+        this.cursorHide();
+        this.choices = options.choices.map((choice) =>
+          typeof choice === "string"
+            ? { name: choice, message: choice }
+            : { name: choice.name, message: choice.message ?? choice.name },
+        );
+        this.index = Math.max(
+          0,
+          Math.min(options.initial ?? 0, this.choices.length - 1),
+        );
+        this.value = this.choices[this.index]?.name;
+      }
+
+      left() {
+        if (this.index <= 0) {
+          this.alert();
+          return;
+        }
+        this.index -= 1;
+        this.value = this.choices[this.index].name;
+        this.render();
+      }
+
+      right() {
+        if (this.index >= this.choices.length - 1) {
+          this.alert();
+          return;
+        }
+        this.index += 1;
+        this.value = this.choices[this.index].name;
+        this.render();
+      }
+
+      up() {
+        this.left();
+      }
+
+      down() {
+        this.right();
+      }
+
+      number(input) {
+        const nextIndex = Number(input) - 1;
+        if (
+          Number.isNaN(nextIndex) ||
+          nextIndex < 0 ||
+          nextIndex >= this.choices.length
+        ) {
+          this.alert();
+          return;
+        }
+        this.index = nextIndex;
+        this.value = this.choices[this.index].name;
+        this.render();
+      }
+
+      format() {
+        return this.choices
+          .map((choice, idx) => {
+            if (idx === this.index) {
+              return this.styles.primary.underline(choice.message);
+            }
+            return this.styles.muted(choice.message);
+          })
+          .join(this.styles.muted(" / "));
+      }
+
+      async render() {
+        const { size } = this.state;
+
+        const header = await this.header();
+        const prefix = await this.prefix();
+        const separator = await this.separator();
+        const message = await this.message();
+        const output = this.format();
+        const help =
+          (await this.error()) ||
+          this.styles.muted("(left/right or 1-4, enter)");
+        const footer = await this.footer();
+
+        let prompt = [prefix, message, separator, output].join(" ");
+        this.state.prompt = prompt;
+        if (help && !prompt.includes(help)) {
+          prompt += " " + help;
+        }
+
+        this.clear(size);
+        this.write([header, prompt, footer].filter(Boolean).join("\n"));
+        this.write(this.margin[2]);
+        this.restore();
+      }
+    };
+
+    this.options = { name: "inlineChoice", message, choices, initial };
+  }
+
+  async run() {
+    const prompt = new this.Prompt(this.options);
+    return prompt.run();
+  }
+}
+
+async function promptForMissingArgs(args) {
+  const { Toggle, Input } = require("enquirer");
+  const nextArgs = { ...args };
+
+  if (!nextArgs.type) {
+    const typePrompt = new InlineChoicePrompt({
+      message: "Select changelog type:",
+      choices: Array.from(VALID_TYPES),
+      initial: 0,
+    });
+    nextArgs.type = await typePrompt.run();
+  }
+
+  if (!nextArgs.layerSet) {
+    const layerPrompt = new Toggle({
+      name: "frontend",
+      message: "Is frontend?",
+      enabled: "Yes",
+      disabled: "No",
+      initial: false,
+    });
+    nextArgs.frontend = Boolean(await layerPrompt.run());
+    nextArgs.layerSet = true;
+  }
+
+  if (!nextArgs.scope) {
+    const scopePrompt = new Input({
+      name: "scope",
+      message: "Enter scope/ticket (e.g. JES-33)",
+      validate: (value) =>
+        String(value ?? "").trim() ? true : "Scope is required",
+    });
+    nextArgs.scope = String(await scopePrompt.run()).trim();
+  }
+
+  if (!nextArgs.message) {
+    const messagePrompt = new Input({
+      name: "message",
+      message: "Enter changelog message",
+      validate: (value) =>
+        String(value ?? "").trim() ? true : "Message is required",
+    });
+    nextArgs.message = String(await messagePrompt.run()).trim();
+  }
+
+  return nextArgs;
+}
+
+async function promptYesNo(message, initial = false) {
+  const { Toggle } = require("enquirer");
+  const prompt = new Toggle({
+    name: "confirm",
+    message,
+    enabled: "Yes",
+    disabled: "No",
+    initial,
+  });
+
+  return Boolean(await prompt.run());
+}
+
+function isInteractiveTerminal() {
+  return Boolean(process.stdin.isTTY && process.stdout.isTTY);
+}
+
+function isPromptCancelled(error) {
+  if (error == null || error === "") {
+    return true;
+  }
+
+  if (typeof error === "string") {
+    return /cancel(?:led|ed)?|abort(?:ed)?|interrupt(?:ed)?/i.test(error);
+  }
+
+  if (error instanceof Error) {
+    return /cancel(?:led|ed)?|abort(?:ed)?|interrupt(?:ed)?/i.test(error.message);
+  }
+
+  return false;
+}
+
+module.exports = {
+  promptForMissingArgs,
+  promptYesNo,
+  isInteractiveTerminal,
+  isPromptCancelled,
+};

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@pc360/chlog",
-  "version": "0.1.11",
+  "version": "0.2.0",
   "description": "PC360 Changelog CLI Tool",
-  "author": "aalmazan@pcdsi.ph",
+  "keywords": [
+    "changelog",
+    "cli"
+  ],
+  "author": "almerleoalmazan@gmail.com",
   "bin": {
     "chlog": "bin/chlog.js"
   },
@@ -21,6 +25,7 @@
   },
   "dependencies": {
     "@pc360/chlog": "^0.1.7",
+    "enquirer": "^2.4.1",
     "ink": "^4.4.1",
     "react": "^18.3.1"
   },