schrun 0.2.3 → 0.3.0

package/README.md

@@ -1,61 +1,70 @@
-# schrun
+<p align="center">
+  <img src="./assets/schrun-logo-small.jpg" alt="schrun logo">
+</p>
 
-`schrun` is a small task runner for launching commands defined in JSON files. It supports running a task in the foreground or starting it as a detached background process.
+<h1 align="center">schrun</h1>
+
+`schrun` is a small task runner. It reads task definitions from JSON files and can run them in the foreground, start them in the background, or schedule enabled tasks with cron expressions.
+
+> [!TIP]
+> `schrun` is a completely independent package and is not related to any other tools.
 
 ## Requirements
 
 - [Bun](https://bun.sh/)
 
-## Installation
-
-From the repository root, install the workspace dependencies:
+## Install and run from this repository
 
-```bash
+```sh
 bun install
 ```
 
-## Configure a task
+Until a published package is available, run the CLI from the repository root with Bun:
 
-Create the configuration directory and a JSON file inside it. The file name is the task identifier passed to `schrun` (it does not need a `.json` extension).
-
-```bash
-mkdir -p ~/.config/schrun
+```sh
+bunx schrun --surface hello
+bunx schrun --background hello
 ```
 
-For example, save the following as `~/.config/schrun/hello.json`:
+The task name is passed without the `.json` extension. schrun reads `~/.config/schrun/<name>.json`.
+
+## Define a task
+
+Create `~/.config/schrun/hello.json`:
 
 ```json
 {
   "id": 1,
   "description": "Print a greeting",
-  "run": "echo hello"
+  "cron": "* * * * *",
+  "run": "echo hello",
+  "enabled": true
 }
 ```
 
-Each task file must contain:
-
-- `id`: a number
-- `description`: a string
-- `run`: a command and its arguments, separated by whitespace
+Every field is required: `id` (number), `description` (string), `cron` (cron expression string), `run` (command string), and `enabled` (boolean). The scheduler considers only enabled tasks.
 
-## Run a task
+## Run tasks
 
-Run from the repository root:
+Foreground mode inherits standard input/output and waits for the command to finish:
 
-```bash
-bun run apps/schrun/src/index.ts hello.json
+```sh
+bunx schrun --surface hello
 ```
 
-The command inherits the terminal's standard input and output, and `schrun` waits for it to finish.
-
-To start it detached in the background:
+Detached background mode ignores standard input/output and returns after starting the process:
 
-```bash
-bun run apps/schrun/src/index.ts --background hello.json
+```sh
+bunx schrun --background hello
 ```
 
-Background tasks have their standard input and output ignored; `schrun` returns after starting the process.
+Start or stop the scheduler:
+
+```sh
+bunx schrun run --start
+bunx schrun run --stop
+```
 
 ## Limitations
 
-The `run` value is split on whitespace and launched directly, without a shell. Shell features such as pipes, redirects, variable expansion, and quoted arguments are not interpreted.
+Commands are split on whitespace and launched directly, without a shell. Pipes, redirects, variable expansion, and quoted arguments are not interpreted. Use a script file when a task needs shell features.

package/dist/daemon.mjs

@@ -1,14 +1,14 @@
-import { r as CONFIG_DIR, t as readJSON } from "./readJSON-p8OldMa9.mjs";
+import { r as CONFIG_DIR, t as readJSON } from "./readJSON-BIHboQ76.mjs";
 import { readdir } from "node:fs/promises";
 import { consola } from "consola";
 import { spawn } from "node:child_process";
 import cron from "node-cron";
-//#region src/run/daemon.ts
+// src/run/daemon.ts
 const startschedule = async () => {
 	const readConfig = await readdir(CONFIG_DIR);
 	for (const filename of readConfig) {
 		if (!filename.endsWith(".json")) continue;
-		if (!filename.match("foo.json")) continue;
+		if (filename.match("pid.json")) continue;
 		const [filenamesplit] = filename.split(".");
 		const read = await readJSON(filenamesplit);
 		if (!read.enabled) continue;
@@ -28,5 +28,4 @@ startschedule().catch((error) => {
 	consola.error("failed to up scheduler", error);
 	process.exitCode = 1;
 });
-//#endregion
 export { startschedule };

package/dist/index.mjs

@@ -1,17 +1,17 @@
 #!/usr/bin/env node
-import { i as PID_FILE, n as CLI_COMMAND_NAME, t as readJSON } from "./readJSON-p8OldMa9.mjs";
+import { i as PID_FILE, n as CLI_COMMAND_NAME, r as CONFIG_DIR, t as readJSON } from "./readJSON-BIHboQ76.mjs";
 import { cli, define } from "gunshi";
-import { open, readFile, unlink, writeFile } from "node:fs/promises";
+import { readFile, readdir, unlink, writeFile } from "node:fs/promises";
 import { consola } from "consola";
 import { spawn } from "node:child_process";
 import { fileURLToPath } from "node:url";
-//#region src/version.ts
+import Table from "cli-table3";
+// src/version.ts
 const version = async () => {
 	const packageJsonText = await readFile(new URL("../package.json", import.meta.url), "utf-8");
 	return JSON.parse(packageJsonText).version;
 };
-//#endregion
-//#region src/run/background.ts
+// src/run/background.ts
 const runbackground = async (FileName) => {
 	const [command, ...args] = (await readJSON(FileName)).run.split(/\s+/);
 	if (!command) {
@@ -27,8 +27,7 @@ const runbackground = async (FileName) => {
 	});
 	spawncli.unref();
 };
-//#endregion
-//#region src/run/surface.ts
+// src/run/surface.ts
 const runsurface = async (FileName) => {
 	const [command, ...args] = (await readJSON(FileName)).run.split(/\s+/);
 	if (!command) {
@@ -43,55 +42,43 @@ const runsurface = async (FileName) => {
 		consola.success(`done code: ${code}`);
 	});
 };
-//#endregion
-//#region src/run/startscheduler.ts
-const startschedule = async () => {
+// src/run/startScheduler.ts
+const startSchedule = async () => {
 	const daemonPath = fileURLToPath(new URL("./daemon.mjs", import.meta.url));
-	const logFile = await open("/tmp/schrun-daemon.log", "a");
 	const child = spawn(process.execPath, [daemonPath], {
 		detached: true,
-		stdio: [
-			"ignore",
-			logFile.fd,
-			logFile.fd
-		]
+		stdio: "ignore"
 	});
-	if (child.pid === void 0) {
-		await logFile.close();
-		throw new Error("Failed to start daemon");
-	}
+	if (child.pid === void 0) throw new Error("Failed to start daemon");
 	child.on("error", (error) => {
-		console.error("Failed to start daemon:", error);
+		throw new Error("Failed to start daemon:", error);
 	});
-	await writeFile(PID_FILE, String(child.pid));
+	await writeFile(PID_FILE, String(child.pid), "utf-8");
 	child.unref();
-	await logFile.close();
 };
-//#endregion
-//#region src/run/stopscheduler.ts
-const stopschedule = async () => {
+// src/run/stopScheduler.ts
+const stopSchedule = async () => {
 	let pid;
 	try {
 		pid = Number(await readFile(PID_FILE, "utf-8"));
-	} catch {
-		consola.warn("no look schedule pid file");
+	} catch (error) {
+		consola.warn("No look schedule pid file");
 		return;
 	}
 	if (!Number.isSafeInteger(pid) || pid <= 0) {
-		consola.error("warning pid files");
+		consola.error("Unsafe pid files");
 		return;
 	}
 	try {
 		process.kill(pid, "SIGINT");
-		consola.success("send stop to scheduler");
+		consola.success("Success Send stop scheduler");
 	} catch (error) {
-		consola.error("failed stop to scheduler", error);
+		consola.error("Failed Send stop scheduler", error);
 		return;
 	}
 	await unlink(PID_FILE).catch(() => {});
 };
-//#endregion
-//#region src/commands/run/index.ts
+// src/commands/run/index.ts
 const runCommand = {
 	name: "run",
 	args: {
@@ -108,20 +95,47 @@ const runCommand = {
 	},
 	run: (ctx) => {
 		const { start, stop } = ctx.values;
-		if (start == true) startschedule();
-		if (stop == true) stopschedule();
+		if (start == true) startSchedule();
+		if (stop == true) stopSchedule();
+	}
+};
+// src/table.ts
+const list = async () => {
+	const read = await readdir(CONFIG_DIR);
+	if (read.length === 0) consola.error("No schedule found");
+	const table = new Table({ head: [
+		"description",
+		"cron",
+		"run",
+		"enabled"
+	] });
+	for (const readdir of read) {
+		if (readdir.match("pid.json")) continue;
+		const [splits] = readdir.split(".");
+		const readfunc = await readJSON(splits);
+		table.push([
+			readfunc.description,
+			readfunc.cron,
+			readfunc.run,
+			readfunc.enabled
+		]);
 	}
+	console.log(table.toString());
 };
-//#endregion
-//#region src/commands/default/index.ts
+// src/commands/list/index.ts
+const listCommand = {
+	name: "list",
+	run: list
+};
+// src/commands/default/index.ts
 const mainCommand = async () => {
 	const RunmainCommand = define({
 		name: CLI_COMMAND_NAME,
 		description: "agent and other task runner",
 		version: await version(),
 		args: {
-			defaultInput: {
-				type: "positional",
+			surface: {
+				type: "string",
 				required: false,
 				description: "Input value"
 			},
@@ -132,15 +146,15 @@ const mainCommand = async () => {
 			}
 		},
 		run: async (ctx) => {
-			const { defaultInput, background } = ctx.values;
+			const { surface, background } = ctx.values;
 			if (background !== void 0) {
 				console.log("Background mode:", background);
 				await runbackground(background);
 				return;
 			}
-			if (defaultInput !== void 0) {
-				console.log("Normal mode:", defaultInput);
-				await runsurface(defaultInput);
+			if (surface !== void 0) {
+				console.log("Normal mode:", surface);
+				await runsurface(surface);
 				return;
 			}
 			consola.error("No Input String");
@@ -148,11 +162,12 @@ const mainCommand = async () => {
 	});
 	await cli(process.argv.slice(2), RunmainCommand, {
 		name: CLI_COMMAND_NAME,
-		subCommands: { run: runCommand }
+		subCommands: {
+			run: runCommand,
+			list: listCommand
+		}
 	});
 };
-//#endregion
-//#region src/index.ts
+// src/index.ts
 await mainCommand();
-//#endregion
 export {};

package/dist/{readJSON-p8OldMa9.mjs → readJSON-BIHboQ76.mjs}

@@ -1,29 +1,18 @@
 import { readFile } from "node:fs/promises";
-import { consola } from "consola";
 import { join } from "node:path";
 import { homedir } from "node:os";
-import { z } from "zod";
-//#region src/constant/app.ts
+import "zod";
+import typia from "typia";
+// src/constant/app.ts
 const CLI_COMMAND_NAME = "schrun";
 const CONFIG_DIR = join(`${homedir()}`, ".config", "schrun");
 const PID_FILE = join(`${homedir()}`, ".config", "schrun", "pid.json");
-//#endregion
-//#region src/type.ts
-const fileSchema = z.object({
-	id: z.number(),
-	description: z.string(),
-	cron: z.string(),
-	run: z.string(),
-	enabled: z.boolean()
-});
-//#endregion
-//#region src/readJSON.ts
+// src/readJSON.ts
 const readJSON = async (FileName) => {
 	const file = join(CONFIG_DIR, `${FileName}.json`);
 	const reads = await readFile(file, "utf-8");
-	const safeParseSchema = fileSchema.safeParse(JSON.parse(reads));
-	if (!safeParseSchema.success) throw consola.error(safeParseSchema.error);
-	return safeParseSchema.data;
+	const readparse = JSON.parse(reads);
+	if (typia.is(readparse)) return readparse;
+	else throw "The configuration format is invalid";
 };
-//#endregion
 export { PID_FILE as i, CLI_COMMAND_NAME as n, CONFIG_DIR as r, readJSON as t };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "schrun",
   "module": "src/index.ts",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "type": "module",
   "license": "MIT",
   "bin": {
@@ -15,6 +15,7 @@
   "files": [
     "dist",
     "package.json",
+    "bun.lock",
     "README.md"
   ],
   "devDependencies": {
@@ -25,10 +26,12 @@
     "typescript": "^7"
   },
   "dependencies": {
+    "cli-table3": "^0.6.5",
     "consola": "^3.4.2",
     "execa": "^10.1.0",
     "gunshi": "^0.37.3",
     "node-cron": "^4.6.0",
+    "typia": "^15.2.1",
     "zod": "^4.6.7"
   }
 }