tools-template-cli 0.1.0 → 0.1.2

package/README.md

@@ -1,17 +1,167 @@
 # tmp-cli
 
-A small TypeScript CLI for cloning the starter templates in this repository into a fresh project directory.
+`tmp-cli` is a small CLI for cloning starter templates from this repository into a new project directory.
 
-## Install
-
-### From npm
+Install globally with your preferred package manager:
 
 ```bash
 npm install -g tools-template-cli
+pnpm add -g tools-template-cli
+bun add -g tools-template-cli
+```
+
+Then run:
+
+```bash
+tmp-cli list
+```
+
+Fastest way to create a project:
+
+```bash
+tmp-cli create yuyi
+```
+
+That will show a template list, let you choose one, and then generate the project in `./yuyi`.
+
+## What it does
+
+- Lists the templates bundled with the package
+- Copies a template into a new target directory
+- Skips `.git`, `node_modules`, `.DS_Store`, and common build output directories
+- Renames basic config values for JavaScript templates
+- Optionally runs your package manager install step
+- Optionally initializes a fresh git repository
+
+## Available templates
+
+Current templates:
+
+- `supabase-expo-app`
+- `supabase-user-management`
+- `supabase-swiftui-app`
+- `supabase_flutter_app`
+
+Check the latest packaged list at any time:
+
+```bash
 tmp-cli list
 ```
 
-### Locally while developing
+## Usage
+
+Pass the target directory first and choose the template with a flag:
+
+```bash
+tmp-cli create ./apps/mobile --template supabase-expo-app
+tmp-cli create ./apps/admin --template supabase-user-management
+```
+
+Or pass only the target directory and choose from the interactive template list:
+
+```bash
+tmp-cli create yuyi
+tmp-cli create ./apps/admin
+```
+
+Initialize git in the generated project:
+
+```bash
+tmp-cli create admin-app --template supabase-user-management --git
+```
+
+Install dependencies immediately after generation:
+
+```bash
+tmp-cli create my-mobile-app --template supabase-expo-app --install
+tmp-cli create admin-app --template supabase-user-management --install
+```
+
+Override the display name for supported templates:
+
+```bash
+tmp-cli create my-mobile-app --template supabase-expo-app --name "My Mobile App"
+```
+
+Overwrite an existing non-empty target directory:
+
+```bash
+tmp-cli create my-mobile-app --template supabase-expo-app --force
+```
+
+## Commands
+
+### `tmp-cli list`
+
+Prints all packaged templates.
+
+```bash
+tmp-cli list
+```
+
+### `tmp-cli create`
+
+Create a project from one of the packaged templates.
+
+```bash
+tmp-cli create yuyi
+tmp-cli create <target-directory> --template <template> [options]
+```
+
+Options:
+
+- `-t, --template <name>`: template name to copy
+- `-n, --name <display-name>`: display name for supported templates
+- `-p, --package-manager <tool>`: `npm`, `pnpm`, `yarn`, or `bun`
+- `-f, --force`: overwrite a non-empty target directory
+- `-i, --install`: run install after copy
+- `-g, --git`: run `git init` in the generated directory
+- `-h, --help`: show help
+- `-v, --version`: show the CLI version
+
+## Examples
+
+Expo app:
+
+```bash
+tmp-cli create my-mobile-app --template supabase-expo-app --name "My Mobile App"
+cd my-mobile-app
+npm install
+```
+
+Next.js app:
+
+```bash
+tmp-cli create admin-app --template supabase-user-management --git
+cd admin-app
+npm install
+```
+
+Nested target directory:
+
+```bash
+tmp-cli create ./apps/admin --template supabase-user-management --install
+```
+
+## Template behavior
+
+These templates get automatic config renaming:
+
+- `supabase-expo-app`
+- `supabase-user-management`
+
+That includes updates in files such as:
+
+- `package.json`
+- `package-lock.json`
+- `app.json`
+- `README.md`
+
+The SwiftUI and Flutter templates are copied as-is apart from the target directory name and README reference.
+
+## Local development
+
+Use the local source directly while working on the CLI:
 
 ```bash
 npm install
@@ -20,35 +170,26 @@ npm link
 tmp-cli list
 ```
 
-## Commands
+Or run the compiled output directly:
 
 ```bash
-npm install
 npm run build
-node dist/index.js list
-node dist/index.js create supabase-expo-app my-mobile-app
-node dist/index.js create ./apps/admin --template supabase-user-management --git
+node dist/index.js help
 ```
 
-## What it does
+## Install notes
 
-- Lists the templates that live in this repository
-- Copies a template into a new target directory
-- Skips `.git`, `node_modules`, `.DS_Store`, and common build output directories
-- Renames basic config values for the JavaScript templates
-- Optionally runs `npm install`, `pnpm install`, `yarn install`, or `bun install`
-- Optionally initializes a fresh git repository in the generated project
+- npm global install: `npm install -g tools-template-cli`
+- pnpm global install: `pnpm add -g tools-template-cli`
+- bun global install: `bun add -g tools-template-cli`
 
-## Global usage
+After installation, the command is always:
 
 ```bash
-tmp-cli list
-tmp-cli create supabase-expo-app my-mobile-app
-tmp-cli create ./apps/admin --template supabase-user-management --git
+tmp-cli
 ```
 
-## Notes
+## Package
 
-- `supabase-expo-app` and `supabase-user-management` get automatic config renaming in `package.json`, `package-lock.json`, `app.json`, and `README.md`
-- The SwiftUI and Flutter templates are copied as-is, apart from the target directory name
-- Use `node dist/index.js help` to see all options
+- npm package: `tools-template-cli`
+- global command: `tmp-cli`

