refactor, perf, feat: improve scripts in root

Add JSDoc types and comments.

Add script customisation via CLI using `yargs`.

Improve performance.

Improve naming (remove different names for the same variables and
functions to remove confusion).

(`rebuild-check-single.js`) Fix the file description.

(`cleanup.js`) Improve performance of deleting framework files
by using native `fs.rmSync` and making the logic of deleting all files
in a separate function.

Author: nakrovati

checkObsolete.js

@@ -2,22 +2,39 @@ const { execSync } = require("child_process");
 const fs = require("fs");
 const JSON5 = require("json5");
 const path = require("path");
+const yargs = require("yargs");
 
-const DEBUG = false;
+const args = yargs(process.argv)
+  .usage("$0 [--debug]")
+  .help()
+  .boolean("debug")
+  .default("debug", false).argv;
 
 /**
- * Returns an array with arrays of types and names of frameworks
+ * @type {boolean}
+ */
+const DEBUG = args.debug;
+
+/**
+ * @typedef {Object} Framework
+ * @property {string} name - Name of the framework (e.g., "vue", "qwik", "svelte")
+ * @property {string} type - Type of the framework (e.g., "keyed" or "non-keyed")
+ */
+
+/**
+ * Returns an array of frameworks with their type and name
  * @example getFramewokrs()
- * @returns [{type:"keyed", name:"vue"},{type:"keyed", name:"qwik"},{type:"non-keyed", name:"svelte"}]
+ * @returns {Framework[]}
  */
 function getFrameworks() {
-  const keyedFrameworks = fs
-    .readdirSync("./frameworks/keyed")
-    .map((framework) => ({ type: "keyed", name: framework }));
-  const nonKeyedFrameworks = fs
-    .readdirSync("./frameworks/non-keyed")
-    .map((framework) => ({ type: "non-keyed", name: framework }));
-  return [...keyedFrameworks, ...nonKeyedFrameworks];
+  const framewokrsTypes = ["keyed", "non-keyed"];
+  const framewokrs = framewokrsTypes.flatMap((type) =>
+    fs
+      .readdirSync(path.join("framewokrs", type))
+      .map((framework) => ({ name: framework, type }))
+  );
+
+  return framewokrs;
 }
 
 const frameworks = getFrameworks();

cleanup.js

@@ -1,40 +1,65 @@
 const fs = require("fs");
 const path = require("path");
+const yargs = require("yargs");
+
+const args = yargs(process.argv)
+  .help()
+  .string("framework-dir")
+  .default("framework-dir", "frameworks")
+  .array("keyed-types")
+  .default("keyed-types", ["keyed", "non-keyed"]).argv;
+
+/**
+ * @type {string}
+ */
+const frameworksDir = args.frameworkDir;
 
 /**
- * @param {string} dir
+ * @type {string[]}
  */
