Merge pull request #1354 from nakrovati/update-root-scripts

Author: krausest

.dockerignore

@@ -3,7 +3,7 @@
 .git/                 
 .gitignore            
 cleanup.js            
-configureStyles.js    
+configure-styles.js    
 copy.js               
 favicon.ico           
 frameworks/           

.eslintrc.json

@@ -1,4 +1,5 @@
 {
   "env": { "node": true, "es2024": true },
-  "extends": ["eslint:recommended"]
+  "extends": ["eslint:recommended"],
+  "parserOptions": { "sourceType": "module" }
 }

cleanup.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();

cli.js

@@ -1,24 +1,15 @@
-const { execSync } = require("child_process");
-const fs = require("fs");
-const JSON5 = require("json5");
-const path = require("path");
+import JSON5 from "json5";
+import { execSync } from "node:child_process";
+import * as fs from "node:fs";
+import path from "node:path";
 
-const DEBUG = false;
+import { getFrameworks } from "../utils/frameworks/index.js";
 
 /**
- * Returns an array with arrays of types and names of frameworks
- * @example getFramewokrs()
- * @returns [{type:"keyed", name:"vue"},{type:"keyed", name:"qwik"},{type:"non-keyed", name:"svelte"}]
+ * @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")
  */
-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 frameworks = getFrameworks();
 
@@ -30,7 +21,7 @@ const frameworks = getFrameworks();
 function findDuplicateFrameworks(frameworks) {
   const names = frameworks.map((framework) => framework.name); // Creates an array with framework names only
   const duplicateNames = names.filter(
-    (name, index) => names.indexOf(name) !== index
+    (name, index) => names.indexOf(name) !== index,
   ); // Filters out repetitive framework names
 
   return duplicateNames;
@@ -71,19 +62,19 @@ function maybeObsolete(packageName) {
     const obsoleteDate = new Date(
       now.getFullYear() - 1,
       now.getMonth(),
-      now.getDay()
+      now.getDay(),
     );
 
     const modifiedDate = new Date(timeData.modified);
     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}`
+      `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 };
   }
 }
 
@@ -93,15 +84,19 @@ 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");
 
     if (!fs.existsSync(packageJSONPath)) {
       missingPackageWarnings.push(
-        `WARN: skipping ${type}/${name} since there's no package.json`
+        `WARN: skipping ${type}/${name} since there's no package.json`,
       );
       continue;
     }
@@ -127,7 +122,7 @@ function checkFrameworks() {
     }
 
     const anyPackageObsolete = isPackageObsolete.some(
-      (packageFramework) => packageFramework.isObsolete
+      (packageFramework) => packageFramework.isObsolete,
     );
 
     if (anyPackageObsolete) {
@@ -136,14 +131,14 @@ function checkFrameworks() {
         .join(", ");
 
       console.log(
-        `Last npm update for ${type}/${name} - ${mainPackages} is older than a year: ${formattedPackages}`
+        `Last npm update for ${type}/${name} - ${mainPackages} is older than a year: ${formattedPackages}`,
       );
       continue;
     }
 
     if (DEBUG) {
       console.log(
-        `Last npm update for ${type}/${name} ${mainPackages} is newer than a year`
+        `Last npm update for ${type}/${name} ${mainPackages} is newer than a year`,
       );
     }
   }
@@ -153,8 +148,8 @@ function checkFrameworks() {
   if (manualChecks.length > 0)
     console.warn(
       "\nThe following frameworks must be checked manually\n" +
-        manualChecks.join("\n")
+        manualChecks.join("\n"),
     );
 }
 
-checkFrameworks();
+export { checkObsoleteFrameworks };

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

@@ -0,0 +1,47 @@
+import * as fs from "node:fs";
+import path from "node:path";
+
+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, { 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 {Object} options
+ * @param {string} options.frameworksDirPath
+ * @param {Array<string>} options.frameworksTypes
+ */
+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);
+    }
+  }
+}
+
+export { cleanFrameworkDirectories };

cli/cleanup.js

@@ -1,55 +1,53 @@
-const fs = require("fs-extra");
-const yargs = require("yargs");
-const path = require("path");
-
-const args = yargs(process.argv)
-  .usage("$0 [--bootstrap --minimal]")
-  .help("help")
-  .boolean("bootstrap")
-  .default("bootstrap", false)
-  .boolean("minimal")
-  .default("minimal", false).argv;
+import * as fs from "node:fs";
+import path from "node:path";
 
 // Function to copy CSS and generate shared-styles.html
 async function copyAndGenerateSharedStyles(sourceCss, mainCss) {
-  await fs.copy(sourceCss, path.join("css", "currentStyle.css"));
+  await fs.promises.cp(sourceCss, path.join("css", "currentStyle.css"));
 
   // Read the main CSS file
-  const mainCssContent = await fs.readFile(mainCss, "utf8");
+  const mainCssContent = await fs.promises.readFile(mainCss, "utf8");
 
   // Generate shared-styles.html content
   const sharedStylesContent = `<dom-module id="shared-styles"><template><style>${mainCssContent}</style></template></dom-module>`;
 
   // Write shared-styles.html
-  await fs.writeFile(
+  await fs.promises.writeFile(
     path.join("polymer-v2.0.0-non-keyed", "src", "shared-styles.html"),
-    sharedStylesContent
+    sharedStylesContent,
   );
 }
 
-// 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")
+        path.join("css", "bootstrap", "dist", "css", "bootstrap.min.css"),
       );
     } else {
       await copyAndGenerateSharedStyles(
         path.join("css", "useMinimalCss.css"),
-        path.join("css", "useMinimalCss.css")
+        path.join("css", "useMinimalCss.css"),
       );
     }
   } catch (error) {
     console.error("An error occurred:", error.message);
   }
 }
 
-configureStyles();
+export { configureStyles };

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

@@ -1,5 +1,5 @@
-const fs = require("fs");
-const path = require("path");
+import * as fs from "node:fs";
+import path from "node:path";
 
 const internalExclude = ["node_modules", "elm-stuff", "project", ".DS_Store"];
 const rootExclude = ["dist", "node_modules", "webdriver-ts"];
@@ -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 };