create-cubing-app 0.35.6-rc2 → 0.35.6-rc21

package/bin/create-cubing-app.js

@@ -1,8 +1,12 @@
+#!/usr/bin/env node
 import { exec } from "child_process";
-import { writeFile } from "fs";
-import { mkdir, readFile } from "fs/promises";
+import { exists } from "fs";
+import { mkdir, readFile, stat, writeFile } from "fs/promises";
+import { join } from "path";
+import { exit, stderr } from "process";
+import { promisify } from "util";
 
-export function execPromise(cmd, options) {
+function execPromise(cmd, options) {
 	return new Promise((resolve, reject) => {
 		const childProcess = exec(cmd, options, (error, stdout, stderr) => {
 			if (error) {
@@ -11,21 +15,98 @@ export function execPromise(cmd, options) {
 			// console.log(stdout);
 			resolve(stdout ? stdout : stderr);
 		});
-		childProcesses.push(childProcess);
 	});
 }
 
-execPromise("npm install --save cubing");
-execPromise("npm install --save-dev barely-a-dev-server");
+await execPromise("npm install validate-npm-package-name", {
+	cwd: new URL(".", import.meta.url),
+});
 
-await mkdir("./src", { recursive: true });
-async function transferFile(basename) {
-	const indexHTML = await readFile(
-		new URL(`../src/${basename}`),
-		import.meta.url,
-	);
-	writeFile(`./src/${basename}`, indexHTML);
+function badPackageName() {
+	stderr.write(`Please specify a valid project name!
+For example:
+
+    npm create cubing-app my-cubing-project
+
+`);
+	exit(1);
+}
+const packageName = process.argv[2];
+if (!packageName) {
+	badPackageName();
+}
+
+const validate = (await import("validate-npm-package-name")).default;
+const validationResults = validate(packageName);
+if (!validationResults.validForNewPackages) {
+	badPackageName();
 }
-await transferFile("index.html");
-await transferFile("index.ts");
-await transferFile("index.css");
+
+const packageRoot = join(".", packageName);
+function packageRooted(path) {
+	return join(packageRoot, path);
+}
+
+// We could uses `stat` from `"fs/promises"`, but I'm not too enthused about
+// catching an error in the "expected" path. So we use `exists`.
+if (await promisify(exists)(packageRoot)) {
+	process.stderr.write(`Project already exists in the current folder: ${packageRoot}
+Please select a different name (or delete the existing project folder).
+`);
+	exit(1);
+}
+await mkdir(packageRoot);
+
+const initialPackageJSON = {
+	scripts: {
+		build:
+			"node -e 'import(\"barely-a-dev-server\").then(s => s.barelyServe({entryRoot: \"src\", dev: false, outDir: \"dist/web\"}))' && echo '' && echo 'Your app has been built in: ./dist/web' && echo ''",
+		dev: 'node -e \'import("barely-a-dev-server").then(s => s.barelyServe({entryRoot: "src"}))\'',
+		clean: "rm -rf ./dist",
+		"upgrade-cubing": "npm install cubing@latest",
+	},
+};
+await writeFile(
+	packageRooted("package.json"),
+	JSON.stringify(initialPackageJSON, null, "  "),
+);
+
+const execOptions = {
+	cwd: packageRoot,
+};
+await mkdir(packageRooted("src"), { recursive: true });
+async function transferFile(rootedPath, contents) {
+	contents ??= await (async () => {
+		const filePath = new URL(join("..", rootedPath), import.meta.url);
+		return readFile(filePath, "utf-8");
+	})();
+	await writeFile(packageRooted(rootedPath), contents);
+}
+await transferFile("src/index.html");
+await transferFile("src/main.ts");
+await transferFile("src/index.css");
+await transferFile(
+	".gitignore",
+	`/dist
+/node_modules
+`,
+);
+
+await execPromise("npm install --save cubing", execOptions);
+await execPromise("npm install --save-dev barely-a-dev-server", execOptions);
+
+console.log(`---------------------------------
+Your cubing app has been created.
+To work on it, run:
+
+    cd ${packageRoot}
+    npm run dev
+
+To create an optimized build of your app that can be uploaded to a file server, run:
+
+    npm run build
+
+When a new version of \`cubing.js\` is released in the future, you can upgrade using:
+
+    npm install cubing@latest
+`);

package/package.json

@@ -1,17 +1,25 @@
 {
   "name": "create-cubing-app",
-  "version": "0.35.6-rc2",
+  "version": "0.35.6-rc21",
+  "type": "module",
   "bin": "./bin/create-cubing-app.js",
   "scripts": {
-    "build": "node -e 'import(\"barely-a-dev-server\").then(s => s.barelyServe({entryRoot: \"src\", dev: false, outDir: \"dist/web\"}))'",
-    "dev": "node -e 'import(\"barely-a-dev-server\").then(s => s.barelyServe({entryRoot: \"src\"}))'",
+    "build": "node -e 'import(\"barely-a-dev-server\").then(s => s.barelyServe({entryRoot: \"./src\", dev: false, outDir: \"dist/web\"}))' && echo '' && echo 'Your app has been built in: ./dist/web' && echo ''",
+    "dev": "node -e 'import(\"barely-a-dev-server\").then(s => s.barelyServe({entryRoot: \"./src\"}))'",
+    "upgrade-cubing": "npm install cubing@latest",
     "clean": "rm -rf ./dist"
   },
   "dependencies": {
     "cubing": "^0.35.6"
   },
   "devDependencies": {
+    "@types/validate-npm-package-name": "^4.0.0",
     "barely-a-dev-server": "^0.4.8",
-    "esbuild": "^0.16.16"
-  }
+    "esbuild": "^0.16.16",
+    "validate-npm-package-name": "^5.0.0"
+  },
+  "files": [
+    "./bin",
+    "./src"
+  ]
 }