create-template-project 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025- Dieter Oberkofler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,97 @@
+# create-template-project
+
+[![NPM Version](https://img.shields.io/npm/v/create-template-project.svg)](https://www.npmjs.com/package/create-template-project)
+[![NPM Downloads](https://img.shields.io/npm/dm/create-template-project.svg)](https://www.npmjs.com/package/create-template-project)
+[![Node.js CI](https://github.com/doberkofler/create-template-project/actions/workflows/node.js.yml/badge.svg)](https://github.com/doberkofler/create-template-project/actions/workflows/node.js.yml)
+[![Coverage Status](https://coveralls.io/repos/github/doberkofler/create-template-project/badge.svg?branch=master)](https://coveralls.io/github/doberkofler/create-template-project?branch=master)
+
+An ultra-modular, type-safe Node.js CLI tool used to scaffold new project templates (CLI, Webpage, Webapp, Fullstack) with best-practice configurations pre-installed.
+
+## Features
+
+- **Modern Tech Stack:** All templates come with `commitlint`, `husky`, `vitest`, `oxlint`, `prettier`, and `typescript` (strict mode).
+- **Interactive CLI:** Prompts you for project details if CLI arguments are missing, using `@clack/prompts`.
+- **Update Mode:** Detects existing projects and offers a safe update path using `git merge-file`.
+- **No-Build Option:** Supports creating simple projects without a build step (strips `tsdown`).
+- **GitHub Integration:** Automatically initializes a Git repository and can create a GitHub repository using the `gh` CLI.
+- **CI Ready:** Generates GitHub Actions workflows for automated testing and linting.
+
+## Installation
+
+```bash
+npm install -g create-template-project
+```
+
+Or run directly using npx:
+
+```bash
+npx create-template-project
+```
+
+## Usage
+
+### Interactive Mode
+
+To start the interactive wizard, use the `interactive` command:
+
+```bash
+create-template-project interactive
+```
+
+Running the tool without any command will display the help message.
+
+### CLI Commands
+
+You can skip the wizard by using the `create` or `update` commands with the appropriate options.
+
+#### Create a new project
+
+```bash
+create-template-project create --template cli --name my-cool-tool --github
+```
+
+#### Update an existing project
+
+```bash
+create-template-project update --template cli --name existing-project
+```
+
+#### Global Options:
+
+- `-h, --help`: Show help
+- `-V, --version`: Show version
+
+#### Command Options (create/update):
+
+- `-t, --template <type>`: Template type (`cli`, `webpage`, `webapp`, `fullstack`)
+- `-n, --name <name>`: Project name
+- `--github`: Create GitHub project (requires `gh` CLI authenticated)
+- `-d, --directory <path>`: Output directory (defaults to `.`)
+- `--overwrite`: Overwrite existing directory by removing it first (create & update)
+- `--no-build`: Create a project without a build step (not allowed for `webapp`)
+- `--silent`: Reduce console output (useful for CI and scripts)
+
+## Project Templates
+
+### 🟢 CLI
+A clean Node.js CLI environment featuring `commander` and `cli-progress`. Supports optional `tsdown` bundling.
+
+### 🔵 Webpage
+Standalone web page setup for modern browsers. Can be used with or without a build step.
+
+### 🟡 Webapp
+Classic web application structure with a `frontend/` and a `backend/` Express server. Built with TypeScript.
+
+### ⚛️ Fullstack
+A full-stack monorepo featuring:
+- **Client**: React with MUI (including Icons) and TypeScript.
+- **Server**: Express.js backend.
+- **E2E**: Playwright for end-to-end testing.
+
+## Contributing
+
+Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this project.
+
+## License
+
+MIT © [Dieter Oberkofler](https://github.com/doberkofler)

package/dist/cli.mjs

@@ -0,0 +1,272 @@
+import { ProjectOptionsSchema } from "./types.mjs";
+import { Command } from "commander";
+import * as p from "@clack/prompts";
+import path from "node:path";
+import fs from "node:fs/promises";
+import debugLib from "debug";
+//#region src/cli.ts
+const pathExists = (p) => fs.access(p).then(() => true).catch(() => false);
+const debug = debugLib("create-template-project:cli");
+const parseArgs = async () => {
+	debug("Parsing CLI arguments: %O", process.argv);
+	const program = new Command();
+	if (process.env.NODE_ENV === "test") program.configureOutput({
+		writeOut: () => {},
+		writeErr: () => {}
+	});
+	program.name("create-template-project").exitOverride().description("Scaffold a new project template").version("0.1.0").option("--debug", "Enable debug output").on("option:debug", () => {
+		debugLib.enable("create-template-project:*");
+	}).addHelpText("after", `
+Templates:
+  cli         - Node.js CLI application with commander and cli-progress.
+  webpage     - Standalone web page (modern HTML/JS).
+  webapp      - Web application with TypeScript and an Express backend.
+  fullstack   - Full-stack monorepo with Express server and React/MUI client.
+`);
+	let commandResult;
+	program.command("create").description("Create a new project from a template").option("-t, --template <type>", "Template type (cli, webpage, webapp, fullstack)").option("-n, --name <name>", "Project name").option("-p, --package-manager <pm>", "Package manager (npm, pnpm, yarn)", "npm").option("--create-github-repository", "Create GitHub project").option("-d, --directory <path>", "Output directory", ".").option("--overwrite", "Overwrite existing directory by removing it first", false).option("--skip-build", "Skip build tooling (disables bundling and uses raw source files)", false).option("--install-dependencies", "Install dependencies after scaffolding", false).option("--build", "Run the CI script (lint, build, test) after scaffolding", false).option("--dev", "Run the dev server after scaffolding", false).option("--open", "Open the browser after scaffolding", false).option("--silent", "Reduce console output", false).action((opts) => {
+		debug("Executing \"create\" command with options: %O", opts);
+		if (opts.template === "webapp" && opts.skipBuild) {
+			p.log.error("The --skip-build option is not allowed for the \"webapp\" template.");
+			process.exit(1);
+		}
+		commandResult = {
+			...opts,
+			update: false,
+			template: opts.template,
+			projectName: opts.name,
+			packageManager: opts.packageManager,
+			directory: path.resolve(opts.directory),
+			createGithubRepository: !!opts.createGithubRepository,
+			overwrite: !!opts.overwrite,
+			silent: !!opts.silent
+		};
+		debug("Processed \"create\" options: %O", commandResult);
+	});
+	program.command("update").description("Update an existing project from its template").option("-t, --template <type>", "Template type (cli, webpage, webapp, fullstack)").option("-n, --name <name>", "Project name").option("-p, --package-manager <pm>", "Package manager (npm, pnpm, yarn)", "npm").option("--create-github-repository", "Create GitHub project").option("-d, --directory <path>", "Output directory", ".").option("--overwrite", "Overwrite existing directory by removing it first", false).option("--skip-build", "Skip build tooling (disables bundling and uses raw source files)", false).option("--install-dependencies", "Install dependencies after scaffolding", false).option("--build", "Run the CI script (lint, build, test) after updating", false).option("--dev", "Run the dev server after scaffolding", false).option("--open", "Open the browser after scaffolding", false).option("--silent", "Reduce console output", false).action((opts) => {
+		debug("Executing \"update\" command with options: %O", opts);
+		if (opts.template === "webapp" && opts.skipBuild) {
+			p.log.error("The --skip-build option is not allowed for the \"webapp\" template.");
+			process.exit(1);
+		}
+		commandResult = {
+			...opts,
+			update: true,
+			template: opts.template,
+			projectName: opts.name,
+			packageManager: opts.packageManager,
+			directory: path.resolve(opts.directory),
+			createGithubRepository: !!opts.createGithubRepository,
+			overwrite: !!opts.overwrite,
+			silent: !!opts.silent
+		};
+		debug("Processed \"update\" options: %O", commandResult);
+	});
+	program.command("interactive").description("Start interactive project configuration").action(async () => {
+		debug("Starting interactive configuration");
+		const projectName = await p.text({
+			message: "Project name:",
+			placeholder: "my-app",
+			defaultValue: "my-app",
+			validate: (value) => value && value.length > 0 ? void 0 : "Project name is required"
+		});
+		if (p.isCancel(projectName)) {
+			p.cancel("Operation cancelled.");
+			process.exit(0);
+		}
+		const directory = await p.text({
+			message: "Target directory:",
+			initialValue: "."
+		});
+		if (p.isCancel(directory)) {
+			p.cancel("Operation cancelled.");
+			process.exit(0);
+		}
+		const projectDir = path.resolve(directory, projectName);
+		const exists = await pathExists(projectDir);
+		const pkgPath = path.join(projectDir, "package.json");
+		const pkgExists = await pathExists(pkgPath);
+		let existingConfig = {};
+		if (pkgExists) try {
+			existingConfig = JSON.parse(await fs.readFile(pkgPath, "utf8"))["create-template-project"] || {};
+			debug("Found existing project config: %O", existingConfig);
+		} catch (e) {
+			debug("Failed to read existing package.json: %O", e);
+		}
+		let update = false;
+		let overwrite = false;
+		if (exists) {
+			const action = await p.select({
+				message: `Directory "${projectDir}" already exists. What would you like to do?`,
+				options: [
+					{
+						label: "Run an update",
+						value: "update"
+					},
+					{
+						label: "Overwrite existing directory by removing it first",
+						value: "overwrite"
+					},
+					{
+						label: "Cancel",
+						value: "cancel"
+					}
+				]
+			});
+			if (p.isCancel(action) || action === "cancel") {
+				p.cancel("Operation cancelled.");
+				process.exit(0);
+			}
+			if (action === "update") update = true;
+			else if (action === "overwrite") overwrite = true;
+		}
+		let template = existingConfig.template;
+		if (!update || !template) {
+			template = await p.select({
+				message: "Select project template:",
+				initialValue: template || "cli",
+				options: [
+					{
+						label: "CLI Application (Node.js)",
+						value: "cli"
+					},
+					{
+						label: "Webpage (Standalone)",
+						value: "webpage"
+					},
+					{
+						label: "Webapp (Express Backend)",
+						value: "webapp"
+					},
+					{
+						label: "Full-stack (Express + React/MUI Monorepo)",
+						value: "fullstack"
+					}
+				]
+			});
+			if (p.isCancel(template)) {
+				p.cancel("Operation cancelled.");
+				process.exit(0);
+			}
+		} else p.log.info(`Using existing template type: ${template}`);
+		let packageManager = "npm";
+		if (!update) {
+			packageManager = await p.select({
+				message: "Select package manager:",
+				initialValue: "npm",
+				options: [
+					{
+						label: "npm",
+						value: "npm"
+					},
+					{
+						label: "pnpm",
+						value: "pnpm"
+					},
+					{
+						label: "yarn",
+						value: "yarn"
+					}
+				]
+			});
+			if (p.isCancel(packageManager)) {
+				p.cancel("Operation cancelled.");
+				process.exit(0);
+			}
+		}
+		let skipBuild = false;
+		if (template !== "webapp") {
+			const res = await p.confirm({
+				message: "Should we use build tooling? (Enables bundling using tsdown, and uses raw dist/ instead of src/)",
+				initialValue: true
+			});
+			if (p.isCancel(res)) {
+				p.cancel("Operation cancelled.");
+				process.exit(0);
+			}
+			skipBuild = !res;
+		}
+		const installDependenciesRes = await p.confirm({
+			message: "Should we install dependencies?",
+			initialValue: true
+		});
+		if (p.isCancel(installDependenciesRes)) {
+			p.cancel("Operation cancelled.");
+			process.exit(0);
+		}
+		const installDependencies = installDependenciesRes;
+		let build = false;
+		if (installDependencies) {
+			const res = await p.confirm({
+				message: "Should we run the CI script (lint, build, test)?",
+				initialValue: true
+			});
+			if (p.isCancel(res)) {
+				p.cancel("Operation cancelled.");
+				process.exit(0);
+			}
+			build = res;
+		}
+		const createGithubRepositoryRes = await p.confirm({
+			message: "Should we create a GitHub repository?",
+			initialValue: false
+		});
+		if (p.isCancel(createGithubRepositoryRes)) {
+			p.cancel("Operation cancelled.");
+			process.exit(0);
+		}
+		commandResult = {
+			template,
+			projectName,
+			packageManager,
+			createGithubRepository: createGithubRepositoryRes,
+			directory: path.resolve(directory),
+			update,
+			overwrite,
+			skipBuild,
+			installDependencies,
+			build,
+			dev: false,
+			open: false,
+			silent: false
+		};
+	});
+	if (process.argv.length <= 2) {
+		program.outputHelp();
+		process.exit(0);
+	}
+	try {
+		await program.parseAsync(process.argv);
+	} catch (e) {
+		if (e.code === "commander.helpDisplayed" || e.code === "commander.version" || e.code === "PROCESS_EXIT_0") process.exit(0);
+		if (e.code === "PROCESS_EXIT_1") process.exit(1);
+		p.cancel(e.message);
+		process.exit(1);
+	}
+	if (!commandResult) {
+		debug("No command result found");
+		p.cancel("Unknown command or missing options.");
+		process.exit(1);
+	}
+	debug("Validating command result with Zod");
+	const validationResult = ProjectOptionsSchema.safeParse(commandResult);
+	if (!validationResult.success) {
+		const errors = validationResult.error.issues.map((e) => `${e.path.join(".")}: ${e.message}`).join(", ");
+		p.cancel(`Invalid options: ${errors}`);
+		process.exit(1);
+	}
+	commandResult = validationResult.data;
+	const projectDir = path.resolve(commandResult.directory, commandResult.projectName);
+	if (await pathExists(projectDir) && !commandResult.update && !commandResult.overwrite) {
+		p.cancel(`Directory "${projectDir}" already exists. Use --overwrite to overwrite or "update" command.`);
+		process.exit(1);
+	}
+	if (commandResult.open) {
+		commandResult.dev = true;
+		commandResult.installDependencies = true;
+	}
+	if (commandResult.dev || commandResult.build) commandResult.installDependencies = true;
+	return commandResult;
+};
+//#endregion
+export { parseArgs };

package/dist/config/dependencies.json

@@ -0,0 +1,156 @@
+{
+	"dependencies": {
+		"debug": {
+			"version": "^4.4.3",
+			"description": "A tiny JavaScript debugging utility modelled after Node.js core debugging technique."
+		},
+		"@commitlint/cli": {
+			"version": "^20.4.4",
+			"description": "Lint commit messages to ensure they follow conventional commits."
+		},
+		"@commitlint/config-conventional": {
+			"version": "^20.4.4",
+			"description": "Shareable commitlint config enforcing conventional commits."
+		},
+		"@types/debug": {
+			"version": "^4.1.12",
+			"description": "TypeScript definitions for debug."
+		},
+		"@types/node": {
+			"version": "^25.5.0",
+			"description": "TypeScript definitions for Node.js."
+		},
+		"@vitest/coverage-v8": {
+			"version": "^4.1.0",
+			"description": "V8 coverage provider for Vitest."
+		},
+		"conventional-changelog": {
+			"version": "^7.2.0",
+			"description": "Generate a changelog from git metadata."
+		},
+		"husky": {
+			"version": "^9.1.7",
+			"description": "Modern native git hooks made easy."
+		},
+		"oxlint": {
+			"version": "^1.55.0",
+			"description": "A JavaScript linter written in Rust."
+		},
+		"oxlint-tsgolint": {
+			"version": "^0.16.0",
+			"description": "TypeScript-specific rules for oxlint."
+		},
+		"prettier": {
+			"version": "^3.8.1",
+			"description": "An opinionated code formatter."
+		},
+		"typescript": {
+			"version": "^5.9.3",
+			"description": "A superset of JavaScript that compiles to clean JavaScript output."
+		},
+		"vitest": {
+			"version": "^4.1.0",
+			"description": "A Vite-native unit test framework."
+		},
+		"commander": {
+			"version": "^14.0.3",
+			"description": "The complete solution for node.js command-line interfaces."
+		},
+		"cli-progress": {
+			"version": "^3.12.0",
+			"description": "Easy to use progress-bar for command-line/terminal applications."
+		},
+		"@types/cli-progress": {
+			"version": "^3.11.6",
+			"description": "TypeScript definitions for cli-progress."
+		},
+		"tsdown": {
+			"version": "^0.21.2",
+			"description": "A zero-config bundler for TypeScript."
+		},
+		"express": {
+			"version": "^5.2.1",
+			"description": "Fast, unopinionated, minimalist web framework for Node.js."
+		},
+		"@types/express": {
+			"version": "^5.0.6",
+			"description": "TypeScript definitions for Express."
+		},
+		"react": {
+			"version": "^19.2.4",
+			"description": "A JavaScript library for building user interfaces."
+		},
+		"react-dom": {
+			"version": "^19.2.4",
+			"description": "React package for working with the DOM."
+		},
+		"@mui/material": {
+			"version": "^7.3.9",
+			"description": "Material UI components."
+		},
+		"@mui/icons-material": {
+			"version": "^7.3.9",
+			"description": "Material Design icons distributed as SVG React components."
+		},
+		"@emotion/react": {
+			"version": "^11.14.0",
+			"description": "CSS-in-JS library designed for high performance."
+		},
+		"@emotion/styled": {
+			"version": "^11.14.1",
+			"description": "Styled components for Emotion."
+		},
+		"@types/react": {
+			"version": "^19.2.14",
+			"description": "TypeScript definitions for React."
+		},
+		"@types/react-dom": {
+			"version": "^19.2.3",
+			"description": "TypeScript definitions for React DOM."
+		},
+		"@playwright/test": {
+			"version": "^1.58.2",
+			"description": "End-to-end testing framework."
+		},
+		"@trpc/server": {
+			"version": "^11.12.0",
+			"description": "tRPC server library."
+		},
+		"@trpc/client": {
+			"version": "^11.12.0",
+			"description": "tRPC client library."
+		},
+		"@trpc/react-query": {
+			"version": "^11.12.0",
+			"description": "tRPC integration for React Query."
+		},
+		"@tanstack/react-query": {
+			"version": "^5.90.21",
+			"description": "Powerful asynchronous state management for TS/JS."
+		},
+		"zod": {
+			"version": "^4.3.6",
+			"description": "TypeScript-first schema validation with static type inference."
+		},
+		"tinyexec": {
+			"version": "^1.0.4",
+			"description": "A minimal library for executing processes in Node (pinned to 1.0.2 due to broken 1.0.3 release)."
+		},
+		"react-router-dom": {
+			"version": "^7.13.1",
+			"description": "Declarative routing for React web applications."
+		},
+		"cors": {
+			"version": "^2.8.6",
+			"description": "Node.js CORS middleware."
+		},
+		"@types/cors": {
+			"version": "^2.8.19",
+			"description": "TypeScript definitions for cors."
+		},
+		"eslint-plugin-regexp": {
+			"version": "^3.1.0",
+			"description": "ESLint plugin for finding regexp mistakes and style guide violations."
+		}
+	}
+}