@freecodecamp/universe-cli 0.12.0 → 0.13.0

package/dist/index.cjs

@@ -9609,7 +9609,7 @@ var require_public_api = /* @__PURE__ */ __commonJSMin(((exports) => {
 	exports.stringify = stringify;
 }));
 //#endregion
-//#region src/commands/create/layer-composition/build-compose-dev-yaml.ts
+//#region src/commands/create/layer-composition/build-compose-yaml.ts
 var import_dist = (/* @__PURE__ */ __commonJSMin(((exports) => {
 	var composer = require_composer();
 	var Document = require_Document();
@@ -9656,7 +9656,7 @@ var import_dist = (/* @__PURE__ */ __commonJSMin(((exports) => {
 	exports.visit = visit.visit;
 	exports.visitAsync = visit.visitAsync;
 })))();
-const buildComposeDevYaml = (framework, packageManager) => {
+const buildComposeYaml = (framework, packageManager) => {
 	const { port } = framework;
 	const portMapping = `${port}:${port}`;
 	const syncEntries = framework.watchSync.map((entry) => ({
@@ -9677,6 +9677,28 @@ const buildComposeDevYaml = (framework, packageManager) => {
 		ports: [portMapping]
 	} } });
 };
+const buildDevcontainerComposeYaml = () => `services:
+  devcontainer:
+    build:
+      context: ..
+      target: dev
+    command: ["sleep", "infinity"]
+    volumes:
+    # First mount the source
+      - type: bind
+        source: ..
+        target: /app
+        consistency: cached
+    # Then mount an anonymous volume to hold node_modules. Otherwise the bind mount causes the host node_modules to be used.
+      - type: volume
+        target: /app/node_modules
+`;
+const buildDevcontainerJson = () => `{
+  "$schema": "https://raw.githubusercontent.com/devcontainers/spec/main/schemas/devContainer.schema.json",
+  "dockerComposeFile": ["./docker-compose.yml"],
+  "service": "devcontainer",
+  "workspaceFolder": "/app"
+}`;
 //#endregion
 //#region src/output/exit-codes.ts
 /**
@@ -9804,7 +9826,7 @@ const composeLayerFiles = (layers, pmPreinstall) => {
 //#region src/commands/create/layer-composition/layer-template-renderer.ts
 var LayerTemplateRenderer = class {
 	render(template, context) {
-		return template.replaceAll("{{name}}", context.name).replaceAll("{{port}}", String(context.port)).replaceAll("{{runtime}}", context.runtime).replaceAll("{{framework}}", context.framework);
+		return template.replaceAll("{{name}}", context.name).replaceAll("{{port}}", String(context.port)).replaceAll("{{runtime}}", context.runtime).replaceAll("{{framework}}", context.framework).replaceAll("{{pmVersion}}", context.pmVersion);
 	}
 };
 //#endregion
@@ -9864,23 +9886,24 @@ const buildDockerfileData = (runtime, framework, packageManager) => {
 const renderDockerfile = (data) => `FROM ${data.baseImage} AS base\nWORKDIR /app\n\nFROM base AS package-manager\n${data.pmInstall} \n\nFROM package-manager AS dev\n${data.devInstall}\n${data.devCopySource}\nCMD ${JSON.stringify(data.devCmd)}\n`;
 const resolveWithLayers = (input, layers, labels) => {
 	const resolvedLayers = resolveOrderedLayers(input, layers);
-	const composedFiles = composeLayerFiles(resolvedLayers, input.packageManager === void 0 ? void 0 : layers["package-managers"][input.packageManager]?.preinstall);
+	const pmData = input.packageManager !== void 0 ? layers["package-managers"][input.packageManager] : void 0;
+	const composedFiles = composeLayerFiles(resolvedLayers, pmData?.preinstall);
 	const renderer = new LayerTemplateRenderer();
 	const frameworkData = layers.frameworks?.[input.framework];
 	const context = {
 		framework: getLabel(labels, "framework", input.framework),
 		name: input.name,
+		pmVersion: pmData?.pmVersion ?? "",
 		port: frameworkData?.port ?? 0,
 		runtime: getLabel(labels, "runtime", input.runtime)
 	};
 	const renderedFiles = Object.fromEntries(Object.entries(composedFiles).map(([filePath, content]) => [filePath, renderer.render(content, context)]));
 	const runtimeData = layers.runtime?.[input.runtime];
-	if (runtimeData !== void 0 && frameworkData !== void 0 && input.packageManager !== void 0) {
-		const pmData = layers["package-managers"][input.packageManager];
-		if (pmData !== void 0) {
-			renderedFiles["Dockerfile"] = renderDockerfile(buildDockerfileData(runtimeData, frameworkData, pmData));
-			renderedFiles["docker-compose.dev.yml"] = buildComposeDevYaml(frameworkData, pmData);
-		}
+	if (runtimeData !== void 0 && frameworkData !== void 0 && pmData !== void 0) {
+		renderedFiles["Dockerfile"] = renderer.render(renderDockerfile(buildDockerfileData(runtimeData, frameworkData, pmData)), context);
+		renderedFiles["compose.yaml"] = renderer.render(buildComposeYaml(frameworkData, pmData), context);
+		renderedFiles[".devcontainer/docker-compose.yml"] = buildDevcontainerComposeYaml();
+		renderedFiles[".devcontainer/devcontainer.json"] = buildDevcontainerJson();
 	}
 	return {
 		files: renderedFiles,
@@ -9905,10 +9928,10 @@ var PackageManagerService = class {
 		this.adapters = adapters;
 	}
 	async specifyDeps(options) {
-		const { manager, projectDirectory } = options;
+		const { manager, pmVersion, projectDirectory } = options;
 		const adapter = this.adapters[manager];
 		if (!adapter) throw new Error(`Unknown package manager: ${manager}`);
-		await adapter.specifyDeps(projectDirectory);
+		await adapter.specifyDeps(projectDirectory, pmVersion);
 	}
 };
 //#endregion
@@ -9933,7 +9956,7 @@ Please check that the output format of list() has not changed, and that extractV
 	if (devDependencies !== void 0) pinned.devDependencies = pin(devDependencies);
 	return pinned;
 };
-const createPackageSpecifier = (config) => ({ async specifyDeps(projectDirectory) {
+const createPackageSpecifier = (config) => ({ async run(projectDirectory) {
 	const { lockfileName, runner, deleteBeforeFirstInstall } = config;
 	const lockfilePath = (0, node_path.join)(projectDirectory, lockfileName);
 	if (deleteBeforeFirstInstall) try {
@@ -9965,11 +9988,11 @@ const createPackageSpecifier = (config) => ({ async specifyDeps(projectDirectory
 } });
 //#endregion
 //#region src/commands/create/package-manager/docker-runner.ts
-const execFileAsync$2 = (0, node_util.promisify)(node_child_process.execFile);
+const execFileAsync$3 = (0, node_util.promisify)(node_child_process.execFile);
 const IMAGE_TAG = "universe-runner:pm";
 const ensureImageBuilt = async (cwd) => {
 	const dockerfile = (0, node_path.resolve)(cwd, "Dockerfile");
-	await execFileAsync$2("docker", [
+	await execFileAsync$3("docker", [
 		"build",
 		"--file",
 		dockerfile,
@@ -9982,7 +10005,7 @@ const ensureImageBuilt = async (cwd) => {
 };
 const runCmdForFiles = async (cwd, cmd, inputs, outputs) => {
 	await ensureImageBuilt(cwd);
-	const { stdout: idRaw } = await execFileAsync$2("docker", [
+	const { stdout: idRaw } = await execFileAsync$3("docker", [
 		"create",
 		"-w",
 		"/app",
@@ -9991,28 +10014,28 @@ const runCmdForFiles = async (cwd, cmd, inputs, outputs) => {
 	], { encoding: "utf8" });
 	const id = idRaw.trim();
 	try {
-		await Promise.all(inputs.map((file) => execFileAsync$2("docker", [
+		await Promise.all(inputs.map((file) => execFileAsync$3("docker", [
 			"cp",
 			`${cwd}/${file}`,
 			`${id}:/app/${file}`
 		], { encoding: "utf8" })));
-		await execFileAsync$2("docker", [
+		await execFileAsync$3("docker", [
 			"start",
 			"-a",
 			id
 		], { encoding: "utf8" });
-		await Promise.all(outputs.map((file) => execFileAsync$2("docker", [
+		await Promise.all(outputs.map((file) => execFileAsync$3("docker", [
 			"cp",
 			`${id}:/app/${file}`,
 			`${cwd}/${file}`
 		], { encoding: "utf8" })));
 	} finally {
-		await execFileAsync$2("docker", ["rm", id], { encoding: "utf8" });
+		await execFileAsync$3("docker", ["rm", id], { encoding: "utf8" });
 	}
 };
 const runCmdForStdout = async (cwd, cmd, inputs) => {
 	await ensureImageBuilt(cwd);
-	const { stdout: idRaw } = await execFileAsync$2("docker", [
+	const { stdout: idRaw } = await execFileAsync$3("docker", [
 		"create",
 		"-w",
 		"/app",
@@ -10021,19 +10044,19 @@ const runCmdForStdout = async (cwd, cmd, inputs) => {
 	], { encoding: "utf8" });
 	const id = idRaw.trim();
 	try {
-		await Promise.all(inputs.map((file) => execFileAsync$2("docker", [
+		await Promise.all(inputs.map((file) => execFileAsync$3("docker", [
 			"cp",
 			`${cwd}/${file}`,
 			`${id}:/app/${file}`
 		], { encoding: "utf8" })));
-		const { stdout } = await execFileAsync$2("docker", [
+		const { stdout } = await execFileAsync$3("docker", [
 			"start",
 			"-a",
 			id
 		], { encoding: "utf8" });
 		return stdout;
 	} finally {
-		await execFileAsync$2("docker", ["rm", id], { encoding: "utf8" });
+		await execFileAsync$3("docker", ["rm", id], { encoding: "utf8" });
 	}
 };
 //#endregion
@@ -10067,17 +10090,17 @@ const extractVersions$1 = (listOutput) => {
 	return versions;
 };
 var BunPackageManager = class {
-	impl;
+	runner;
 	constructor(runner = bunRunner) {
-		this.impl = createPackageSpecifier({
+		this.runner = runner;
+	}
+	specifyDeps(projectDirectory, _pmVersion) {
+		return createPackageSpecifier({
 			deleteBeforeFirstInstall: true,
 			extractVersions: extractVersions$1,
 			lockfileName: LOCKFILE$1,
-			runner
-		});
-	}
-	specifyDeps(projectDirectory) {
-		return this.impl.specifyDeps(projectDirectory);
+			runner: this.runner
+		}).run(projectDirectory);
 	}
 };
 //#endregion
@@ -10088,13 +10111,13 @@ var BunPackageManager = class {
 */
 const LOCKFILE = "pnpm-lock.yaml";
 const MANIFESTS = ["package.json", "pnpm-workspace.yaml"];
-const defaultPnpmRunner = {
+const defaultRunnerFactory = (pmVersion) => ({
 	async installLockfileOnly(cwd) {
 		await runCmdForFiles(cwd, [
-			"pnpm",
-			"install",
-			"--lockfile-only"
-		], MANIFESTS, [LOCKFILE]);
+			"sh",
+			"-c",
+			`corepack use pnpm@${pmVersion} && pnpm install --lockfile-only`
+		], MANIFESTS, [LOCKFILE, "package.json"]);
 	},
 	list(cwd) {
 		return runCmdForStdout(cwd, [
@@ -10105,7 +10128,7 @@ const defaultPnpmRunner = {
 			"--lockfile-only"
 		], [...MANIFESTS, LOCKFILE]);
 	}
-};
+});
 const extractVersions = (listOutput) => {
 	const root = JSON.parse(listOutput)[0] ?? {};
 	const versions = {};
@@ -10114,17 +10137,17 @@ const extractVersions = (listOutput) => {
 	return versions;
 };
 var PnpmPackageManager = class {
-	impl;
-	constructor(runner = defaultPnpmRunner) {
-		this.impl = createPackageSpecifier({
+	createRunner;
+	constructor(createRunner = defaultRunnerFactory) {
+		this.createRunner = createRunner;
+	}
+	async specifyDeps(projectDirectory, pmVersion) {
+		await createPackageSpecifier({
 			deleteBeforeFirstInstall: false,
 			extractVersions,
 			lockfileName: LOCKFILE,
-			runner
-		});
-	}
-	specifyDeps(projectDirectory) {
-		return this.impl.specifyDeps(projectDirectory);
+			runner: this.createRunner(pmVersion)
+		}).run(projectDirectory);
 	}
 };
 //#endregion
@@ -11372,13 +11395,13 @@ var ClackPrompt = class {
 };
 //#endregion
 //#region src/commands/create/io/git-repo-initialiser.ts
-const execFileAsync$1 = (0, node_util.promisify)(node_child_process.execFile);
-const defaultRun = async (command, args, cwd) => {
-	await execFileAsync$1(command, args, { cwd });
+const execFileAsync$2 = (0, node_util.promisify)(node_child_process.execFile);
+const defaultRun$1 = async (command, args, cwd) => {
+	await execFileAsync$2(command, args, { cwd });
 };
 var GitRepoInitialiser = class {
 	run;
-	constructor(run = defaultRun) {
+	constructor(run = defaultRun$1) {
 		this.run = run;
 	}
 	async initialise(projectDirectory) {
@@ -11396,6 +11419,41 @@ var GitRepoInitialiser = class {
 	}
 };
 //#endregion
+//#region src/commands/create/io/npx-skill-installer.ts
+const execFileAsync$1 = (0, node_util.promisify)(node_child_process.execFile);
+const defaultRun = async (command, args, cwd) => {
+	await execFileAsync$1(command, args, { cwd });
+};
+var NpxSkillInstaller = class {
+	run;
+	constructor(run = defaultRun) {
+		this.run = run;
+	}
+	async installSkills(skills, projectDirectory) {
+		const skillsByRepo = /* @__PURE__ */ new Map();
+		for (const { repo, skill } of skills) {
+			const existing = skillsByRepo.get(repo);
+			if (existing === void 0) skillsByRepo.set(repo, [skill]);
+			else existing.push(skill);
+		}
+		try {
+			for (const [repo, repoSkills] of skillsByRepo) {
+				const args = [
+					"--yes",
+					"skills",
+					"add",
+					"--yes",
+					repo,
+					...repoSkills.flatMap((skill) => ["--skill", skill])
+				];
+				await this.run("npx", args, projectDirectory);
+			}
+		} catch (error) {
+			throw new ConfigError(error.message);
+		}
+	}
+};
+//#endregion
 //#region node_modules/.pnpm/zod@4.4.3/node_modules/zod/v4/core/core.js
 var _a$1;
 function $constructor(name, initializer, params) {
@@ -15712,6 +15770,15 @@ const silentLogger = {
 	warn: () => {}
 };
 //#endregion
+//#region src/output/spinner.ts
+const clackSpinner = () => vt();
+const silentSpinner = () => ({
+	error: () => {},
+	start: () => {},
+	message: () => {},
+	stop: () => {}
+});
+//#endregion
 //#region src/output/envelope.ts
 function buildEnvelope(command, success, data) {
 	return {
@@ -15866,6 +15933,7 @@ const PackageManagerSchema = record(literal(["bun", "pnpm"]), strictObject({
 	lockfile: string(),
 	manifests: array(string()),
 	pmInstall: string(),
+	pmVersion: string().regex(/^\d+\.\d+\.\d+$/, "pmVersion must be a semver version (major.minor.patch), e.g. 1.2.3"),
 	preinstall: string().optional()
 }));
 const ServiceSchema = record(literal([
@@ -15877,6 +15945,10 @@ const FrameworkSchema = record(string(), strictObject({
 	devCopySource: string(),
 	files: record(string(), string()),
 	port: number(),
+	skills: array(strictObject({
+		repo: string(),
+		skill: string()
+	})).optional(),
 	watchSync: array(strictObject({
 		path: string(),
 		target: string()
@@ -15893,7 +15965,7 @@ const LabelsSchema = record(union([
 ]), record(string(), string()));
 //#endregion
 //#region src/commands/create/layer-composition/assets.json
-var templateVersion = "0.2.0";
+var templateVersion = "0.4.1";
 var templateUrl = "https://github.com/freeCodeCamp-Universe/templates/releases/download/app-templates-v{{version}}/app-templates-{{version}}.tar.gz";
 //#endregion
 //#region src/commands/create/layer-composition/assets.ts
@@ -16225,6 +16297,9 @@ const create$1 = async (options, deps = {}) => {
 	});
 	const platformManifestGenerator = deps.platformManifestGenerator ?? new PlatformManifestService();
 	const repoInitialiser = deps.repoInitialiser ?? new GitRepoInitialiser();
+	const skillInstaller = deps.skillInstaller ?? new NpxSkillInstaller();
+	const isTTY = process.stdin.isTTY;
+	const spinner = deps.spinner ?? (options.json || !isTTY ? silentSpinner() : clackSpinner());
 	try {
 		const templatesDir = process.env["UNIVERSE_TEMPLATES_DIR"];
 		if (!(templatesDir && templatesDir.length > 0)) {
@@ -16267,20 +16342,38 @@ const create$1 = async (options, deps = {}) => {
 				...pm !== void 0 ? { packageManager: pm } : {}
 			};
 		}
+		spinner.start("Preparing your project");
 		const validatedInput = validator.validateCreateInput(selections);
+		spinner.message("Composing project layers");
 		const resolvedLayers = await layerResolver.resolveLayers(validatedInput);
 		const targetDirectory = `${cwd}/${validatedInput.name}`;
 		const projectFiles = {
 			...resolvedLayers.files,
 			"platform.yaml": platformManifestGenerator.generatePlatformManifest(validatedInput)
 		};
+		spinner.message("Writing project files");
 		await filesystemWriter.writeProject(targetDirectory, projectFiles);
 		const manager = validatedInput.packageManager;
-		if (manager !== void 0) await packageManager.specifyDeps({
-			manager,
-			projectDirectory: targetDirectory
-		});
+		if (manager !== void 0) {
+			spinner.message(`Pinning dependencies with ${manager}`);
+			await packageManager.specifyDeps({
+				manager,
+				pmVersion: registry["package-managers"][manager]?.pmVersion ?? "",
+				projectDirectory: targetDirectory
+			});
+		}
+		const skills = registry.frameworks[validatedInput.framework]?.skills;
+		if (skills && skills.length > 0) {
+			spinner.message("Installing skills");
+			try {
+				await skillInstaller.installSkills(skills, targetDirectory);
+			} catch (err) {
+				logger.error(err instanceof Error ? err.message : String(err));
+			}
+		}
+		spinner.message("Initialising git repository");
 		await repoInitialiser.initialise(targetDirectory);
+		spinner.stop("Project scaffolded");
 		if (options.json) {
 			emitJson(buildEnvelope("create", true, {
 				path: targetDirectory,
@@ -16293,9 +16386,11 @@ const create$1 = async (options, deps = {}) => {
 			}));
 			return;
 		}
-		if (interactive) logger.success(`Scaffolded project at ${targetDirectory}`);
-		else logger.info(`Scaffolded project '${validatedInput.name}' at ${targetDirectory}`);
+		const startInstruction = `Project scaffolded. cd into ${validatedInput.name} and run \`docker compose up --watch\` to start the project`;
+		if (interactive) logger.success(startInstruction);
+		else logger.info(startInstruction);
 	} catch (err) {
+		spinner.error("Create failed");
 		const code = err instanceof CliError ? err.exitCode : 10;
 		const message = err instanceof Error ? err.message : String(err);
 		outputError({
@@ -16735,6 +16830,10 @@ const auditRowArraySchema = array(object({
 	requestId: string().optional(),
 	detail: record(string(), unknown()).optional()
 }));
+const deploySummaryArraySchema = array(object({
+	deployId: string(),
+	actor: string().optional()
+}));
 const repoName = string().regex(/^[a-zA-Z0-9][a-zA-Z0-9._-]{0,99}$/, "must start with a letter or digit, then letters, digits, '.', '_' or '-' (max 100 chars)");
 const visibilitySchema = _enum(["public", "private"]);
 const repoStatusSchema = _enum([
@@ -17013,7 +17112,7 @@ function createProxyClient(cfg) {
 					Authorization: await userBearer(),
 					Accept: "application/json"
 				}
-			});
+			}, (raw) => deploySummaryArraySchema.parse(raw));
 		},
 		async getAlias(req) {
 			const url = `${base}/api/site/${encodeURIComponent(req.site)}/alias/${encodeURIComponent(req.mode)}`;
@@ -19133,7 +19232,7 @@ function formatTable(rows) {
 		r.occurredAt,
 		r.actor,
 		r.action,
-		r.site || r.deployId || targetFromDetail(r),
+		targetOf(r),
 		r.outcome
 	]);
 	const widths = headers.map((h, i) => Math.max(h.length, ...cells.map((row) => row[i]?.length ?? 0)));
@@ -19144,6 +19243,10 @@ function targetFromDetail(r) {
 	const name = r.detail?.["name"];
 	return typeof name === "string" ? name : "";
 }
+function targetOf(r) {
+	if (r.site && r.deployId) return `${r.site}/${r.deployId}`;
+	return r.site || r.deployId || targetFromDetail(r);
+}
 async function ls(options, deps = {}) {
 	const command = "audit ls";
 	const message = deps.logMessage ?? ((s) => R.message(s));
@@ -19316,7 +19419,7 @@ function installExitNotice(current) {
 }
 //#endregion
 //#region src/cli.ts
-const version = "0.12.0";
+const version = "0.13.0";
 function handleActionError(command, json, err) {
 	const ctx = {
 		json,

package/package.json

@@ -1,24 +1,25 @@
 {
   "name": "@freecodecamp/universe-cli",
-  "version": "0.12.0",
-  "main": "dist/index.cjs",
-  "scripts": {
-    "test": "vitest run",
-    "test:smoke": "UNIVERSE_E2E_REAL=1 vitest run tests/e2e/smoke-real-artemis.test.ts",
-    "build": "tsdown",
-    "lint": "oxlint src tests",
-    "typecheck": "tsc --noEmit",
-    "prepare": "husky",
-    "dev": "tsx src/index.ts"
+  "version": "0.13.0",
+  "description": "Static site deployment CLI for the freeCodeCamp Universe platform",
+  "keywords": [
+    "cli",
+    "deployment",
+    "freecodecamp",
+    "static-site"
+  ],
+  "homepage": "https://github.com/freeCodeCamp-Universe/universe-cli#readme",
+  "bugs": {
+    "url": "https://github.com/freeCodeCamp-Universe/universe-cli/issues"
   },
-  "author": "Mrugesh Mohapatra <noreply@mrugesh.dev> (https://mrugesh.dev/)",
   "license": "BSD-3-Clause",
+  "author": "Mrugesh Mohapatra <noreply@mrugesh.dev> (https://mrugesh.dev/)",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/freeCodeCamp-Universe/universe-cli.git"
   },
-  "publishConfig": {
-    "access": "public"
+  "bin": {
+    "universe": "dist/index.cjs"
   },
   "files": [
     "dist/",
@@ -26,8 +27,20 @@
     "LICENSE"
   ],
   "type": "module",
-  "bin": {
-    "universe": "dist/index.cjs"
+  "main": "dist/index.cjs",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "vitest run",
+    "test:smoke": "UNIVERSE_E2E_REAL=1 vitest run tests/e2e/smoke-real-artemis.test.ts",
+    "build": "tsdown",
+    "lint": "oxlint src tests",
+    "typecheck": "tsc --noEmit",
+    "prepare": "husky",
+    "dev": "tsx src/index.ts",
+    "fmt": "oxfmt",
+    "fmt:check": "oxfmt --check"
   },
   "dependencies": {
     "@clack/prompts": "^1.5.0",
@@ -38,6 +51,7 @@
   "devDependencies": {
     "@types/node": "^24.12.2",
     "husky": "^9.1.7",
+    "oxfmt": "^0.59.0",
     "oxlint": "^1.68.0",
     "postject": "1.0.0-alpha.6",
     "tsdown": "0.22.1",
@@ -45,19 +59,8 @@
     "typescript": "^5.9.3",
     "vitest": "^3.2.4"
   },
-  "packageManager": "pnpm@10.33.0",
   "engines": {
     "node": ">=24.0.0"
   },
-  "description": "Static site deployment CLI for the freeCodeCamp Universe platform",
-  "homepage": "https://github.com/freeCodeCamp-Universe/universe-cli#readme",
-  "bugs": {
-    "url": "https://github.com/freeCodeCamp-Universe/universe-cli/issues"
-  },
-  "keywords": [
-    "cli",
-    "static-site",
-    "deployment",
-    "freecodecamp"
-  ]
+  "packageManager": "pnpm@10.33.0"
 }