@mbsi/mkcmd 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.1] - 2025-12-30
+### Added
+- `CHANGELOG.md` for tracking changes
+
+### Changed
+- Simplified `file-utils.ts` by removing path caching (was causing issues with non-existent directories)
+
+### Fixed
+- Directory creation bug: `realpath()` now replaced with `resolve()` to handle new target directories
+- Path resolution in bundled code for version command
+
+### Removed
+- Path caching in `file-utils.ts` (unnecessary optimization causing failures)
+- Removed unused imports in `src/functions/orchestrate-scaffold.ts` to lint warnings
+
+## [0.2.0] - 2025-12-30
+
+### Added
+- Build system with `bun build --target=bun`
+- Build scripts: `build`, `build:exe`, `prepack`
+- npm package preparation (removed `private: true`)
+
+
+### Changed
+- Moved `typescript` from peerDependencies to devDependencies
+- Updated package.json entry points to `./dist/index.js`
+- Fixed `--version` command to use `process.cwd()` for package.json resolution
+
+## [0.1.0] - 2025-12-30
+
+### Added
+- Initial CLI scaffolding tool
+- Interactive project setup with `@clack/prompts`
+- Full CLI scaffold generation (package.json, tsconfig.json, README.md, core files)
+- `FileBuilder` utility for indentation-aware code generation
+- `file-utils` for path resolution and file writing
+- Dynamic core file copying (all `.ts` files in `src/core/`)
+- `init` command for scaffolding new CLI projects
+- `--help` and `--version` flags

package/README.md

@@ -2,6 +2,8 @@
 
 A remote node executable for scaffolding other remote node executables with sensible defaults.
 
+**Version:** 0.2.0 | See [CHANGELOG.md](./CHANGELOG.md) for version history.
+
 ## Features
 
 - **Interactive Project Setup** - Prompts for project name, target directory, and description using `@clack/prompts`
@@ -106,4 +108,4 @@ npm publish
 
 This project was created using `bun init` in bun v1.2.13. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
 
-See [AGENTS.md](./AGENTS.md) for development guidelines and [RETRO.md](./RETRO.md) for session retrospective.
+See [AGENTS.md](./AGENTS.md) for development guidelines, [CHANGELOG.md](./CHANGELOG.md) for version history.

package/dist/index.js

@@ -2123,19 +2123,10 @@ async function promptProjectDetails() {
 }
 
 // src/core/helpers/file-utils.ts
-import { mkdir, realpath } from "fs/promises";
-import { join as join3 } from "path";
-var pathCache = new Map;
-async function getRealPath(dir) {
-  if (!pathCache.has(dir)) {
-    const real = await realpath(dir);
-    pathCache.set(dir, real);
-  }
-  return pathCache.get(dir);
-}
+import { mkdir } from "fs/promises";
+import { resolve, join as join3 } from "path";
 async function writeFileTuple([targetDir, relativePath, content]) {
-  const realDir = await getRealPath(targetDir);
-  const fullPath = join3(realDir, relativePath);
+  const fullPath = resolve(targetDir, relativePath);
   await mkdir(join3(fullPath, ".."), { recursive: true });
   await Bun.write(fullPath, content);
 }

package/package.json

@@ -1,24 +1,24 @@
 {
-	"name": "@mbsi/mkcmd",
-	"version": "0.2.0",
-	"main": "./dist/index.js",
-	"module": "./dist/index.js",
-	"type": "module",
-	"bin": {
-		"mkcmd": "./dist/index.js"
-	},
-	"scripts": {
-		"build": "bun build --target=bun --outfile=dist/index.js src/index.ts",
-		"build:exe": "bun build --compile --outfile=dist/mkcmd src/index.ts",
-		"prepack": "bun run build"
-	},
-	"devDependencies": {
-		"@types/bun": "latest",
-		"typescript": "^5"
-	},
-	"dependencies": {
-		"@clack/prompts": "^0.11.0",
-		"@types/figlet": "^1.7.0",
-		"figlet": "^1.9.4"
-	}
+  "name": "@mbsi/mkcmd",
+  "version": "0.2.1",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "type": "module",
+  "bin": {
+    "mkcmd": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "bun build --target=bun --outfile=dist/index.js src/index.ts",
+    "build:exe": "bun build --compile --outfile=dist/mkcmd src/index.ts",
+    "prepack": "bun run build"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "@clack/prompts": "^0.11.0",
+    "@types/figlet": "^1.7.0",
+    "figlet": "^1.9.4"
+  }
 }

