@uxf/scripts 11.53.0 → 11.60.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@uxf/scripts",
-    "version": "11.53.0",
+    "version": "11.60.0",
     "description": "",
     "main": "index.js",
     "bin": {

package/src/GoogleChat.js

@@ -5,12 +5,18 @@ const axios = create({});
 
 /**
  * @see https://developers.google.com/chat/api/reference/rest/v1/cards-v1
+ *
+ * @param data
+ * @param {{dryRun?: boolean|undefined, webhookUrl?: string|undefined}} config
+ *
  * @returns {Promise<void>}
  */
-async function chatPostMessage(data, dryRun) {
-    if (env.GOOGLE_WEBHOOK_URL && !dryRun) {
+async function chatPostMessage(data, config = {}) {
+    const webhookUrl = config.webhookUrl ?? env.GOOGLE_WEBHOOK_URL;
+
+    if (webhookUrl && !config.dryRun) {
         try {
-            await axios.post(env.GOOGLE_WEBHOOK_URL, { ...data });
+            await axios.post(webhookUrl, { ...data });
         } catch (error) {
             process.stderr.write("GOOGLE CHAT: chat.postMessage - error");
             console.error(error);
@@ -20,9 +26,19 @@ async function chatPostMessage(data, dryRun) {
     }
 }
 
-async function messageCardsV2(cardsV2) {
+/**
+ *
+ * @param cardsV2
+ * @param {{webhookUrl?: string}} config
+ * @returns {Promise<axios.AxiosResponse<any>>}
+ */
+async function messageCardsV2(cardsV2, config = {}) {
     return axios
-        .post(env.GOOGLE_WEBHOOK_URL, { cardsV2 }, { headers: { "Content-Type": "application/json; charset=UTF-8" } })
+        .post(
+            config.webhookUrl ?? env.GOOGLE_WEBHOOK_URL,
+            { cardsV2 },
+            { headers: { "Content-Type": "application/json; charset=UTF-8" } },
+        )
         .then((r) => r.data);
 }
 

package/src/uxf-release/index.js

@@ -88,7 +88,7 @@ module.exports = async (dryRun, channel, messageTitle) => {
 
     await Slack.chatPostMessage(channel, { text: generateSlackMessage(commits, messageTitle) }, dryRun);
 
-    await GoogleChat.chatPostMessage(generateGoogleMessage(commits, messageTitle), dryRun);
+    await GoogleChat.chatPostMessage(generateGoogleMessage(commits, messageTitle), { dryRun });
 
     await GitLab.createRelease(commits.map(generateReleaseCommitMessage).join("\n"), dryRun);
 };

package/src/uxf-sitemap-check/cli.js

@@ -43,6 +43,11 @@ Environment variables:
             type: "boolean",
             group: "Options",
         })
+        .option("google-chat-webhook-url", {
+            describe: "Webhook URL of Google Chat where to send the results.",
+            type: "string",
+            group: "Options",
+        })
         .option("h", { alias: "help", group: "Options" })
         .strict(false)
         .exitProcess(false);
@@ -60,7 +65,13 @@ Environment variables:
             env.HTTP_PASSWORD = options["http-password"];
         }
 
-        await require("./index")(url, skip, options["with-nested"], options["with-images"]);
+        await require("./index")(
+            url,
+            skip,
+            options["with-nested"],
+            options["with-images"],
+            options["google-chat-webhook-url"],
+        );
     } catch (e) {
         console.error(e);
         return 1;

package/src/uxf-sitemap-check/index.js

@@ -348,13 +348,16 @@ async function testNested(urls, parentIndex, parentUrl, label, webUrl) {
     }
 }
 
+let lastLogTime = 0;
 function printProgress() {
-    stdout.clearLine(0);
-    stdout.cursorTo(0);
-
-    stdout.write(`Completed: ${TESTED_URLS.length}/${URLS_TO_CHECK.size}${createTabSpace(2)}`);
-    stdout.write(`Skipped: ${TESTED_URLS.filter((u) => u.skipped).length}${createTabSpace(2)}`);
-    stdout.write(`Errors: ${TESTED_URLS.filter((u) => u.status !== 200 && u.skipped === false).length}`);
+    const now = Date.now();
+    // Only log every 5 seconds in non-TTY
+    if (now - lastLogTime > 5000) {
+        stdout.write(
+            `Progress: ${TESTED_URLS.length}/${URLS_TO_CHECK.size} completed, ${TESTED_URLS.filter((u) => u.skipped).length} skipped, ${TESTED_URLS.filter((u) => u.status !== 200 && u.skipped === false).length} errors\n`,
+        );
+        lastLogTime = now;
+    }
 }
 
 /**
@@ -403,12 +406,16 @@ function logStatistics(okResults, time) {
 
 /**
  * @param resultErrors {string}
+ * @param webhookUrl {string|undefined}
  * @return {Promise<void>}
  */
-async function sendGoogleChatMessage(resultErrors) {
-    await GoogleChat.chatPostMessage({
-        text: resultErrors,
-    });
+async function sendGoogleChatMessage(resultErrors, webhookUrl) {
+    await GoogleChat.chatPostMessage(
+        {
+            text: resultErrors,
+        },
+        { webhookUrl },
+    );
 }
 
 /**
@@ -416,9 +423,10 @@ async function sendGoogleChatMessage(resultErrors) {
  * @param skip {number}
  * @param withNested {boolean}
  * @param withImages {boolean}
+ * @param googleWebhookUrl {string|undefined}
  * @return {Promise<*>}
  */
-module.exports = async function run(sitemapUrl, skip, withNested, withImages) {
+module.exports = async function run(sitemapUrl, skip, withNested, withImages, googleWebhookUrl) {
     if (!sitemapUrl) {
         stdout.write("⛔ Required parameter --url is empty.\n");
         return process.exit(1);
@@ -447,7 +455,7 @@ module.exports = async function run(sitemapUrl, skip, withNested, withImages) {
     if (errors.length > 0) {
         const errorText = createErrorResult(errors);
         logErrors(errorText, "\n\n\nErrors:\n");
-        await sendGoogleChatMessage(errorText);
+        await sendGoogleChatMessage(errorText, googleWebhookUrl);
     }
 
     if (skippedUrls.length > 0) {