@mbsi/mkcmd 0.2.2 → 0.2.3

package/CHANGELOG.md

@@ -7,40 +7,61 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.3] - 2025-12-30
+
+### Fixed
+
+I forgot to push some files from 0.2.2 to github and then forgot to make sure they existed before publishing to npm.
+Oh well.
 
 ## [0.2.2] - 2025-12-30
 
 ### Added
+
 - `src/core/helpers/stringifier.ts` to codegen before building
 - `prebuild` script to dynamically update the code located in data/core at build time.
 - `src/data/core.ts` is generated / regenerated at before building for use in dist
+- `README.md` - Rewrote to make sense for display on NPM store as NPX package
 
 ### Fixed
+
 - `src/functions/scaffold-core.ts` doesn't try to pull data that doesn't exist anymore :^)
+- `src/core/cli.ts` doesn't try to read the version from the user's computer anymore (hopefully)
+
+### Moved
+
+- Original `README.md` moved to `src/README.md` - it's for devs, anyways.
 
 ## [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
@@ -48,6 +69,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [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)

package/README.md

@@ -1,111 +1,133 @@
 # mkcmd
 
-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.
+A CLI tool for scaffolding new CLI projects with sensible defaults. Create command-line tools with TypeScript, Bun runtime, and a solid core structure out of the box.
 
 ## Features
 
-- **Interactive Project Setup** - Prompts for project name, target directory, and description using `@clack/prompts`
-- **Full CLI Scaffold** - Generates a complete CLI project structure with configuration files
-- **Core Utilities Included** - Ships with `file-builder.ts` and `file-utils.ts` for dynamic code generation
-- **TypeScript & Bun** - Pre-configured TypeScript settings and Bun runtime support
-- **Dynamic Core Copying** - Automatically copies all core CLI files to your new project
+- **Interactive Setup** - Prompts for project name, location, and description
+- **Complete CLI Framework** - Generates a working CLI with command registration, logging, and helpers
+- **TypeScript + Bun** - Pre-configured with TypeScript and Bun runtime support
+- **Core Utilities** - Includes `FileBuilder` for dynamic code generation and file utilities
+- **Extensible** - Easy to add your own commands
+
+> [!WARNING]
+> While you can *run* the program in without Bun, the source code itself **depends on Bun** for development and building.
+
+## Run remotely
+
+```bash
+npx @mbsi/mkcmd init
+# or
+bun @mbsi/mkcmd init
+```
+
+## Installation
+
+```bash
+npm install -g @mbsi/mkcmd
+# or
+bun install -g @mbsi/mkcmd
+```
+
+## Quick Start
+
+```bash
+mkcmd init
+```
+
+The `init` command will prompt you for:
+- Project name
+- Target directory (defaults to `./<project-name>`)
+- Project description
 
 ## What Gets Scaffolding
 
-When you run `mkcmd init`, it creates:
+After running `mkcmd init`, you'll have a complete CLI project:
 
 ```
-project-name/
+my-cli/
 ├── src/
 │   ├── core/
-│   │   ├── cli.ts          # CLI framework with command registration
-│   │   ├── log.ts          # Logging helpers (single/multi info/warn/err, title)
-│   │   ├── file-builder.ts # Indentation-aware file builder
-│   │   └── file-utils.ts   # Path caching and file writing utilities
+│   │   ├── cli.ts              # CLI framework with command registration
+│   │   ├── log.ts              # Logging helpers (single/multi info/warn/err, title)
+│   │   └── helpers/
+│   │       ├── file-builder.ts # Indentation-aware file builder
+│   │       └── file-utils.ts   # Path and file writing utilities
 │   ├── commands/
-│   │   └── index.ts        # Command registration hook
-│   └── config.ts           # Project configuration
+│   │   └── index.ts            # Command registration hook
+│   └── config.ts               # Project configuration
 ├── package.json
 ├── tsconfig.json
 └── README.md
 ```
 
-## Installation
+## Usage
 
-### For Development
+### Running Your New CLI
 
 ```bash
+cd my-cli
 bun install
+bun run src/index.ts --help
 ```
 
-### From npm (after publishing)
-
-```bash
-npm install -g mkcmd
-# or
-bun install -g mkcmd
-```
-
-## Usage
-
-### Development
+### Adding Commands
 