-function rmIfExists(dir) {
-  if (fs.existsSync(dir)) {
-    console.log("Cleaning", dir);
-    fs.rmSync(dir, { recursive: true });
+const keyedTypes = args.keyedTypes;
+
+const frameworksPath = path.resolve(frameworksDir);
+
+const filesToDelete = [
+  "package-lock.json",
+  "yarn-lock",
+  "dist",
+  "elm-stuff",
+  "bower_components",
+  "node_modules",
+];
+
+/**
+ * Delete specified files in the framework directory
+ * @param {string} frameworkPath
+ * @param {string[]} filesToDelete
+ */
+function deleteFrameworkFiles(frameworkPath, filesToDelete) {
+  for (const file of filesToDelete) {
+    const filePath = path.join(frameworkPath, file);
+    fs.rmSync(filePath, { recursive: true, force: true });
   }
+  console.log(`Deleted: ${filesToDelete}`);
 }
 
 /**
- * @param {string} basePath
+ * Cleans all framework directories of package-lock.json, yarn-lock and the elm-stuff, node-modules, bower-components and dist directories.
+ * @param {string} frameworksPath
  * @param {string} keyedTypes
  */
-function cleanFrameworkDirectories(basePath, keyedTypes) {
+function cleanFrameworkDirectories(frameworksPath, keyedTypes) {
   for (const keyedType of keyedTypes) {
-    const frameworkDir = path.resolve(basePath, keyedType);
+    const frameworkDir = path.resolve(frameworksPath, keyedType);
     const directories = fs.readdirSync(frameworkDir);
 
     for (const directory of directories) {
       const frameworkPath = path.resolve(frameworkDir, directory);
-      console.log("cleaning ", frameworkPath);
-
-      rmIfExists(path.join(frameworkPath, "package-lock.json"));
-      rmIfExists(path.join(frameworkPath, "yarn.lock"));
-      rmIfExists(path.join(frameworkPath, "node_modules"));
-      rmIfExists(path.join(frameworkPath, "dist"));
-      rmIfExists(path.join(frameworkPath, "elm-stuff"));
-      rmIfExists(path.join(frameworkPath, "bower_components"));
+      console.log(`cleaning ${frameworkPath}`);
+
+      deleteFrameworkFiles(frameworkPath, filesToDelete);
     }
   }
 }
 
-const keyedTypes = ["keyed", "non-keyed"];
-const frameworksPath = path.resolve("frameworks");
-
 cleanFrameworkDirectories(frameworksPath, keyedTypes);

configureStyles.js

@@ -4,7 +4,7 @@ const path = require("path");
 
 const args = yargs(process.argv)
   .usage("$0 [--bootstrap --minimal]")
-  .help("help")
+  .help()
   .boolean("bootstrap")
   .default("bootstrap", false)
   .boolean("minimal")

rebuild-all.js

@@ -2,6 +2,20 @@ const takeWhile = require("lodash/takeWhile");
 const { execSync } = require("child_process");
 const fs = require("fs");
 const path = require("path");
+const yargs = require("yargs");
+
+const args = yargs(process.argv.slice(2))
+  .usage("$0 [--ci --docker keyed/framework1 ... non-keyed/frameworkN]")
+  .help()
+  .boolean("ci")
+  .default("ci", false)
+  .describe("ci", "Use npm ci or npm install?")
+  .boolean("docker")
+  .default("docker", false)
+  .describe(
+    "docker",
+    "Copy package-lock back for docker build or build locally?"
+  ).argv;
 
 /*
 This script rebuilds all frameworks from scratch,
@@ -12,31 +26,46 @@ If building a framework fails you can resume building like
 npm run rebuild-frameworks --restartWith keyed/react
 */
 
-const cliArgs = process.argv.slice(2);
-
-// Use npm ci or npm install ?
-const useCi = cliArgs.includes("--ci");
+/**
+ * Use npm ci or npm install?
+ * @type {boolean}
+ */
+const useCi = args.ci;
 
-// Copy package-lock back for docker build or build locally?
-const useDocker = cliArgs.includes("--docker");
+/**
+ * Copy package-lock back for docker build or build locally?
+ * @type {boolean}
+ */
+const useDocker = args.docker;
 
-const restartBuildingWith = cliArgs.find((arg) => !arg.startsWith("--"));
+const restartBuildingWith = args._.find((arg) => !arg.startsWith("--"));
 const restartWithFramework = restartBuildingWith || "";
 
 console.log(
   "ARGS",
+  args,
   "ci",
   useCi,
   "docker",
   useDocker,
   "restartWith",
-  restartWithFramework,
+  restartWithFramework
 );
 
+const filesToDelete = [
+  "yarn-lock",
+  "dist",
+  "elm-stuff",
+  "bower_components",
+  "node_modules",
+  "output",
+  useCi && "package-lock.json",
+].filter(Boolean);
+
 /**
  * @typedef {Object} Framework
- * @property {string} type - Type of the framework (e.g., "keyed" or "non-keyed")
  * @property {string} name - Name of the framework (e.g., "vue", "qwik", "svelte")
+ * @property {string} type - Type of the framework (e.g., "keyed" or "non-keyed")
  */
 
 /**
@@ -45,13 +74,14 @@ console.log(
  * @returns {Framework[]}
  */
 function getFrameworks() {
-  const keyedFrameworks = fs
-    .readdirSync("./frameworks/keyed")
-    .map((framework) => ({ type: "keyed", name: framework }));
-  const nonKeyedFrameworks = fs
-    .readdirSync("./frameworks/non-keyed")
-    .map((framework) => ({ type: "non-keyed", name: framework }));
-  return [...keyedFrameworks, ...nonKeyedFrameworks];
+  const keyedTypes = ["keyed", "non-keyed"];
+  const framewokrs = keyedTypes.flatMap((type) =>
+    fs
+      .readdirSync(path.join("frameworks", type))
+      .map((framework) => ({ name: framework, type }))
+  );
+
+  return framewokrs;
 }
 
 /**
@@ -68,7 +98,7 @@ function shouldSkipFramework({ type, name }) {
 }
 
 /**
- * Run a command synchronously in the specified directory
+ * Run a command synchronously in the specified directory and log command
  * @param {string} command - The command to run
  * @param {string} cwd - The current working directory (optional)
  */
@@ -111,15 +141,6 @@ function buildFramework(framework) {
   //     execSync(`rm -r ${path}`);
   // }
   // rsync(keyed,name);
-  const filesToDelete = [
-    "yarn-lock",
-    "dist",
-    "elm-stuff",
-    "bower_components",
-    "node_modules",
-    "output",
-    useCi ? "" : "package-lock.json",
-  ];
 
   deleteFrameworkFiles(frameworkPath, filesToDelete);
 
@@ -141,7 +162,7 @@ function buildFrameworks() {
   const skippableFrameworks = takeWhile(frameworks, shouldSkipFramework);
   const buildableFrameworks = frameworks.slice(skippableFrameworks.length);
 
-  console.log("Building frameworks:", buildableFrameworks);
+  // console.log("Building frameworks:", buildableFrameworks);
 
   for (const framework of buildableFrameworks) {
     buildFramework(framework);