create-harper 0.7.0 → 0.8.0

package/index.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 import * as prompts from '@clack/prompts';
+import path from 'node:path';
 import { helpMessage } from './lib/constants/helpMessage.js';
 import { pkgFromUserAgent } from './lib/pkg/pkgFromUserAgent.js';
 import { checkForUpdate } from './lib/steps/checkForUpdate.js';
@@ -77,7 +78,9 @@ async function init() {
 	const { immediate } = immediateResult;
 
 	// Write out the contents based on all prior steps.
-	const root = scaffoldProject(targetDir, projectName, packageName, template, envVars, excludedFiles);
+	const cwd = process.cwd();
+	const root = path.join(cwd, targetDir);
+	scaffoldProject(root, projectName, packageName, template, envVars, excludedFiles);
 
 	// Log out the next steps.
 	showOutro(root, pkgManager, immediate);

package/lib/fs/copyDir.js

@@ -8,7 +8,7 @@ import { copyFile } from './copyFile.js';
  * @param {string} srcDir - The source directory path.
  * @param {string} destDir - The destination directory path.
  * @param {(src: string, dest: string) => boolean} [filter] - An optional filter function that returns true if the file should be included.
- * @param {Record<string, string> | ((content: string, sourcePath: string, targetPath: string) => string)} [substitutions] - A mapping of strings to replace or a function that returns the updated content.
+ * @param {Record<string, string> | ((content: string, targetPath: string) => string)} [substitutions] - A mapping of strings to replace or a function that returns the updated content.
  */
 export function copyDir(srcDir, destDir, filter, substitutions) {
 	fs.mkdirSync(destDir, { recursive: true });

package/lib/fs/copyFile.js

@@ -1,5 +1,6 @@
 import fs from 'node:fs';
 import colors from 'picocolors';
+import { writeFile } from './writeFile.js';
 
 const {
 	gray,
@@ -11,18 +12,11 @@ const {
  *
  * @param {string} sourcePath - The path to the source template file.
  * @param {string} targetPath - The path where the processed file will be written.
- * @param {Record<string, string> | ((content: string, sourcePath: string, targetPath: string) => string)} [substitutions] - A mapping of strings to replace or a function that returns the updated content.
+ * @param {Record<string, string> | ((content: string, targetPath: string) => string)} [substitutions] - A mapping of strings to replace or a function that returns the updated content.
  */
 export function copyFile(sourcePath, targetPath, substitutions) {
 	let updatedContent = fs.readFileSync(sourcePath, 'utf-8');
-	if (typeof substitutions === 'function') {
-		updatedContent = substitutions(updatedContent, sourcePath, targetPath);
-	} else if (substitutions) {
-		for (const variableName in substitutions) {
-			updatedContent = updatedContent.replaceAll(variableName, substitutions[variableName]);
-		}
-	}
+	writeFile(targetPath, updatedContent, substitutions);
 
 	console.log(' + ' + green(targetPath) + gray(' from ' + sourcePath));
-	fs.writeFileSync(targetPath, updatedContent);
 }

package/lib/fs/renameFile.js

@@ -0,0 +1,18 @@
+import fs from 'node:fs';
+import colors from 'picocolors';
+
+const {
+	gray,
+	magenta,
+} = colors;
+
+/**
+ * Applies string substitutions and writes the result to a target path.
+ *
+ * @param {string} sourcePath - The original name of the file or directory.
+ * @param {string} targetPath - The new name of the file or directory.
+ */
+export function renameFile(sourcePath, targetPath) {
+	console.log(' . ' + magenta(targetPath) + gray(' from ' + sourcePath));
+	fs.renameSync(sourcePath, targetPath);
+}

package/lib/fs/writeFile.js

@@ -0,0 +1,20 @@
+import fs from 'node:fs';
+
+/**
+ * Applies string substitutions and writes the result to a target path.
+ *
+ * @param {string} targetPath - The path where the processed file will be written.
+ * @param {string} content - The raw content to write, before optional substitutions.
+ * @param {Record<string, string> | ((content: string, targetPath: string) => string)} [substitutions] - A mapping of strings to replace or a function that returns the updated content.
+ */
+export function writeFile(targetPath, content, substitutions) {
+	let updatedContent = content;
+	if (typeof substitutions === 'function') {
+		updatedContent = substitutions(updatedContent, targetPath);
+	} else if (substitutions) {
+		for (const variableName in substitutions) {
+			updatedContent = updatedContent.replaceAll(variableName, substitutions[variableName]);
+		}
+	}
+	fs.writeFileSync(targetPath, updatedContent);
+}

package/lib/pkg/packageInformation.js

@@ -0,0 +1,13 @@
+import fs from 'node:fs';
+
+export function getOwnName() {
+	const packageContents = fs.readFileSync(new URL('../../package.json', import.meta.url), 'utf-8');
+	const packageJSON = packageContents ? JSON.parse(packageContents) : {};
+	return packageJSON.name;
+}
+
+export function getOwnVersion() {
+	const packageContents = fs.readFileSync(new URL('../../package.json', import.meta.url), 'utf-8');
+	const packageJSON = packageContents ? JSON.parse(packageContents) : {};
+	return packageJSON.version;
+}

package/lib/steps/checkForUpdate.js

@@ -1,8 +1,8 @@
 import spawn from 'cross-spawn';
-import fs from 'node:fs';
 import pc from 'picocolors';
 import { getLatestVersion } from '../pkg/getLatestVersion.js';
 import { isVersionNewer } from '../pkg/isVersionNewer.js';
+import { getOwnName, getOwnVersion } from '../pkg/packageInformation.js';
 
 /**
  * Checks if a newer version of create-harper is available on npm.
@@ -11,20 +11,19 @@ import { isVersionNewer } from '../pkg/isVersionNewer.js';
  * @returns {Promise<string>} - The current version of the package.
  */
 export async function checkForUpdate() {
-	const pkg = JSON.parse(fs.readFileSync(new URL('../../package.json', import.meta.url), 'utf-8'));
-	const currentVersion = pkg.version;
-
+	const packageName = getOwnName();
+	const packageVersion = getOwnVersion();
 	if (process.env.CREATE_HARPER_SKIP_UPDATE) {
-		return currentVersion;
+		return packageVersion;
 	}
 
 	try {
-		const latestVersion = await getLatestVersion(pkg.name);
+		const latestVersion = await getLatestVersion(packageName);
 
-		if (latestVersion && isVersionNewer(latestVersion, currentVersion)) {
+		if (latestVersion && isVersionNewer(latestVersion, packageVersion)) {
 			console.log(
 				pc.yellow(
-					`\nA new version of ${pc.bold(pkg.name)} is available! (${pc.dim(currentVersion)} -> ${
+					`\nA new version of ${pc.bold(packageName)} is available! (${pc.dim(packageVersion)} -> ${
 						pc.green(latestVersion)
 					})`,
 				),
@@ -32,7 +31,7 @@ export async function checkForUpdate() {
 			console.log(`Automatically updating to the latest version...\n`);
 
 			// Clear the npx cache for this package to ensure we get the latest version
-			const lsResult = spawn.sync('npm', ['cache', 'npx', 'ls', pkg.name], {
+			const lsResult = spawn.sync('npm', ['cache', 'npx', 'ls', packageName], {
 				encoding: 'utf-8',
 			});
 
@@ -43,7 +42,7 @@ export async function checkForUpdate() {
 					.filter((line) => line.includes(':'))
 					.filter((line) => {
 						const [, pkgPart] = line.split(':');
-						return pkgPart && pkgPart.trim().startsWith(`${pkg.name}@`);
+						return pkgPart && pkgPart.trim().startsWith(`${packageName}@`);
 					})
 					.map((line) => line.split(':')[0].trim());
 
@@ -54,7 +53,7 @@ export async function checkForUpdate() {
 				}
 			}
 
-			const result = spawn.sync('npx', ['-y', `${pkg.name}@latest`, ...process.argv.slice(2)], {
+			const result = spawn.sync('npx', ['-y', `${packageName}@latest`, ...process.argv.slice(2)], {
 				stdio: 'inherit',
 			});
 
@@ -64,5 +63,5 @@ export async function checkForUpdate() {
 		// Ignore errors, we don't want to block the user if the check fails
 	}
 
-	return currentVersion;
+	return packageVersion;
 }

package/lib/steps/scaffoldProject.js

@@ -7,26 +7,23 @@ import { crawlTemplateDir } from '../fs/crawlTemplateDir.js';
 /**
  * Step 6: Create the project structure and files based on the collected information.
  *
- * @param {string} targetDir - The target directory for the project.
+ * @param {string} root - The root directory for the project.
  * @param {string} projectName - The name of the project.
  * @param {string} packageName - The name for the package.json.
  * @param {string} template - The template name to use.
- * @param {import('./getEnvVars.js').EnvVars} envVars - Environment variables to substitute.
+ * @param {import('./getEnvVars.js').EnvVars} [envVars] - Environment variables to substitute.
  * @param {string[]} [excludedFiles] - A list of files to exclude from the template.
- * @returns {string} - The absolute path to the root of the scaffolded project.
  */
-export function scaffoldProject(targetDir, projectName, packageName, template, envVars, excludedFiles = []) {
-	const cwd = process.cwd();
-	const root = path.join(cwd, targetDir);
+export function scaffoldProject(root, projectName, packageName, template, envVars, excludedFiles = []) {
 	fs.mkdirSync(root, { recursive: true });
 	prompts.log.step(`Scaffolding project in ${root}...`);
 
 	const substitutions = {
-		'your-project-name-here': projectName,
-		'your-package-name-here': packageName,
-		'your-cluster-username-here': envVars.username,
-		'your-cluster-password-here': envVars.password,
-		'your-fabric.harper.fast-cluster-url-here': envVars.target,
+		'your-project-name-here': projectName || 'your-project-name-here',
+		'your-package-name-here': packageName || 'your-package-name-here',
+		'your-cluster-username-here': envVars?.username || 'your-cluster-username-here',
+		'your-cluster-password-here': envVars?.password || 'your-cluster-password-here',
+		'your-fabric.harper.fast-cluster-url-here': envVars?.target || 'your-fabric.harper.fast-cluster-url-here',
 	};
 
 	const templateDir = path.resolve(
@@ -37,6 +34,4 @@ export function scaffoldProject(targetDir, projectName, packageName, template, e
 		`template-${template}`,
 	);
 	crawlTemplateDir(root, templateDir, substitutions, excludedFiles);
-
-	return root;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "create-harper",
-	"version": "0.7.0",
+	"version": "0.8.0",
 	"type": "module",
 	"author": {
 		"name": "HarperDB",
@@ -31,7 +31,8 @@
 		"test:coverage": "vitest run --coverage",
 		"test:watch": "vitest",
 		"templates:apply-shared-templates": "(cd templates-shared && node ./applySharedTemplates.js)",
-		"templates:build-studio-templates": "(cd templates-studio && node ./buildStudioTemplates.js)"
+		"templates:build-studio-templates": "(cd templates-studio && node ./buildStudioTemplates.js)",
+		"templates:publish-studio-templates": "(cd templates-studio && node ./publishStudioTemplates.js)"
 	},
 	"engines": {
 		"node": "^20.19.0 || >=22.12.0"

package/template-react/package.json

@@ -1,6 +1,5 @@
 {
 	"name": "your-package-name-here",
-	"private": true,
 	"version": "0.0.0",
 	"type": "module",
 	"scripts": {

package/template-react-ts/package.json

@@ -1,6 +1,5 @@
 {
 	"name": "your-package-name-here",
-	"private": true,
 	"version": "0.0.0",
 	"type": "module",
 	"scripts": {

package/template-vanilla/package.json

@@ -1,7 +1,6 @@
 {
 	"name": "your-package-name-here",
-	"version": "1.0.0",
-	"description": "Your new Harper app",
+	"version": "0.0.0",
 	"type": "module",
 	"scripts": {
 		"start": "harperdb run .",

package/template-vanilla-ts/package.json

@@ -1,7 +1,6 @@
 {
 	"name": "your-package-name-here",
-	"version": "1.0.0",
-	"description": "Your new Harper app",
+	"version": "0.0.0",
 	"type": "module",
 	"scripts": {
 		"start": "harperdb run .",