@uxf/scripts 11.23.1 → 11.28.2

package/bin/uxf-unused.js

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+require("../src/uxf-unused/cli")()
+    .then((exitCode) => {
+        process.exitCode = exitCode;
+    })
+    .catch((e) => {
+        console.error(e);
+        process.exitCode = 1;
+    });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uxf/scripts",
-  "version": "11.23.1",
+  "version": "11.28.2",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -9,7 +9,8 @@
     "uxf-release": "bin/uxf-release.js",
     "uxf-sitemap-check": "bin/uxf-sitemap-check.js",
     "uxf-sitemap-meta-export": "bin/uxf-sitemap-meta-export.js",
-    "uxf-i18n-namespaces-gen": "bin/uxf-i18n-namespaces-gen.js"
+    "uxf-i18n-namespaces-gen": "bin/uxf-i18n-namespaces-gen.js",
+    "uxf-unused": "bin/uxf-unused.js"
   },
   "scripts": {
     "build": "",
@@ -29,7 +30,8 @@
     "axios": "1.6.7",
     "cheerio": "1.0.0-rc.12",
     "dayjs": "1.11.10",
-    "madge": "6.1.0",
+    "fast-glob": "3.3.2",
+    "madge": "8.0.0",
     "yargs": "17.7.2"
   }
 }

package/src/shared/load-page-imports.js

@@ -0,0 +1,50 @@
+const fg = require("fast-glob");
+const madge = require("madge");
+const path = require("path");
+const fs = require("fs");
+
+function getTSConfig() {
+    const tsConfigPath = path.resolve(process.cwd(), "tsconfig.json");
+    return fs.existsSync(tsConfigPath) ? tsConfigPath : undefined;
+}
+
+function getTree(subtree, tree, destination, viewedFiles = []) {
+    if (!subtree || subtree.length === 0) {
+        return;
+    }
+
+    for (let child of subtree) {
+        if (viewedFiles.includes(child)) {
+            continue;
+        }
+
+        const nextSubtree = tree[child];
+
+        viewedFiles.push(child);
+
+        if (nextSubtree) {
+            destination.push(nextSubtree);
+        }
+
+        if (nextSubtree && nextSubtree.length > 0) {
+            getTree(nextSubtree, tree, destination, viewedFiles);
+        }
+    }
+}
+
+module.exports = function loadPageImports(directory, fileExtensions = ["ts", "tsx"]) {
+    const pages = fg.sync(directory);
+
+    return madge(process.cwd(), { tsConfig: getTSConfig(), fileExtensions }).then((res) => {
+        const tree = res.obj();
+
+        return pages.reduce((previousValue, currentValue) => {
+            const filesOnPath = [];
+            getTree([currentValue], tree, filesOnPath);
+
+            previousValue[currentValue] = Array.from(new Set(filesOnPath.flat(Number.POSITIVE_INFINITY)));
+
+            return previousValue;
+        }, {});
+    });
+};

package/src/uxf-release/index.js

@@ -1,43 +1,7 @@
 const GitLab = require("../GitLab");
 const Slack = require("../Slack");
 const GoogleChat = require("../GoogleChat");