package/src/commands/index.ts

@@ -1,13 +0,0 @@
-import { registerCommand } from "../core/cli";
-import { orchestrateScaffold } from "../functions/orchestrate-scaffold";
-
-export function registerCommands() {
-  registerCommand({
-    name: "init",
-    description: "Initialize a new CLI project",
-    instructions: "You will be prompted for project details",
-    run: async () => {
-      await orchestrateScaffold();
-    },
-  });
-}

package/src/config.ts

@@ -1,6 +0,0 @@
-export const config = {
-  about_text:
-    "mkcmd is a remote node executable for scaffolding other remote node executables with sensible defaults.",
-  more_info_text:
-    "See https://github.com/mackenziebowes/mkcmd for more details.",
-};

package/src/core/cli.ts

@@ -1,93 +0,0 @@
-import log from "./log";
-import { join } from "node:path";
-import { config } from "../config";
-
-export type Command = {
-  name: string;
-  description: string;
-  instructions: string;
-  run: (args: string[]) => Promise<void> | void;
-};
-
-const commands = new Map<string, Command>();
-
-export function registerCommand(cmd: Command) {
-  commands.set(cmd.name, cmd);
-}
-
-export async function runCLI(argv = Bun.argv.slice(2)) {
-  const [name, ...args] = argv;
-  // -- TS Defense --
-  if (!name) {
-    log.single.err("ARGS", "No Argument Supplied");
-    return;
-  }
-  if (["-h", "--help"].includes(name)) {
-    const multiLog: any[] = [];
-    multiLog.push({
-      t: "About",
-      m: config.about_text,
-    });
-    multiLog.push({
-      t: "Commands",
-      m: "Available Commands",
-    });
-    for (const cmd of commands.values()) {
-      multiLog.push({
-        t: cmd.name,
-        m: `${cmd.description}\n  |->  [Instructions]: ${cmd.instructions}\n`,
-      });
-    }
-    multiLog.push({
-      t: "More Info",
-      m: config.more_info_text,
-    });
-    log.multi.info(multiLog);
-    return;
-  }
-
-  if (["-v", "--version"].includes(name)) {
-    const pkgText = await Bun.file(join(process.cwd(), "package.json")).text();
-    const pkg = JSON.parse(pkgText);
-    log.multi.info([
-      {
-        t: "Package Name",
-        m: pkg.name,
-      },
-      {
-        t: "Package Version",
-        m: pkg.version,
-      },
-    ]);
-    return;
-  }
-
-  const command = commands.get(name);
-  if (!command) {
-    log.single.err("Command", "No Command Supplied");
-    process.exit(1);
-  }
-
-  try {
-    await command.run(args);
-  } catch (err) {
-    const multilog: any[] = [];
-    multilog.push({
-      t: "Panic",
-      m: `Failed to run ${name}`,
-    });
-    if (err instanceof Error) {
-      multilog.push({
-        t: "Error",
-        m: err.message,
-      });
-    } else {
-      multilog.push({
-        t: "Unknown Error",
-        m: JSON.stringify(err),
-      });
-    }
-    log.multi.err(multilog);
-    process.exit(1);
-  }
-}

package/src/core/helpers/file-builder.ts

