refactor: move CLI scripts to the cli directory

Author: nakrovati

cli.js

@@ -0,0 +1,48 @@
+import { program } from "commander";
+
+import {
+  checkObsoleteFrameworks,
+  cleanFrameworkDirectories,
+  configureStyles,
+  copyProjectToDist,
+  createFrameworkZipArchive,
+  updateLockfilesOfAllFrameworks,
+} from "./cli/index.js";
+
+program.command("zip").action(createFrameworkZipArchive);
+
+program.command("copy").action(copyProjectToDist);
+
+program
+  .command("check-obsolete")
+  .option("--debug [boolean]", "", false)
+  .action((options) => {
+    checkObsoleteFrameworks(options);
+  });
+
+program
+  .command("cleanup")
+  .option("--frameworks-dir-path [string]", "", "frameworks")
+  .option("--frameworks-types [Array<string>]", "", ["keyed", "non-keyed"])
+  .action((options) => {
+    cleanFrameworkDirectories(options);
+  });
+
+program
+  .command("update-lockfiles")
+  .option("--frameworks-dir-path [string]", "", "frameworks")
+  .option("--frameworks-types [Array<string>]", "", ["keyed", "non-keyed"])
+  .option("--latest-lockfile-version [number]", "", 3)
+  .action((options) => {
+    updateLockfilesOfAllFrameworks(options);
+  });
+
+program
+  .command("configure-styles")
+  .option("--bootstrap [boolean]", "", false)
+  .option("--minimal [boolean]", "", false)
+  .action(async (options) => {
+    await configureStyles(options);
+  });
+
+program.parse();

check-obsolete.js renamed to cli/check-obsolete.js

@@ -1,20 +1,9 @@
+import JSON5 from "json5";
 import { execSync } from "node:child_process";
 import * as fs from "node:fs";
 import path from "node:path";
-import JSON5 from "json5";
-import yargs from "yargs";
-import { getFrameworks } from "./utils/frameworks/index.js";
-
-const args = yargs(process.argv)
-  .usage("$0 [--debug]")
-  .help()
-  .boolean("debug")
-  .default("debug", false).argv;
 
-/**
- * @type {boolean}
- */
-const DEBUG = args.debug;
+import { getFrameworks } from "../utils/frameworks/index.js";
 
 /**
  * @typedef {Object} Framework
@@ -80,12 +69,12 @@ function maybeObsolete(packageName) {
     const isObsolete = modifiedDate < obsoleteDate;
     const formattedDate = modifiedDate.toISOString().substring(0, 10);
 
-    return { isObsolete, packageName, lastUpdate: formattedDate };
+    return { isObsolete, lastUpdate: formattedDate, packageName };
   } catch (error) {
     console.error(
       `Failed to execute npm view for ${packageName}. Error Code ${error.status} and message: ${error.message}`,
     );
-    return { isObsolete: false, packageName, lastUpdate: null };
+    return { isObsolete: false, lastUpdate: null, packageName };
   }
 }
 
@@ -95,9 +84,13 @@ const manualChecks = [];
 /**
  * Checks frameworks in frameworks/keyed and frameworks/non-keyed for obsolescence,
  * the presence of package.json and the presence of the frameworkVersionFromPackage property
+ * @param {Object} options
+ * @param {boolean} options.debug
  */
