create-arkstack 0.5.5 → 0.6.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-arkstack",
   "type": "module",
-  "version": "0.5.5",
+  "version": "0.6.0",
   "description": "Create new Arkstack framework applications on Express or H3 runtime drivers",
   "homepage": "https://arkstack.toneflix.net",
   "repository": {

package/bin/run.mjs

@@ -1,486 +0,0 @@
-#!/usr/bin/env node
-import { AbortPromptError, ExitPromptError } from "@inquirer/core";
-import path, { basename, join, relative } from "node:path";
-import { copyFile, readFile, readdir, rename, rm, unlink, writeFile } from "node:fs/promises";
-import { Logger, Resolver } from "@h3ravel/shared";
-import { Str } from "@h3ravel/support";
-import { chdir } from "node:process";
-import { detectPackageManager } from "@antfu/install-pkg";
-import { downloadTemplate } from "giget";
-import { existsSync } from "node:fs";
-import { spawnSync } from "node:child_process";
-import { Command, Kernel } from "@h3ravel/musket";
-import inquirer from "inquirer";
-//#region src/utils.ts
-/**
-* Removes all files in dirPath except the one specified by keepFileName
-*
-* @param dirPath
-* @param keepFileName
-*/
-async function cleanDirectoryExcept(dirPath, keepFileName) {
-	const files = await readdir(dirPath);
-	for (const file of files) {
-		if (file === keepFileName) continue;
-		await rm(path.join(dirPath, file), {
-			recursive: true,
-			force: true
-		});
-	}
-}
-/**
-* Moves all files from dirPath to parent directory and removes dirPath
-*
-* @param dirPath
-* @param parent
-*/
-async function hoistDirectoryContents(parent, dirPath) {
-	const source = path.isAbsolute(dirPath) ? dirPath : path.join(process.cwd(), dirPath);
-	const targetParent = path.isAbsolute(parent) ? parent : path.join(process.cwd(), parent);
-	if (!source.startsWith(targetParent)) throw new Error("Source must be inside the parent directory");
-	const entries = await readdir(source);
-	for (const entry of entries) await rename(path.join(source, entry), path.join(targetParent, entry));
-	await rm(source, { recursive: true });
-}
-//#endregion
-//#region src/templates.ts
-/**
-* List of first party templates
-*/
-const templates = [{
-	name: "Express",
-	alias: "express",
-	hint: "Arkstack application running on Express",
-	source: "github:arkstack-hq/arkstack"
-}, {
-	name: "H3",
-	alias: "h3",
-	hint: "Arkstack application running on H3",
-	source: "github:arkstack-hq/arkstack"
-}];
-const projectScopes = [{
-	name: "Lean",
-	hint: "A minimal Arkstack application running on {template}",
-	lean: true
-}, {
-	name: "Full",
-	hint: "Full Arkstack experience on {template}",
-	lean: false
-}];
-//#endregion
-//#region src/data.ts
-const filesToRemove = [
-	"src/app",
-	"src/app/http/controllers",
-	"src/app/http/resources",
-	"src/models",
-	"src/app/models",
-	"database",
-	"src/routes/api.ts",
-	"src/database",
-	"src/core/database.ts",
-	"src/config/filesystem.ts",
-	"src/config/notifications.ts",
-	"prisma",
-	"prisma.config.ts",
-	"arkorm.config.ts",
-	"arkormx.config.ts",
-	"arkorm.config.js",
-	"arkormx.config.js",
-	"arkorm.config.mjs",
-	"arkormx.config.mjs"
-];
-const fullDependencies = [
-	"@types/pg",
-	"@prisma/client",
-	"@prisma/adapter-pg",
-	"@arkstack/auth",
-	"@arkstack/database",
-	"@arkstack/filesystem",
-	"@arkstack/notifications",
-	"pg",
-	"kysely",
-	"prisma",
-	"arkormx"
-];
-const leanDependencies = [];
-const depsList = {
-	"@arkstack/auth": "^0.5.5",
-	"@arkstack/common": "^0.5.5",
-	"@arkstack/console": "^0.5.5",
-	"@arkstack/contract": "^0.5.5",
-	"@arkstack/database": "^0.5.5",
-	"@arkstack/driver-express": "^0.5.5",
-	"@arkstack/driver-h3": "^0.5.5",
-	"@arkstack/filesystem": "^0.5.5",
-	"@arkstack/http": "^0.5.5",
-	"@arkstack/view": "^0.5.5",
-	"@arkstack/notifications": "^0.5.5"
-};
-const environment = {
-	min: ["APP_URL", "APP_PORT"],
-	max: [
-		"JWT_SECRET",
-		"JWT_EXPIRES_IN",
-		"DATABASE_URL"
-	]
-};
-//#endregion
-//#region src/actions.ts
-var actions_default = class {
-	location;
-	appName;
-	description;
-	skipInstallation;
-	packageJson = {};
-	pkgPath;
-	constructor(location, appName, description) {
-		this.location = location;
-		this.appName = appName;
-		this.description = description;
-		if (!this.location) this.location = join(process.cwd(), ".temp");
-	}
-	async pm() {
-		return await detectPackageManager() ?? "npm";
-	}
-	async runCmd(npx = false) {
-		if (npx) return "npx";
-		const pm = await this.pm();
-		return pm === "npm" ? "npm run" : pm;
-	}
-	async download(template, install = false, auth, overwrite = false) {
-		if (this.location?.includes(".temp") || overwrite && existsSync(this.location)) await rm(this.location, {
-			force: true,
-			recursive: true
-		});
-		else if (existsSync(this.location)) {
-			if ((await readdir(this.location ?? "./"))?.length > 0) {
-				console.log("\n");
-				Logger.parse([
-					[" ERROR ", "bgRed"],
-					[this.location, ["gray", "italic"]],
-					["is not empty.", "white"]
-				], " ");
-				console.log("");
-				process.exit(0);
-			}
-		}
-		this.skipInstallation = !install;
-		this.removeLockFile();
-		return await downloadTemplate(template, {
-			dir: this.location,
-			auth,
-			provider: "github",
-			registry: await this.pm(),
-			forceClean: false
-		});
-	}
-	/**
-	* Installs the project dependencies using the detected package manager. 
-	* If a specific package name is provided, it will install that package 
-	* instead of all dependencies.
-	* 
-	* @param name 
-	* @param args 
-	* @returns 
-	*/
-	async installPackage(name, args = []) {
-		const bcmd = await Resolver.getPakageInstallCommand() + (name ? ` ${name}` : "");
-		const cmd = bcmd.split(" ")[0];
-		if (bcmd.includes(" ")) args.unshift(...bcmd.split(" ").slice(1));
-		const child = spawnSync(cmd, args, {
-			cwd: process.cwd(),
-			stdio: "ignore"
-		});
-		if (child.error) return child.status;
-		return 0;
-	}
-	async complete(install = false) {
-		let installed = false;
-		if (install) installed = await this.installPackage() === 0;
-		console.log("");
-		const installPath = "./" + relative(process.cwd(), this.location);
-		try {
-			chdir(path.join(process.cwd(), installPath));
-		} catch {}
-		Logger.success("Your Arkstack project has been created successfully");
-		Logger.parse([
-			["cd", "cyan"],
-			[installPath, "yellow"],
-			installPath === process.cwd() ? ["✔", "green"] : ["", "green"]
-		], " ");
-		if (!installed) Logger.parse([[await Resolver.getPakageInstallCommand(), "cyan"]]);
-		Logger.parse([[await this.runCmd(), "cyan"], ["dev", "yellow"]], " ");
-		Logger.parse([["Open", "cyan"], ["http://localhost:3000", "yellow"]]);
-		console.log("");
-		Logger.parse([["Have any questions", "white"]]);
-		Logger.parse([["Join our Discord server -", "white"], ["https://discord.gg/jmQybxKQ7R", "yellow"]]);
-		Logger.parse([["Checkout our other projects -", "white"], ["https://toneflix.net/open-source", "yellow"]]);
-	}
-	async removeLockFile() {
-		if (!this.skipInstallation) return;
-		await Promise.allSettled([
-			unlink(join(this.location, "package-lock.json")),
-			unlink(join(this.location, "yarn.lock")),
-			unlink(join(this.location, "pnpm-lock.yaml"))
-		]);
-	}
-	async getBanner() {
-		return await readFile(join(process.cwd(), "./logo.txt"), "utf-8");
-	}
-	async createDotEnv(scope = "max") {
-		const envPath = join(this.location, ".env");
-		const exampleEnvPath = join(this.location, ".env.example");
-		const allowed = scope === "max" ? [...environment.max, ...environment.min] : environment.min;
-		if (existsSync(exampleEnvPath)) {
-			let lines = (await readFile(exampleEnvPath, "utf-8")).split(/\r?\n/);
-			for (let i = 0; i < lines.length; i++) {
-				const line = lines[i];
-				const key = line.split("=").at(0) ?? "";
-				if (key === "" || line === "" || line.trim().startsWith("#")) continue;
-				if (!allowed.includes(key)) delete lines[i];
-			}
-			lines = lines.slice(lines.findIndex((v) => v), lines.findLastIndex((v) => v) + 1);
-			await writeFile(exampleEnvPath, lines.join("\n"));
-			await copyFile(exampleEnvPath, envPath);
-		}
-	}
-	async saveProfile() {
-		if (this.pkgPath) await writeFile(this.pkgPath, JSON.stringify(this.packageJson, null, 2));
-	}
-	async makeProfile() {
-		const pkgPath = join(this.location, "package.json");
-		if (existsSync(pkgPath)) {
-			this.pkgPath = pkgPath;
-			this.packageJson = await readFile(pkgPath, "utf-8").then(JSON.parse);
-			for (const [name] of Object.entries(this.packageJson.dependencies)) if (name.includes("@arkstack/")) delete this.packageJson.dependencies[name];
-			const deps = Object.fromEntries([...Object.entries(depsList), ...Object.entries(this.packageJson.dependencies)]);
-			this.packageJson.dependencies = deps;
-		} else this.packageJson = {};
-	}
-	async makeFullProfile(_kit) {
-		await this.makeProfile();
-		if (!this.pkgPath) return;
-		for (const dep of leanDependencies) {
-			delete this.packageJson.dependencies?.[dep];
-			delete this.packageJson.devDependencies?.[dep];
-		}
-	}
-	async makeLeanProfile(_kit) {
-		await Promise.allSettled(filesToRemove.map((file) => rm(join(this.location, file), {
-			force: true,
-			recursive: true
-		})));
-		await this.makeProfile();
-		if (this.pkgPath) for (const dep of fullDependencies) {
-			delete this.packageJson.dependencies?.[dep];
-			delete this.packageJson.devDependencies?.[dep];
-		}
-		for (const file of [
-			"src/core/app.ts",
-			"src/core/router.ts",
-			"src/core/bootstrap.ts"
-		]) {
-			const filePath = join(this.location, file);
-			if (!existsSync(filePath)) continue;
-			let content = await readFile(filePath, "utf-8");
-			content = content.replace("import { ValidatorDBDriver } from '@arkstack/database'\n", "").replace("import { ModelNotFoundException } from 'arkormx'\n", "").replace("import { prisma } from 'src/core/database'\n", "").replace("import { Prisma } from '@prisma/client'\n", "").replace("Validator.useDatabase(new ValidatorDBDriver())", "").replace("  async shutdown () {\n    await prisma.$disconnect()\n    process.exit(0)\n  }", "  async shutdown () {\n    process.exit(0)\n  }").replace(" * Shuts down the application by disconnecting from the database and exiting the process.", " * Shuts down the application and exits the process.").replace(/\n\s*if \((?:err|cause) instanceof Prisma\.PrismaClientKnownRequestError && (?:err|cause)\.code === "P2025"\) \{\n\s*error\.code = 404\n\s*error\.message = `\$\{(?:err|cause)\.meta\?\.modelName\} not found!`\n\s*\}\n/g, "\n").replace(/\n\s*if \((?:err|cause) instanceof ModelNotFoundException\) \{\n\s*error\.code = 404\n\s*error\.message = `\$\{(?:err|cause)\.getModelName\(\)\} not found!`\n\s*\}\n/g, "\n").replace(/if \(!\(err instanceof ValidationException\) &&\n\s*!\(err instanceof ModelNotFoundException\)\) {/g, "if (!(err instanceof ValidationException)) {").replace(/\s*\/\/ Register API routes\s*await ClearRouter\.group\('\/api', async \(\) => \{\s*await importFile\(join\(process\.cwd\(\), 'src\/routes\/api\.ts'\)\)\s*\}\)\s*/g, "\n\n    ");
-			await writeFile(filePath, content, "utf-8");
-		}
-	}
-	async cleanup(kit) {
-		const pkg = this.packageJson;
-		delete pkg.packageManager;
-		delete pkg.scripts.predev;
-		delete pkg.scripts.prebuild;
-		delete pkg.scripts.precmd;
-		delete pkg.scripts.cmd;
-		pkg.scripts.dev = "ark dev";
-		pkg.scripts.build = "ark build";
-		pkg.scripts.postinstall = "prepare";
-		pkg.name = Str.slugify(this.appName ?? basename(this.location).replace(".", ""), "-");
-		if (this.description) pkg.description = this.description;
-		for (const name of Object.keys(pkg.dependencies)) if (name.includes("@arkstack/driver") && name !== "@arkstack/driver-" + kit) delete pkg.dependencies[name];
-		this.packageJson = pkg;
-		await Promise.allSettled([
-			this.saveProfile(),
-			this.removeLockFile(),
-			rm(join(this.location, "pnpm-workspace.yaml"), { force: true }),
-			rm(join(this.location, ".github"), {
-				force: true,
-				recursive: true
-			})
-		]);
-	}
-};
-//#endregion
-//#region src/logo.ts
-const altLogo = String.raw`%c
-   _            __ _             _    
-  /_\  _ __ ___/ _\ |_ __ _  ___| | __
- //_\\| '__/ __\ \| __/ _\ |/ __| |/ /
-/  _  \ | | (___\ \ || (_| | (__|   < 
-\_/ \_/_|  \___\__/\__\__,_|\___|_|\_\
-                                      
-`;
-//#endregion
-//#region src/Commands/CreateArkstackCommand.ts
-var CreateArkstackCommand = class extends Command {
-	signature = `create-arkstack
-        {location?: The location where this project should be created relative to the current dir.}
-        {--n|name?: The name of your project.}
-        {--i|install: Install node_modules right away}
-        {--t|token?: Kit repo authentication token.}
-        {--d|desc?: Project Description.}
-        {--k|kit?: Runtime template.}
-        {--p|pre: Download prerelease version if available.}
-        {--o|overwrite: Overwrite the installation directory if it is not empty.}
-    `;
-	description = "Display a personalized greeting.";
-	async handle() {
-		const options = this.options();
-		const pathName = this.argument("location");
-		console.log(altLogo, "font-family: monospace");
-		let { template } = await inquirer.prompt([{
-			type: "list",
-			name: "template",
-			message: "Choose Runtime:",
-			choices: templates.map((e) => ({
-				name: `${e.name} - ${e.hint}`,
-				value: e.alias,
-				disabled: !e.source ? "(Unavailable at this time)" : false
-			})),
-			default: "full",
-			when: () => !options.kit
-		}]).catch((err) => {
-			if (err instanceof AbortPromptError || err instanceof ExitPromptError) {
-				this.info("Thanks for trying out Arkstack.");
-				process.exit(0);
-			}
-			return err;
-		});
-		let { lean, appName, description } = await inquirer.prompt([
-			{
-				type: "list",
-				name: "lean",
-				message: "Project Scope:",
-				choices: projectScopes.map((e) => ({
-					name: `${e.name} - ${e.hint.replace("{template}", Str.title(template))}`,
-					value: e.lean
-				})),
-				default: "full",
-				when: () => !options.kit
-			},
-			{
-				type: "input",
-				name: "appName",
-				message: "What is the name of your project:",
-				default: `arkstack-${template}`,
-				when: () => !options.name
-			},
-			{
-				type: "input",
-				name: "description",
-				message: "Project Description:",
-				default: `Simple ${Str.of(template).ucfirst()}.js project created with Arkstack.`,
-				when: () => !options.desc
-			}
-		]).catch((err) => {
-			if (err instanceof AbortPromptError || err instanceof ExitPromptError) {
-				this.info("Thanks for trying out Arkstack.");
-				process.exit(0);
-			}
-			return err;
-		});
-		let { location } = await inquirer.prompt([{
-			type: "input",
-			name: "location",
-			message: "Installation location relative to the current dir:",
-			default: Str.slugify(options.name ?? appName ?? basename(process.cwd()), "-"),
-			when: () => !pathName
-		}]).catch((err) => {
-			if (err instanceof AbortPromptError || err instanceof ExitPromptError) {
-				this.info("Thanks for trying out Arkstack.");
-				process.exit(0);
-			}
-			return err;
-		});
-		/**
-		* Find selected template kit
-		*/
-		const kit = templates.find((e) => e.alias === template);
-		kit.lean = lean ?? false;
-		let { install, token, pre } = await inquirer.prompt([
-			{
-				type: "confirm",
-				name: "pre",
-				message: `An alpha version of the ${kit.name.replace(/\s*template$/i, "").trim()} template is available. Would you like to use it instead?`,
-				default: false,
-				when: () => kit.prereleaseSource && !options.pre
-			},
-			{
-				type: "input",
-				name: "token",
-				message: "Authentication token:",
-				when: () => options.kit && !options.token
-			},
-			{
-				type: "confirm",
-				name: "install",
-				message: "Would you like to install node_modules right away?:",
-				default: true,
-				when: () => !options.install
-			}
-		]).catch((err) => {
-			if (err instanceof AbortPromptError || err instanceof ExitPromptError) {
-				this.info("Thanks for trying out Arkstack.");
-				process.exit(0);
-			}
-			return err;
-		});
-		pre = options.pre ?? pre;
-		token = options.token ?? token;
-		appName = options.name ?? appName;
-		install = options.install ?? install;
-		template = options.kit ?? template;
-		location = pathName ?? location;
-		description = options.description ?? description;
-		/**
-		* Validate selected kit
-		*/
-		if (kit && !kit.source) {
-			this.error(`ERROR: The ${kit.name} kit is not currently available`);
-			process.exit(1);
-		}
-		const kitName = (kit.baseAlias ?? kit.alias).replace(/-lean$/i, "");
-		const source = pre && kit.prereleaseSource ? kit.prereleaseSource : kit.source;
-		const actions = new actions_default(join(process.cwd(), location), appName, description);
-		const spinner = this.spinner("Loading Template...").start();
-		const result = await actions.download(source, install, token, options.overwrite);
-		if (result.dir && kitName) {
-			await cleanDirectoryExcept(result.dir, kitName);
-			await hoistDirectoryContents(result.dir, join(result.dir, kitName));
-		}
-		if (kit.lean) {
-			spinner.info(Logger.parse([["Applying lean profile...", "green"]], "", false)).start();
-			await actions.makeLeanProfile(kitName);
-		} else await actions.makeFullProfile(kitName);
-		spinner.info(Logger.parse([["Cleaning Up...", "green"]], "", false)).start();
-		await actions.cleanup(kitName);
-		spinner.info(Logger.parse([["Initializing Project...", "green"]], "", false)).start();
-		await actions.createDotEnv(kit.lean ? "min" : "max");
-		await actions.complete(install);
-		spinner.succeed(Logger.parse([["Project initialization complete!", "green"]], "", false));
-	}
-};
-//#endregion
-//#region src/run.ts
-var Application = class {};
-Kernel.init(new Application(), {
-	rootCommand: CreateArkstackCommand,
-	exceptionHandler: (e) => {
-		Logger.error(`ERROR: ${e.message}`);
-	}
-});
-//#endregion
-export {};