@@ -1,19 +0,0 @@
-export function line(content: string, depth: number): string {
-  return `\n${"\t".repeat(depth)}${content}`;
-}
-
-export class FileBuilder {
-  private lines: string[] = [];
-
-  addLine(content: string, depth: number = 0): void {
-    this.lines.push(`${"\t".repeat(depth)}${content}`);
-  }
-
-  addEmptyLine(): void {
-    this.lines.push("");
-  }
-
-  build(): string {
-    return this.lines.join("\n");
-  }
-}

package/src/core/helpers/file-utils.ts

@@ -1,19 +0,0 @@
-import { mkdir, realpath } from "node:fs/promises";
-import { join } from "node:path";
-
-const pathCache = new Map<string, string>();
-
-export async function getRealPath(dir: string): Promise<string> {
-  if (!pathCache.has(dir)) {
-    const real = await realpath(dir);
-    pathCache.set(dir, real);
-  }
-  return pathCache.get(dir)!;
-}
-
-export async function writeFileTuple([targetDir, relativePath, content]: [string, string, string]): Promise<void> {
-  const realDir = await getRealPath(targetDir);
-  const fullPath = join(realDir, relativePath);
-  await mkdir(join(fullPath, ".."), { recursive: true });
-  await Bun.write(fullPath, content);
-}

package/src/core/log.ts

@@ -1,82 +0,0 @@
-import figlet from "figlet";
-
-const infoLogSingle = (title: string, message: string) => {
-  console.log("");
-  console.info("  [INFO]");
-  console.info(`  [${title}]: ${message}`);
-  console.log("");
-};
-
-type MultiLogArgs = {
-  t: string;
-  m: string;
-}[];
-
-const infoLogMulti = (args: MultiLogArgs) => {
-  console.log("");
-  console.info("  [INFO]");
-  for (const arg of args) {
-    console.info(`  [${arg.t}]: ${arg.m}`);
-  }
-  console.log("");
-};
-
-const warnLogSingle = (title: string, message: string) => {
-  console.log("");
-  console.warn("  [WARNING]");
-  console.warn(`  [${title}]: ${message}`);
-  console.log("");
-};
-
-const warnLogMulti = (args: MultiLogArgs) => {
-  console.log("");
-  console.warn("  [WARNING]");
-  for (const arg of args) {
-    console.warn(`  [${arg.t}]: ${arg.m}`);
-  }
-  console.log("");
-};
-
-const errLogSingle = (title: string, message: string) => {
-  console.log("");
-  console.error("  [ERROR]");
-  console.error(`  [${title}]: ${message}`);
-  console.log("");
-};
-
-const errLogMulti = (args: MultiLogArgs) => {
-  console.log("");
-  console.error("  [ERROR]");
-  for (const arg of args) {
-    console.error(`  [${arg.t}]: ${arg.m}`);
-  }
-  console.log("");
-};
-
-const title = (title: string, subtitle?: string) => {
-  console.clear();
-  console.log();
-  console.log(
-    figlet.textSync(title, {
-      font: "ANSI Regular",
-    }),
-  );
-  console.log(`  [${subtitle}]`);
-  console.log();
-};
-
-const log = {
-  single: {
-    info: infoLogSingle,
-    warn: warnLogSingle,
-    err: errLogSingle,
-  },
-  multi: {
-    info: infoLogMulti,
-    warn: warnLogMulti,
-    err: errLogMulti,
-  },
-  title,
-};
-
-export default log;

package/src/data/init.ts