-function checkFrameworks() {
-  for (const { type, name } of frameworks) {
+function checkObsoleteFrameworks(options) {
+  const DEBUG = options.debug ?? false;
+
+  for (const { name, type } of frameworks) {
     const frameworkPath = path.join("frameworks", type, name);
     const packageJSONPath = path.join(frameworkPath, "package.json");
 
@@ -159,4 +152,4 @@ function checkFrameworks() {
     );
 }
 
-checkFrameworks();
+export { checkObsoleteFrameworks };

cleanup.js renamed to cli/cleanup.js

@@ -1,25 +1,5 @@
 import * as fs from "node:fs";
 import path from "node:path";
-import yargs from "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;
-
-/**
- * @type {string[]}
- */
-const keyedTypes = args.keyedTypes;
-
-const frameworksPath = path.resolve(frameworksDir);
 
 const filesToDelete = [
   "package-lock.json",
@@ -38,28 +18,30 @@ const filesToDelete = [
 function deleteFrameworkFiles(frameworkPath, filesToDelete) {
   for (const file of filesToDelete) {
     const filePath = path.join(frameworkPath, file);
-    fs.rmSync(filePath, { recursive: true, force: true });
+    fs.rmSync(filePath, { force: true, recursive: true });
   }
   console.log(`Deleted: ${filesToDelete}`);
 }
 
 /**
  * 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
+ * @param {Object} options
+ * @param {string} options.frameworksDirPath
+ * @param {Array<string>} options.frameworksTypes
  */
-function cleanFrameworkDirectories(frameworksPath, keyedTypes) {
-  for (const keyedType of keyedTypes) {
-    const frameworkDir = path.resolve(frameworksPath, keyedType);
+function cleanFrameworkDirectories(options) {
+  const { frameworksDirPath, frameworksTypes } = options;
+
+  for (const frameworkType of frameworksTypes) {
+    const frameworkDir = path.resolve(frameworksDirPath, frameworkType);
     const directories = fs.readdirSync(frameworkDir);
 
     for (const directory of directories) {
       const frameworkPath = path.resolve(frameworkDir, directory);
       console.log(`cleaning ${frameworkPath}`);
-
       deleteFrameworkFiles(frameworkPath, filesToDelete);
     }
   }
 }
 
-cleanFrameworkDirectories(frameworksPath, keyedTypes);
+export { cleanFrameworkDirectories };

configure-styles.js renamed to cli/configure-styles.js

@@ -1,14 +1,5 @@
 import * as fs from "node:fs";
 import path from "node:path";
-import yargs from "yargs";
-
-const args = yargs(process.argv)
-  .usage("$0 [--bootstrap --minimal]")
-  .help()
-  .boolean("bootstrap")
-  .default("bootstrap", false)
-  .boolean("minimal")
-  .default("minimal", false).argv;
 
 // Function to copy CSS and generate shared-styles.html
 async function copyAndGenerateSharedStyles(sourceCss, mainCss) {
@@ -27,16 +18,23 @@ async function copyAndGenerateSharedStyles(sourceCss, mainCss) {
   );
 }
 
-// Main function
-async function configureStyles() {
+/**
+ * @param {Object} options
+ * @param {boolean} options.bootstrap
+ * @param {boolean} options.minimal
+ * @returns
+ */
+async function configureStyles(options) {
+  const { bootstrap, minimal } = options;
+
   try {
-    if (args.bootstrap ^ args.minimal) {
+    if (bootstrap ^ minimal) {
       console.log("ERROR: You must either choose bootstrap or minimal");
       return;
     }
 
     // Read and copy the appropriate CSS file
-    if (args.bootstrap) {
+    if (bootstrap) {
       await copyAndGenerateSharedStyles(
         path.join("css", "useOriginalBootstrap.css"),
         path.join("css", "bootstrap", "dist", "css", "bootstrap.min.css"),
@@ -52,4 +50,4 @@ async function configureStyles() {
   }
 }
 
-configureStyles();
+export { configureStyles };

copy.js renamed to cli/copy.js

@@ -17,7 +17,7 @@ function shouldInclude(name) {
     const isTargetWeb = name.includes("/target/web");
 
     console.log(
-      `File: ${name}\nIs Binding Scala: ${isBindingScala}\nIs Target: ${isTarget}\nIs Target Web: ${isTargetWeb}`
+      `File: ${name}\nIs Binding Scala: ${isBindingScala}\nIs Target: ${isTarget}\nIs Target Web: ${isTargetWeb}`,
     );
 
     if (isTarget) {
@@ -73,7 +73,7 @@ function copyFolderRecursiveSync(sourcePath, destinationPath) {
 function processDirectories() {
   const directories = fs.readdirSync(".");
   const nonHiddenDirectories = directories.filter(
-    (directory) => !directory.startsWith(".")
+    (directory) => !directory.startsWith("."),
   );
 
   for (const directory of nonHiddenDirectories) {
@@ -99,13 +99,11 @@ function copyProjectToDist() {
 
   fs.copyFileSync(
     path.join("webdriver-ts", "table.html"),
-    path.join("dist", "webdriver-ts", "table.html")
+    path.join("dist", "webdriver-ts", "table.html"),
   );
   fs.copyFileSync("index.html", path.join("dist", "index.html"));
 
   processDirectories();
 }
 
-copyProjectToDist();
-
-module.exports = { copyProjectToDist };
+export { copyProjectToDist };

cli/index.js

@@ -0,0 +1,6 @@
+export { checkObsoleteFrameworks } from "./check-obsolete.js";
+export { cleanFrameworkDirectories } from "./cleanup.js";
+export { configureStyles } from "./configure-styles.js";
+export { copyProjectToDist } from "./copy.js";
+export { updateLockfilesOfAllFrameworks } from "./update-lockfiles.js";
+export { createFrameworkZipArchive } from "./zip.js";

update-lockfiles.js renamed to cli/update-lockfiles.js

@@ -1,44 +1,17 @@
 import { execSync } from "node:child_process";
-import { cwd } from "node:process";
 import * as fs from "node:fs";
 import path from "node:path";
-import yargs from "yargs";
-import { getFrameworks } from "./utils/frameworks/index.js";
-
-const args = yargs(process.argv)
-  .usage("$0 [--frameworks-dir]")
-  .help("help")
-  .string("frameworks-dir")
-  .default("frameworks-dir", "frameworks")
-  .array("frameworks-types")
-  .default("frameworks-types", ["keyed", "non-keyed"])
-  .number("latest-lockfile-version")
-  .default("latest-lockfile-version", 3).argv;
-
-/**
- * @type {string}
- */
-const frameworksDir = args.frameworksDir;
-
-/**
- * @type {string[]}
- */
-const frameworksTypes = args.frameworksTypes;
+import { cwd } from "node:process";
 
-/**
- * @type {number}
- */
-const latestLockfileVersion = args.latestLockfileVersion;
+import { getFrameworks } from "../utils/frameworks/index.js";
 
 /**
  * @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")
  */
 
-/**
- * @param {string} frameworkPath
- */
+/** @param {string} frameworkPath */
 function runNpmInstall(frameworkPath) {
   try {
     execSync("npm install --package-lock-only", {
@@ -73,13 +46,19 @@ function getPackageLockJSONVersion(packageLockJSONPath) {
 /**
  * Updates the lockfile of one framework
  * @param {Framework} framework
+ * @param {number} latestLockfileVersion
+ * @param {string} frameworkDirPath
  */
-function processFramework(framework) {
+function updateFrameworkLockfile(
+  framework,
+  latestLockfileVersion,
+  frameworkDirPath,
+) {
   const { name, type } = framework;
 
   console.log(`Checking ${type} ${name} lockfile`);
 
-  const frameworkPath = path.join(cwd(), frameworksDir, type, name);
+  const frameworkPath = path.join(cwd(), frameworkDirPath, type, name);
 
   const packageLockJSONPath = path.join(frameworkPath, "package-lock.json");
   const packageLockJSONVersion = getPackageLockJSONVersion(packageLockJSONPath);
@@ -95,13 +74,23 @@ function processFramework(framework) {
 
 /**
  * Updates all frameworks lockfiles in the frameworks directory.
+ * @param {Object} options
+ * @param {string} options.frameworksDirPath
+ * @param {string} options.frameworksTypes
+ * @param {string} options.latestLockfileVersion
  */
-function processAllFrameworks() {
-  const frameworks = getFrameworks(frameworksDir, frameworksTypes);
+function updateLockfilesOfAllFrameworks(options) {
+  const { frameworksDirPath, frameworksTypes, latestLockfileVersion } = options;
+
+  const frameworks = getFrameworks(frameworksDirPath, frameworksTypes);
 
   for (const framework of frameworks) {
-    processFramework(framework);
+    updateFrameworkLockfile(
+      framework,
+      latestLockfileVersion,
+      frameworksDirPath,
+    );
   }
 }
 
-processAllFrameworks();
+export { updateLockfilesOfAllFrameworks };