-
-function parseCommitMessage(commitMessage) {
-    /* fix(bo): [KLK-123] commit message */
-    const result = /^(.*)\((.*)\): \[(.*)\] (.*)/.exec(commitMessage);
-
-    if (result !== null) {
-        return {
-            type: result[1],
-            issues: result[3].replace(" ", "").split(","),
-            message: result[4],
-        };
-    }
-
-    /* fix: [KLK-123] commit message */
-    const result_1 = /^(.*): \[(.*)\] (.*)/.exec(commitMessage);
-
-    if (result_1 !== null) {
-        return {
-            type: result_1[1],
-            issues: result_1[3].replace(" ", "").split(","),
-            message: result_1[4],
-        };
-    }
-
-    /* [KLK-123] commit message */
-    const result_2 = /^\[(.*)\] (.*)/.exec(commitMessage);
-
-    if (result_2 !== null) {
-        return {
-            type: null,
-            issues: result_2[1].replace(" ", "").split(","),
-            message: result_2[2],
-        };
-    }
-
-    return null;
-}
+const parseCommitMessage = require("./utils/parse-commit-message");
 
 function generateSlackCommitMessage(commit) {
     const { title, short_id, web_url, author_email } = commit;

package/src/uxf-release/utils/parse-commit-message.js

@@ -0,0 +1,38 @@
+function parseCommitMessage(commitMessage) {
+    /* fix(bo): [KLK-123] commit message */
+    const result = /^(.*)\((.*)\): \[(.*)\] (.*)/.exec(commitMessage);
+
+    if (result !== null) {
+        return {
+            type: result[1],
+            issues: result[3].replace(" ", "").split(","),
+            message: result[4],
+        };
+    }
+
+    /* fix: [KLK-123] commit message */
+    const result_1 = /^(.*): \[(.*)\] (.*)/.exec(commitMessage);
+
+    if (result_1 !== null) {
+        return {
+            type: result_1[1],
+            issues: result_1[2].replace(" ", "").split(","),
+            message: result_1[3],
+        };
+    }
+
+    /* [KLK-123] commit message */
+    const result_2 = /^\[(.*)\] (.*)/.exec(commitMessage);
+
+    if (result_2 !== null) {
+        return {
+            type: null,
+            issues: result_2[1].replace(" ", "").split(","),
+            message: result_2[2],
+        };
+    }
+
+    return null;
+}
+
+module.exports = parseCommitMessage;

package/src/uxf-release/utils/parse-commit-message.test.js

@@ -0,0 +1,24 @@
+const parseCommitMessage = require("./parse-commit-message");
+
+test("strings (variadic)", () => {
+    expect(parseCommitMessage("fix(bo): [KLK-1,KLK-2] message")).toEqual({
+        type: "fix",
+        issues: ["KLK-1", "KLK-2"],
+        message: "message",
+    });
+    expect(parseCommitMessage("fix(bo): [KLK-1] message")).toEqual({
+        type: "fix",
+        issues: ["KLK-1"],
+        message: "message",
+    });
+    expect(parseCommitMessage("fix: [KLK-1] message")).toEqual({
+        type: "fix",
+        issues: ["KLK-1"],
+        message: "message",
+    });
+    expect(parseCommitMessage("[KLK-1,KLK-2] message")).toEqual({
+        type: null,
+        issues: ["KLK-1", "KLK-2"],
+        message: "message",
+    });
+});

package/src/uxf-unused/cli.js

@@ -0,0 +1,29 @@
+const { argv, env } = require("process");
+
+module.exports = async () => {
+    const cli = require("yargs")
+        .command("$0", "UXF find and remove unused files NextJS project", (yargs) => {
+            yargs.demandCommand(0, 0).usage(`
+            Usage:
+  uxf-unused [options]`);
+        })
+        .option("p", { alias: "pagesDirectory", default: "src/pages/**/*.(ts|tsx)" })
+        .option("f", { alias: "allFilesDirectory", default: "src/**/*.(ts|tsx)" })
+        .option("r", { alias: "removeFiles", boolean: true, default: false })
+        .option("h", { alias: "help" })
+        .strict(false)
+        .exitProcess(false);
+
+    try {
+        const { help, pagesDirectory, allFilesDirectory, removeFiles } = cli.parse(argv.slice(2));
+
+        if (Boolean(help)) {
+            return 0;
+        }
+
+        await require("./index")(pagesDirectory, allFilesDirectory, removeFiles);
+    } catch (e) {
+        console.error(e);
+        return 1;
+    }
+};

package/src/uxf-unused/index.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+const loadPageImports = require("../shared/load-page-imports");
+const fg = require("fast-glob");
+const path = require("path");
+const fs = require("fs");
+
+function unique(value, index, array) {
+    return array.indexOf(value) === index;
+}
+
+async function main(pagesDirectory, allFilesDirectory, shouldRemoveFiles) {
+    const pageImports = await loadPageImports(pagesDirectory);
+
+    const pages = Object.keys(pageImports);
+
+    const usedFiles = Object.values(pageImports).flat().filter(unique).map(path.normalize);
+    const allFiles = fg.sync(allFilesDirectory).map(path.normalize);
+
+    allFiles
+        .filter((e) => !usedFiles.includes(e) && !pages.includes(e))
+        .forEach((unusedFile) => {
+            if (shouldRemoveFiles) {
+                fs.rmSync(unusedFile);
+            }
+            console.log(unusedFile);
+        });
+}
+
+module.exports = main;