@@ -1,102 +0,0 @@
-import { FileBuilder } from "../core/helpers/file-builder";
-
-export const commands_init = () => {
-  const file = new FileBuilder();
-  file.addLine(`import { registerCommand } from "../core/cli";`, 0);
-  file.addEmptyLine();
-  file.addLine(`export function registerCommands() {}`, 0);
-  return file.build();
-};
-
-export const config_init = (about: string) => {
-  const file = new FileBuilder();
-  file.addLine(`export const config = {`, 0);
-  file.addLine(`about_text:`, 2);
-  file.addLine(`"${about}",`, 1);
-  file.addLine(`more_info_text:`, 2);
-  file.addLine(
-    `"See https://github.com/mackenziebowes/mkcmd for more details.",`,
-    1,
-  );
-  file.addLine(`};`, 0);
-  return file.build();
-};
-
-export const package_init = (name: string) => {
-  const file = new FileBuilder();
-  file.addLine(`{`, 0);
-  file.addLine(`"name": "${name}",`, 1);
-  file.addLine(`"module": "index.ts",`, 1);
-  file.addLine(`"type": "module",`, 1);
-  file.addLine(`"private": true,`, 1);
-  file.addLine(`"bin": {`, 1);
-  file.addLine(`"${name.split(" ").join("")}": "./src/index.ts"`, 2);
-  file.addLine(`},`, 1);
-  file.addLine(`"devDependencies": {`, 1);
-  file.addLine(`"@types/bun": "latest"`, 2);
-  file.addLine(`},`, 1);
-  file.addLine(`"peerDependencies": {`, 1);
-  file.addLine(`"typescript": "^5"`, 2);
-  file.addLine(`},`, 1);
-  file.addLine(`"dependencies": {`, 1);
-  file.addLine(`"@clack/prompts": "^0.11.0",`, 2);
-  file.addLine(`"@types/figlet": "^1.7.0",`, 2);
-  file.addLine(`"figlet": "^1.9.4"`, 2);
-  file.addLine(`}`, 1);
-  file.addLine(`}`, 0);
-  return file.build();
-};
-
-export const readme_init = (name: string) => {
-  const file = new FileBuilder();
-  file.addLine(`# ${name}`);
-  file.addEmptyLine();
-  file.addLine(`To install dependencies:`);
-  file.addEmptyLine();
-  file.addLine("```bash");
-  file.addLine("bun install");
-  file.addLine("```");
-  file.addEmptyLine();
-  file.addLine("To run:");
-  file.addLine("```bash");
-  file.addLine("bun run index.ts");
-  file.addLine("```");
-  file.addLine(
-    "This project was created using `bun init` in bun v1.2.13. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.",
-  );
-  return file.build();
-};
-
-export const tsconfig_init = () => {
-  const file = new FileBuilder();
-  file.addLine(`{`, 0);
-  file.addLine(`"compilerOptions": {`, 1);
-  file.addEmptyLine();
-  file.addLine(`// Environment setup & latest features`, 1);
-  file.addLine(`"lib": ["ESNext"],`, 1);
-  file.addLine(`"target": "ESNext",`, 1);
-  file.addLine(`"module": "ESNext",`, 1);
-  file.addLine(`"moduleDetection": "force",`, 1);
-  file.addLine(`"jsx": "react-jsx",`, 1);
-  file.addLine(`"allowJs": true,`, 1);
-  file.addEmptyLine();
-  file.addLine(`// Bundler mode`, 1);
-  file.addLine(`"moduleResolution": "bundler",`, 1);
-  file.addLine(`"allowImportingTsExtensions": true,`, 1);
-  file.addLine(`"verbatimModuleSyntax": true,`, 1);
-  file.addLine(`"noEmit": true,`, 1);
-  file.addEmptyLine();
-  file.addLine(`// Best practices`, 1);
-  file.addLine(`"strict": true,`, 1);
-  file.addLine(`"skipLibCheck": true,`, 1);
-  file.addLine(`"noFallthroughCasesInSwitch": true,`, 1);
-  file.addLine(`"noUncheckedIndexedAccess": true,`, 1);
-  file.addEmptyLine();
-  file.addLine(`// Some stricter flags (disabled by default)`, 1);
-  file.addLine(`"noUnusedLocals": false,`, 1);
-  file.addLine(`"noUnusedParameters": false,`, 1);
-  file.addLine(`"noPropertyAccessFromIndexSignature": false`, 1);
-  file.addLine(`}`, 1);
-  file.addLine(`}`, 0);
-  return file.build();
-};

