@kntic/kntic 0.4.0 → 0.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kntic/kntic",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "author": "Thomas Robak <contact@kntic.ai> (https://kntic.ai)",
   "description": "KNTIC CLI — bootstrap and manage KNTIC projects",
   "main": "src/index.js",

package/src/cli.js

@@ -16,7 +16,15 @@ if (!subcommand || subcommand === "usage") {
   });
 } else if (subcommand === "start") {
   try {
-    commands.start();
+    const startOpts = { screen: args.includes("--screen") };
+    commands.start(startOpts);
+  } catch (err) {
+    console.error(`Error: ${err.message}`);
+    process.exit(1);
+  }
+} else if (subcommand === "stop") {
+  try {
+    commands.stop();
   } catch (err) {
     console.error(`Error: ${err.message}`);
     process.exit(1);

package/src/commands/index.js

@@ -3,6 +3,7 @@
 const usage = require("./usage");
 const init = require("./init");
 const start = require("./start");
+const stop = require("./stop");
 const update = require("./update");
 
-module.exports = { usage, init, start, update };
+module.exports = { usage, init, start, stop, update };

package/src/commands/start.js

@@ -13,6 +13,10 @@ function isScreenAvailable() {
   }
 }
 
+function isInsideScreen() {
+  return !!process.env.STY;
+}
+
 function getScreenName() {
   try {
     const content = readFileSync(".kntic.env", "utf8");
@@ -26,14 +30,20 @@ function getScreenName() {
   return basename(process.cwd());
 }
 
-function start() {
+function start(options = {}) {
   const composeCmd = "docker compose -f kntic.yml --env-file .kntic.env up --build";
+  const useScreen = !!options.screen;
 
-  if (isScreenAvailable()) {
+  if (useScreen && isScreenAvailable() && !isInsideScreen()) {
     const screenName = getScreenName();
     console.log(`Starting KNTIC services in screen session "${screenName}"…`);
     execSync(`screen -S ${screenName} ${composeCmd}`, { stdio: "inherit" });
   } else {
+    if (useScreen && isInsideScreen()) {
+      console.log("Already inside a screen session, skipping screen wrapper.");
+    } else if (useScreen && !isScreenAvailable()) {
+      console.log("screen is not available, starting without screen wrapper.");
+    }
     console.log("Starting KNTIC services…");
     execSync(composeCmd, { stdio: "inherit" });
   }

package/src/commands/start.test.js

@@ -6,9 +6,14 @@ const fs = require("fs");
 const path = require("path");
 const os = require("os");
 
-// We test the helper logic by requiring the module and inspecting behaviour.
-// Since start.js uses execSync (side-effecting), we test the screen-name
-// resolution logic and the screen-detection path indirectly.
+// Helper: extract a named function from start.js source by evaluating it in isolation.
+function extractFn(fnName) {
+  const src = fs.readFileSync(require.resolve("./start"), "utf8");
+  return new Function("require", "process",
+    src.replace(/^"use strict";\s*/, "")
+       .replace(/module\.exports\s*=\s*start;/, `return ${fnName};`)
+  )(require, process);
+}
 
 describe("start — getScreenName resolution", () => {
   let tmpDir, origCwd;
@@ -26,47 +31,58 @@ describe("start — getScreenName resolution", () => {
 
   it("uses KNTIC_PRJ_PREFIX from .kntic.env when present", () => {
     fs.writeFileSync(path.join(tmpDir, ".kntic.env"), "UID=1000\nKNTIC_PRJ_PREFIX=myproject\nGID=1000\n");
-    // Re-require to get fresh module (clear cache)
     delete require.cache[require.resolve("./start")];
-    // We can't call start() directly (it execs docker), so we extract getScreenName
-    // by reading the source and evaluating the helper in isolation.
-    const src = fs.readFileSync(require.resolve("./start"), "utf8");
-    const getScreenName = new Function("require", "process",
-      src.replace(/^"use strict";\s*/, "")
-         .replace(/module\.exports\s*=\s*start;/, "return getScreenName;")
-    )(require, process);
+    const getScreenName = extractFn("getScreenName");
     assert.equal(getScreenName(), "myproject");
   });
 
   it("falls back to current directory name when KNTIC_PRJ_PREFIX is missing", () => {
     fs.writeFileSync(path.join(tmpDir, ".kntic.env"), "UID=1000\nGID=1000\n");
     delete require.cache[require.resolve("./start")];
-    const src = fs.readFileSync(require.resolve("./start"), "utf8");
-    const getScreenName = new Function("require", "process",
-      src.replace(/^"use strict";\s*/, "")
-         .replace(/module\.exports\s*=\s*start;/, "return getScreenName;")
-    )(require, process);
+    const getScreenName = extractFn("getScreenName");
     assert.equal(getScreenName(), path.basename(tmpDir));
   });
 
   it("falls back to current directory name when .kntic.env does not exist", () => {
     delete require.cache[require.resolve("./start")];
-    const src = fs.readFileSync(require.resolve("./start"), "utf8");
-    const getScreenName = new Function("require", "process",
-      src.replace(/^"use strict";\s*/, "")
-         .replace(/module\.exports\s*=\s*start;/, "return getScreenName;")
-    )(require, process);
+    const getScreenName = extractFn("getScreenName");
     assert.equal(getScreenName(), path.basename(tmpDir));
   });
 
   it("ignores empty KNTIC_PRJ_PREFIX value", () => {
     fs.writeFileSync(path.join(tmpDir, ".kntic.env"), "KNTIC_PRJ_PREFIX=\nUID=1000\n");
     delete require.cache[require.resolve("./start")];
-    const src = fs.readFileSync(require.resolve("./start"), "utf8");
-    const getScreenName = new Function("require", "process",
-      src.replace(/^"use strict";\s*/, "")
-         .replace(/module\.exports\s*=\s*start;/, "return getScreenName;")
-    )(require, process);
+    const getScreenName = extractFn("getScreenName");
     assert.equal(getScreenName(), path.basename(tmpDir));
   });
 });
+
+describe("start — isInsideScreen detection", () => {
+  let origSTY;
+
+  beforeEach(() => {
+    origSTY = process.env.STY;
+  });
+
+  afterEach(() => {
+    if (origSTY === undefined) {
+      delete process.env.STY;
+    } else {
+      process.env.STY = origSTY;
+    }
+  });
+
+  it("returns true when STY environment variable is set", () => {
+    process.env.STY = "12345.myscreen";
+    delete require.cache[require.resolve("./start")];
+    const isInsideScreen = extractFn("isInsideScreen");
+    assert.equal(isInsideScreen(), true);
+  });
+
+  it("returns false when STY environment variable is not set", () => {
+    delete process.env.STY;
+    delete require.cache[require.resolve("./start")];
+    const isInsideScreen = extractFn("isInsideScreen");
+    assert.equal(isInsideScreen(), false);
+  });
+});

package/src/commands/stop.js

@@ -0,0 +1,11 @@
+"use strict";
+
+const { execSync } = require("child_process");
+
+function stop() {
+  const composeCmd = "docker compose -f kntic.yml --env-file .kntic.env stop";
+  console.log("Stopping KNTIC services…");
+  execSync(composeCmd, { stdio: "inherit" });
+}
+
+module.exports = stop;

package/src/commands/stop.test.js

@@ -0,0 +1,17 @@
+"use strict";
+
+const { describe, it } = require("node:test");
+const assert = require("node:assert/strict");
+const fs = require("fs");
+
+describe("stop — module structure", () => {
+  it("exports a function", () => {
+    const stop = require("./stop");
+    assert.equal(typeof stop, "function");
+  });
+
+  it("source contains the correct docker compose stop command", () => {
+    const src = fs.readFileSync(require.resolve("./stop"), "utf8");
+    assert.ok(src.includes("docker compose -f kntic.yml --env-file .kntic.env stop"));
+  });
+});

package/src/commands/usage.js

@@ -7,6 +7,8 @@ function usage() {
   console.log("  usage    List all available sub-commands");
   console.log("  init     Download and extract the KNTIC bootstrap template into the current directory");
   console.log("  start    Build and start KNTIC services via docker compose (uses kntic.yml + .kntic.env)");
+  console.log("             --screen   Run inside a GNU screen session");
+  console.log("  stop     Stop KNTIC services via docker compose");
   console.log("  update   Download the latest KNTIC bootstrap and update .kntic/lib only");
   console.log("");
 }