-```bash
-# Show help
-bun run src/index.ts --help
+Commands are registered in `src/commands/index.ts`. Here's the pattern:
 
-# Show version
-bun run src/index.ts --version
+```typescript
+import { registerCommand } from "../core/cli";
 
-# Initialize a new CLI project
-bun run src/index.ts init
+registerCommand({
+  name: "greet",
+  description: "Say hello",
+  instructions: "Pass a name to greet",
+  run: async (args: string[]) => {
+    const name = args[0] || "world";
+    console.log(`Hello, ${name}!`);
+  }
+});
 ```
 
-### Using Built Distribution
+Then run:
 
 ```bash
-# Build for Bun runtime
-bun run build
-bun dist/index.js --help
-
-# Build standalone executable
-bun run build:exe
-./dist/mkcmd --help
+bun run src/index.ts greet
+bun run src/index.ts greet Alice
 ```
 
-### After Installation (from npm)
+### Using the File Builder
 
-```bash
-mkcmd --help
-mkcmd init
-```
+The included `FileBuilder` helps generate code files dynamically:
 
-The `init` command will prompt you for:
-- Project name
-- Target directory (defaults to `./<project-name>`)
-- Project description
+```typescript
+import { FileBuilder } from "./core/helpers/file-builder";
+
+const fb = new FileBuilder();
+fb.addLine("export function hello() {");
+fb.addLine('  console.log("Hello!");', 1);
+fb.addLine("}");
+const code = fb.build();
+```
 
-## Building for npm
+## CLI Flags
 
-To build and prepare for publishing:
+After installation, `mkcmd` supports:
 
 ```bash
-# Build the bundled JS file (requires Bun runtime)
-bun run build
+mkcmd --help      # Show help
+mkcmd --version   # Show version
+```
 
-# Build standalone executable (works without Bun)
-bun run build:exe
+## Requirements
 
-# Publish to npm
-npm publish
-```
+- Bun runtime (for running the generated project)
+- Node.js 16+ (for installation via npm)
 
-**Note**: The default build (`bun run build`) produces a bundled JS file that requires Bun to run. The standalone executable (`bun run build:exe`) works independently but is platform-specific.
+## License
 
-## Development
+See LICENSE file for details.
 
-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, [CHANGELOG.md](./CHANGELOG.md) for version history.
+**Version:** See `npm info @mbsi/mkcmd version`, `npx @mbsi/mkcmd --version`, or run `mkcmd --version` after installation.

package/dist/index.js

@@ -1631,7 +1631,8 @@ async function runCLI(argv = Bun.argv.slice(2)) {
     return;
   }
   if (["-v", "--version"].includes(name)) {
-    const pkgText = await Bun.file(join2(process.cwd(), "package.json")).text();
+    const pkgPath = join2(import.meta.dir, "..", "package.json");
+    const pkgText = await Bun.file(pkgPath).text();
     const pkg = JSON.parse(pkgText);
     log_default.multi.info([
       {
@@ -2307,7 +2308,8 @@ var src_core_cli_init = () => {
   fb.addLine("  }");
   fb.addLine("");
   fb.addLine('  if (["-v", "--version"].includes(name)) {');
-  fb.addLine('    const pkgText = await Bun.file(join(process.cwd(), "package.json")).text();');
+  fb.addLine('    const pkgPath = join(import.meta.dir, "..", "package.json");');
+  fb.addLine("    const pkgText = await Bun.file(pkgPath).text();");
   fb.addLine("    const pkg = JSON.parse(pkgText);");
   fb.addLine("    log.multi.info([");
   fb.addLine("      {");

package/package.json

@@ -1,25 +1,25 @@
 {
-  "name": "@mbsi/mkcmd",
-  "version": "0.2.2",
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "type": "module",
-  "bin": {
-    "mkcmd": "./dist/index.js"
-  },
-  "scripts": {
-    "prebuild": "bun run src/core/helpers/stringifier.ts",
-    "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.3",
+	"main": "./dist/index.js",
+	"module": "./dist/index.js",
+	"type": "module",
+	"bin": {
+		"mkcmd": "./dist/index.js"
+	},
+	"scripts": {
+		"prebuild": "bun run src/core/helpers/stringifier.ts",
+		"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"
+	}
 }