package/src/functions/orchestrate-scaffold.ts

@@ -1,21 +0,0 @@
-import { promptProjectDetails, ProjectPrompts } from "./prompt-project";
-import { scaffoldProject } from "./scaffold-project";
-import { scaffoldCore } from "./scaffold-core";
-import log from "../core/log";
-import { config } from "../config";
-
-export async function orchestrateScaffold() {
-  const prompts = await promptProjectDetails();
-
-  await scaffoldProject(prompts);
-  log.single.info("Project", "Project files created");
-
-  await scaffoldCore(prompts.targetDir);
-  log.single.info("Core", "Core files copied");
-
-  log.multi.info([
-    { t: "Success", m: "Project scaffolded successfully!" },
-    { t: "Location", m: prompts.targetDir },
-    { t: "Next", m: `cd ${prompts.targetDir} && bun install` },
-  ]);
-}

package/src/functions/prompt-project.ts

@@ -1,31 +0,0 @@
-import { text, intro, outro } from "@clack/prompts";
-
-export interface ProjectPrompts {
-  projectName: string;
-  targetDir: string;
-  description: string;
-}
-
-export async function promptProjectDetails(): Promise<ProjectPrompts> {
-  intro("mkcmd - Scaffold a new CLI project");
-
-  const projectName = (await text({
-    message: "What is your project name?",
-    placeholder: "my-cli",
-  })) as string;
-
-  const targetDir = (await text({
-    message: "Where should the project be created?",
-    placeholder: "./my-cli",
-    initialValue: `./${projectName}`,
-  })) as string;
-
-  const description = (await text({
-    message: "What does this project do?",
-    placeholder: "A CLI tool that does amazing things",
-  })) as string;
-
-  outro("Project details collected!");
-
-  return { projectName, targetDir, description };
-}

package/src/functions/scaffold-core.ts

@@ -1,18 +0,0 @@
-import { join } from "node:path";
-import { readdir } from "node:fs/promises";
-import { fileURLToPath } from "node:url";
-import { writeFileTuple } from "../core/helpers/file-utils";
-
-const currentDir = join(fileURLToPath(import.meta.url), "../..");
-const sourceCoreDir = join(currentDir, "src", "core");
-
-export async function scaffoldCore(targetDir: string) {
-  const files = await readdir(sourceCoreDir);
-
-  for (const file of files) {
-    if (file.endsWith(".ts")) {
-      const content = await Bun.file(join(sourceCoreDir, file)).text();
-      await writeFileTuple([targetDir, `src/core/${file}`, content]);
-    }
-  }
-}

package/src/functions/scaffold-project.ts

@@ -1,19 +0,0 @@
-import { type ProjectPrompts } from "./prompt-project";
-import { writeFileTuple } from "../core/helpers/file-utils";
-import {
-  commands_init,
-  config_init,
-  package_init,
-  readme_init,
-  tsconfig_init,
-} from "../data/init";
-
-export async function scaffoldProject(prompts: ProjectPrompts) {
-  const { projectName, targetDir, description } = prompts;
-
-  await writeFileTuple([targetDir, "src/commands/index.ts", commands_init()]);
-  await writeFileTuple([targetDir, "src/config.ts", config_init(description)]);
-  await writeFileTuple([targetDir, "package.json", package_init(projectName)]);
-  await writeFileTuple([targetDir, "README.md", readme_init(projectName)]);
-  await writeFileTuple([targetDir, "tsconfig.json", tsconfig_init()]);
-}

package/src/index.ts

@@ -1,10 +0,0 @@
-#!/usr/bin/env bun
-import { runCLI } from "./core/cli";
-import { registerCommands } from "./commands";
-
-async function main() {
-  registerCommands();
-  runCLI();
-}
-
-main();