package/dist/index.js

@@ -3,9 +3,10 @@ import { chmodSync, copyFileSync, existsSync, mkdirSync, readFileSync, readdirSy
 import { spawnSync } from "node:child_process";
 import { basename, dirname, join, resolve } from "node:path";
 import process from "node:process";
+import { createInterface } from "node:readline/promises";
 import { fileURLToPath } from "node:url";
 import { getTemplate, templates } from "./templates.js";
-const CLI_VERSION = "0.1.0";
+const CLI_VERSION = "0.1.2";
 const ROOT_DIR = resolve(dirname(fileURLToPath(import.meta.url)), "..");
 const SKIP_NAMES = new Set([
     ".git",
@@ -23,7 +24,7 @@ const VALID_PACKAGE_MANAGERS = new Set([
     "yarn",
     "bun"
 ]);
-function main() {
+async function main() {
     try {
         const parsed = parseArgs(process.argv.slice(2));
         if (hasBooleanFlag(parsed.flags, "help") || parsed.command === "help") {
@@ -39,7 +40,7 @@ function main() {
                 listTemplates();
                 return;
             case "create":
-                createProject(resolveCreateOptions(parsed));
+                createProject(await resolveCreateOptions(parsed));
                 return;
             default:
                 printHelp(`Unknown command: ${parsed.command}`);
@@ -107,19 +108,21 @@ function parseArgs(argv) {
     }
     return { command, positionals, flags };
 }
-function resolveCreateOptions(parsed) {
+async function resolveCreateOptions(parsed) {
     const templateFlag = getStringFlag(parsed.flags, "template");
     const force = hasBooleanFlag(parsed.flags, "force");
     const install = hasBooleanFlag(parsed.flags, "install");
     const git = hasBooleanFlag(parsed.flags, "git");
     let templateId = templateFlag;
-    let targetDirArg;
-    if (templateId) {
-        targetDirArg = parsed.positionals[0] ?? templateId;
+    let targetDirArg = parsed.positionals[0];
+    if (parsed.positionals.length === 0) {
+        throw new Error("Missing target directory for create command.");
+    }
+    if (parsed.positionals.length > 1) {
+        throw new Error("Use `tmp-cli create <target-directory>` or `tmp-cli create <target-directory> --template <name>`.");
     }
-    else {
-        templateId = parsed.positionals[0];
-        targetDirArg = parsed.positionals[1] ?? parsed.positionals[0];
+    if (!templateId) {
+        templateId = await promptForTemplateSelection();
     }
     if (!templateId) {
         throw new Error("Missing template name. Run `tmp-cli list` to see available templates.");
@@ -128,9 +131,6 @@ function resolveCreateOptions(parsed) {
     if (!template) {
         throw new Error(`Unknown template "${templateId}". Run \`tmp-cli list\` to see available templates.`);
     }
-    if (!targetDirArg) {
-        throw new Error("Missing target directory for create command.");
-    }
     const targetDir = resolve(process.cwd(), targetDirArg);
     const directoryName = basename(targetDir);
     const displayName = getStringFlag(parsed.flags, "name") ?? directoryName;
@@ -153,6 +153,35 @@ function resolveCreateOptions(parsed) {
         packageManager: packageManagerValue
     };
 }
+async function promptForTemplateSelection() {
+    if (!process.stdin.isTTY || !process.stdout.isTTY) {
+        throw new Error("Template selection needs an interactive terminal. Pass --template <name> when running non-interactively.");
+    }
+    console.log("Choose a template:\n");
+    for (const [index, template] of templates.entries()) {
+        console.log(`  ${index + 1}. ${template.id} - ${template.description} (${template.platform})`);
+    }
+    console.log("");
+    const readline = createInterface({
+        input: process.stdin,
+        output: process.stdout
+    });
+    try {
+        while (true) {
+            const answer = (await readline.question(`Template number [1-${templates.length}]: `)).trim();
+            const selectedIndex = Number.parseInt(answer, 10);
+            if (Number.isInteger(selectedIndex) &&
+                selectedIndex >= 1 &&
+                selectedIndex <= templates.length) {
+                return templates[selectedIndex - 1].id;
+            }
+            console.log(`Please enter a number between 1 and ${templates.length}.`);
+        }
+    }
+    finally {
+        readline.close();
+    }
+}
 function createProject(options) {
     const templateSourceDir = resolve(ROOT_DIR, options.template.path);
     if (!existsSync(templateSourceDir)) {
@@ -357,7 +386,7 @@ function printHelp(errorMessage) {
 
 Usage:
   tmp-cli list
-  tmp-cli create <template> [target-directory] [options]
+  tmp-cli create <target-directory>
   tmp-cli create <target-directory> --template <template> [options]
 
 Options:
@@ -371,10 +400,10 @@ Options:
   -v, --version                 Show CLI version
 
 Examples:
+  tmp-cli create yuyi
   tmp-cli list
-  tmp-cli create supabase-expo-app my-mobile-app
   tmp-cli create ./apps/admin --template supabase-user-management --git
-  tmp-cli create supabase-expo-app my-mobile-app --name "My Mobile App" --install
+  tmp-cli create my-mobile-app --template supabase-expo-app --name "My Mobile App" --install
 `);
 }
-main();
+void main();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tools-template-cli",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "CLI for cloning starter templates from this repository into fresh project directories",
   "license": "MIT",
   "type": "module",