@browserstack/accessibility-devtools-cli 0.0.5 → 0.0.7

package/index.js

@@ -5564,7 +5564,7 @@ var require_command = __commonJS({
     "use strict";
     var EventEmitter = require("node:events").EventEmitter;
     var childProcess = require("node:child_process");
-    var path2 = require("node:path");
+    var path3 = require("node:path");
     var fs2 = require("node:fs");
     var process3 = require("node:process");
     var { Argument: Argument2, humanReadableArgName } = require_argument();
@@ -6497,9 +6497,9 @@ Expecting one of '${allowedValues.join("', '")}'`);
         let launchWithNode = false;
         const sourceExt = [".js", ".ts", ".tsx", ".mjs", ".cjs"];
         function findFile(baseDir, baseName) {
-          const localBin = path2.resolve(baseDir, baseName);
+          const localBin = path3.resolve(baseDir, baseName);
           if (fs2.existsSync(localBin)) return localBin;
-          if (sourceExt.includes(path2.extname(baseName))) return void 0;
+          if (sourceExt.includes(path3.extname(baseName))) return void 0;
           const foundExt = sourceExt.find(
             (ext) => fs2.existsSync(`${localBin}${ext}`)
           );
@@ -6517,17 +6517,17 @@ Expecting one of '${allowedValues.join("', '")}'`);
           } catch (err) {
             resolvedScriptPath = this._scriptPath;
           }
-          executableDir = path2.resolve(
-            path2.dirname(resolvedScriptPath),
+          executableDir = path3.resolve(
+            path3.dirname(resolvedScriptPath),
             executableDir
           );
         }
         if (executableDir) {
           let localFile = findFile(executableDir, executableFile);
           if (!localFile && !subcommand._executableFile && this._scriptPath) {
-            const legacyName = path2.basename(
+            const legacyName = path3.basename(
               this._scriptPath,
-              path2.extname(this._scriptPath)
+              path3.extname(this._scriptPath)
             );
             if (legacyName !== this._name) {
               localFile = findFile(
@@ -6538,7 +6538,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
           }
           executableFile = localFile || executableFile;
         }
-        launchWithNode = sourceExt.includes(path2.extname(executableFile));
+        launchWithNode = sourceExt.includes(path3.extname(executableFile));
         let proc;
         if (process3.platform !== "win32") {
           if (launchWithNode) {
@@ -7378,7 +7378,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
        * @return {Command}
        */
       nameFromFilename(filename) {
-        this._name = path2.basename(filename, path2.extname(filename));
+        this._name = path3.basename(filename, path3.extname(filename));
         return this;
       }
       /**
@@ -7392,9 +7392,9 @@ Expecting one of '${allowedValues.join("', '")}'`);
        * @param {string} [path]
        * @return {(string|null|Command)}
        */
-      executableDir(path3) {
-        if (path3 === void 0) return this._executableDir;
-        this._executableDir = path3;
+      executableDir(path4) {
+        if (path4 === void 0) return this._executableDir;
+        this._executableDir = path4;
         return this;
       }
       /**
@@ -7639,19 +7639,19 @@ var require_globrex = __commonJS({
     function globrex(glob2, { extended = false, globstar = false, strict = false, filepath = false, flags = "" } = {}) {
       let regex = "";
       let segment = "";
-      let path2 = { regex: "", segments: [] };
+      let path3 = { regex: "", segments: [] };
       let inGroup = false;
       let inRange = false;
       const ext = [];
       function add(str, { split, last, only } = {}) {
         if (only !== "path") regex += str;
         if (filepath && only !== "regex") {
-          path2.regex += str === "\\/" ? SEP : str;
+          path3.regex += str === "\\/" ? SEP : str;
           if (split) {
             if (last) segment += str;
             if (segment !== "") {
               if (!flags.includes("g")) segment = `^${segment}$`;
-              path2.segments.push(new RegExp(segment, flags));
+              path3.segments.push(new RegExp(segment, flags));
             }
             segment = "";
           } else {
@@ -7836,14 +7836,14 @@ var require_globrex = __commonJS({
       if (!flags.includes("g")) {
         regex = `^${regex}$`;
         segment = `^${segment}$`;
-        if (filepath) path2.regex = `^${path2.regex}$`;
+        if (filepath) path3.regex = `^${path3.regex}$`;
       }
       const result = { regex: new RegExp(regex, flags) };
       if (filepath) {
-        path2.segments.push(new RegExp(segment, flags));
-        path2.regex = new RegExp(path2.regex, flags);
-        path2.globstar = new RegExp(!flags.includes("g") ? `^${GLOBSTAR_SEGMENT}$` : GLOBSTAR_SEGMENT, flags);
-        result.path = path2;
+        path3.segments.push(new RegExp(segment, flags));
+        path3.regex = new RegExp(path3.regex, flags);
+        path3.globstar = new RegExp(!flags.includes("g") ? `^${GLOBSTAR_SEGMENT}$` : GLOBSTAR_SEGMENT, flags);
+        result.path = path3;
       }
       return result;
     }
@@ -7856,7 +7856,7 @@ var require_src = __commonJS({
   "../node_modules/globalyzer/src/index.js"(exports2, module2) {
     "use strict";
     var os2 = require("os");
-    var path2 = require("path");
+    var path3 = require("path");
     var isWin = os2.platform() === "win32";
     var CHARS = { "{": "}", "(": ")", "[": "]" };
     var STRICT = /\\(.)|(^!|\*|[\].+)]\?|\[[^\\\]]+\]|\{[^\\}]+\}|\(\?[:!=][^\\)]+\)|\([^|]+\|[^\\)]+\)|(\\).|([@?!+*]\(.*\)))/;
@@ -7883,7 +7883,7 @@ var require_src = __commonJS({
       if (/[\{\[].*[\/]*.*[\}\]]$/.test(str)) str += "/";
       str += "a";
       do {
-        str = path2.dirname(str);
+        str = path3.dirname(str);
       } while (isglob(str, { strict }) || /(^|[^\\])([\{\[]|\([^\)]+$)/.test(str));
       return str.replace(/\\([\*\?\|\[\]\(\)\{\}])/g, "$1");
     }
@@ -7898,7 +7898,7 @@ var require_src = __commonJS({
         glob2 = pattern;
       }
       if (!isGlob) {
-        base = path2.dirname(pattern);
+        base = path3.dirname(pattern);
         glob2 = base !== "." ? pattern.substr(base.length) : pattern;
       }
       if (glob2.startsWith("./")) glob2 = glob2.substr(2);
@@ -7963,9 +7963,9 @@ var require_tiny_glob = __commonJS({
       }
       if (opts.flush) CACHE = {};
       let matches = [];
-      const { path: path2 } = globrex(glob2.glob, { filepath: true, globstar: true, extended: true });
-      path2.globstar = path2.globstar.toString();
-      await walk(matches, glob2.base, path2, opts, ".", 0);
+      const { path: path3 } = globrex(glob2.glob, { filepath: true, globstar: true, extended: true });
+      path3.globstar = path3.globstar.toString();
+      await walk(matches, glob2.base, path3, opts, ".", 0);
       return opts.absolute ? matches.map((x) => resolve(opts.cwd, x)) : matches;
     };
   }
@@ -8474,7 +8474,6 @@ var source_default = chalk;
 // src/index.ts
 var fs = __toESM(require("fs/promises"));
 var import_node_perf_hooks = require("node:perf_hooks");
-var path = __toESM(require("path"));
 
 // ../node_modules/uuid/dist/esm/stringify.js
 var byteToHex = [];
@@ -8529,7 +8528,7 @@ var v4_default = v4;
 
 // src/buildConfig.ts
 var DEBUG = "production"?.toLocaleLowerCase() !== "production";
-var LINTER_SERVER_ADDRESS = "wss://browserstack.com/ws";
+var LINTER_SERVER_ADDRESS = "wss://devtools-a11y-linter.browserstack.com/ws";
 var EDS_API_KEY = "5PJymLNdWrOwzQNC7J6SXBuUFQGWq4Vuw";
 var EDS_BACKEND = "eds.browserstack.com";
 
@@ -8576,6 +8575,7 @@ function parseArgs(args = process.argv) {
   return {
     include: opts.include,
     exclude: opts.exclude,
+    format: opts.format,
     browserstackUsername: opts.username,
     browserstackAccessKey: opts.accessKey,
     nonStrict: !!opts.nonStrict
@@ -8606,6 +8606,106 @@ async function resolveLintFiles(args) {
   return files;
 }
 
+// src/formatters.ts
+var path2 = __toESM(require("path"));
+function tryParseMessage(message) {
+  try {
+    const parsed = JSON.parse(message);
+    if (parsed && typeof parsed === "object") {
+      return {
+        ...parsed,
+        description: parsed.description || message
+      };
+    }
+    return null;
+  } catch {
+    return null;
+  }
+}
+function formatLocation(filePath, line, column, endLine, endColumn) {
+  const relativePath = path2.relative(process.cwd(), filePath);
+  const endPos = endLine ? `-${endLine}:${endColumn || ""}` : "";
+  return `${relativePath}:${line}:${column}${endPos}`;
+}
+function formatText(results) {
+  return results.filter((r) => r.filePath && r.messages?.length > 0).flatMap(
+    (r) => r.messages.map((msg) => {
+      const { ruleId, message, line, column, endLine, endColumn } = msg;
+      const parsed = tryParseMessage(message);
+      if (!parsed) {
+        return [
+          source_default.cyan(formatLocation(r.filePath, line, column, endLine, endColumn)),
+          source_default.yellow(`Rule: ${ruleId}`),
+          source_default.white(`Description: ${message}`)
+        ].join("\n");
+      }
+      const ruleName = ruleId?.includes("/") ? ruleId.split("/")[1] : ruleId;
+      const lines = [
+        source_default.cyan(formatLocation(r.filePath, line, column, endLine, endColumn)),
+        source_default.yellow(`Rule: ${ruleName}`),
+        source_default.white(`Description: ${parsed.description}`),
+        parsed.help && source_default.green(`Help: ${parsed.help}`),
+        parsed.failureSummary && source_default.magenta(`Failure Summary: ${parsed.failureSummary}`)
+      ];
+      return lines.filter(Boolean).join("\n");
+    })
+  ).join("\n\n");
+}
+function formatXcode(results) {
+  return results.filter((r) => r.filePath && r.messages?.length > 0).flatMap(
+    (r) => r.messages.map((msg) => {
+      const { ruleId, message, line, column, severity } = msg;
+      const parsed = tryParseMessage(message);
+      const type = severity === 2 ? "error" : "warning";
+      let text;
+      if (parsed) {
+        const { description, failureSummary, ruleName } = parsed;
+        const finalM = [description];
+        if (ruleName) {
+          finalM.unshift(`${ruleName}: `);
+        }
+        if (failureSummary && failureSummary.trim().length > 0 && !["not applicable", "na", "n/a"].includes(failureSummary.toLowerCase())) {
+          finalM.push(
+            " ".repeat(600),
+            // blank line
+            "\u2800",
+            " ".repeat(600),
+            // blank line
+            "How to fix:",
+            " ".repeat(600),
+            // End the How to fix last line
+            failureSummary ?? "",
+            " ".repeat(600),
+            // blank line
+            "\u2800",
+            " ".repeat(600)
+            // blank line
+          );
+        }
+        finalM.push(`(Browserstack Accessibility DevTools/${ruleId.split("/")[1]})`);
+        text = finalM.join("");
+      } else {
+        text = message;
+      }
+      const fileRelative = path2.relative(process.cwd(), r.filePath);
+      return `${fileRelative}:${line}:${column}: ${type}: ${text}`;
+    })
+  ).join("\n");
+}
+function formatResults(results, format) {
+  switch (format) {
+    case "xcode":
+      return formatXcode(results);
+    // case 'junit':
+    //   return formatJUnit(results);
+    // case 'json':
+    //   return formatJson(results);
+    case "text":
+    default:
+      return formatText(results);
+  }
+}
+
 // src/index.ts
 var EXIT_CODES = {
   SUCCESS: 0,
@@ -8624,49 +8724,6 @@ var mockLogger = {
   log: () => {
   }
 };
-function safeParseMessage(message) {
-  try {
-    const { description, help, failureSummary } = JSON.parse(message);
-    return {
-      success: true,
-      data: {
-        description: description || message,
-        help: help || "",
-        failureSummary: failureSummary || ""
-      }
-    };
-  } catch {
-    return { success: false, error: "Invalid JSON message" };
-  }
-}
-function formatLocation(filePath, line, column, endLine, endColumn) {
-  const relativePath = path.relative(process.cwd(), filePath);
-  const endPos = endLine ? `-${endLine}:${endColumn || ""}` : "";
-  return `${relativePath}:${line}:${column}${endPos}`;
-}
-function formatMessage(msg, filePath) {
-  const { ruleId, message, severity, line, column, endLine, endColumn } = msg;
-  const parsed = safeParseMessage(message);
-  if (!parsed.success) {
-    return [
-      source_default.cyan(formatLocation(filePath, line, column, endLine, endColumn)),
-      source_default.yellow(`Rule: ${ruleId}`),
-      source_default.white(`Description: ${message}`)
-    ].join("\n");
-  }
-  const { description, help, failureSummary } = parsed.data;
-  const lines = [
-    source_default.cyan(formatLocation(filePath, line, column, endLine, endColumn)),
-    source_default.yellow(`Rule: ${ruleId.split("/")[1]}`),
-    source_default.white(`Description: ${description}`),
-    help && source_default.green(`Help: ${help}`),
-    failureSummary && source_default.magenta(`Failure Summary: ${failureSummary}`)
-  ];
-  return lines.filter(Boolean).join("\n");
-}
-function formatResults(results) {
-  return results.filter((result) => result.filePath && result.messages?.length > 0).flatMap((result) => result.messages.map((msg) => formatMessage(msg, result.filePath))).filter(Boolean).join("\n\n");
-}
 async function initializeAndAuthenticate(linterClient, args) {
   const { browserstackUsername, browserstackAccessKey } = args;
   if (!browserstackUsername || !browserstackAccessKey) {
@@ -8678,22 +8735,29 @@ async function initializeAndAuthenticate(linterClient, args) {
   try {
     const linterInitResult = await linterClient.initialize();
     if (linterInitResult instanceof Error) {
-      return { success: false, error: "Unable to connect to BrowserStack backend" };
+      return {
+        success: false,
+        error: "Unable to connect to BrowserStack. Please check your network connection."
+      };
     }
     const userProfile = await linterClient.authenticate(
       browserstackUsername,
       browserstackAccessKey
     );
     if (!userProfile || typeof userProfile.id !== "string") {
-      return { success: false, error: "Authentication failed. Please check your credentials." };
+      return {
+        success: false,
+        error: "Unable to authenticate. Please check your credentials or plan."
+      };
     }
     return { success: true, data: userProfile };
   } catch (e) {
-    return { success: false, error: e instanceof Error ? e.message : String(e) };
+    return { success: false, error: "Something went wrong on our end. Please try again later." };
   }
 }
 function computeAnalytics(fileTimings, ruleCounts, perFileRuleRates, totalTimeTaken) {
   return {
+    source: "cli",
     rule_counts: ruleCounts,
     averages: {
       per_file: fileTimings.length ? Math.round(fileTimings.reduce((a, b) => a + b, 0) / fileTimings.length) : 0,
@@ -8704,6 +8768,23 @@ function computeAnalytics(fileTimings, ruleCounts, perFileRuleRates, totalTimeTa
     total_time_taken: totalTimeTaken
   };
 }
+function inferOutputFormat(args) {
+  const {
+    XCODE_PRODUCT_BUILD_VERSION,
+    XCODE_VERSION_MAJOR,
+    XCODE_VERSION_MINOR,
+    XCODE_VERSION_ACTUAL,
+    XCODE_APP_SUPPORT_DIR
+  } = process.env;
+  switch (true) {
+    case Boolean(
+      XCODE_APP_SUPPORT_DIR || XCODE_PRODUCT_BUILD_VERSION || XCODE_VERSION_MAJOR || XCODE_VERSION_MINOR || XCODE_VERSION_ACTUAL
+    ):
+      return "xcode";
+    default:
+      return "text";
+  }
+}
 async function main(args) {
   const linterClient = import_linterClient.default.getInstance({
     linterServerAddress: LINTER_SERVER_ADDRESS,
@@ -8728,9 +8809,14 @@ async function main(args) {
     process.exit(EXIT_CODES.SUCCESS);
   }
   if (fileList.some((file) => !linterClient.isFileExtensionSupported(file))) {
+    const unsupportedExtensions = Array.from(
+      new Set(
+        fileList.filter((file) => !linterClient.isFileExtensionSupported(file)).map((file) => path.extname(file))
+      )
+    ).join(", ");
     console.error(
       source_default.red(
-        `Error: Unsupported file types. Supported extensions are: ${linterClient.getSupportedFileExtensions().join(", ")}`
+        `{${unsupportedExtensions}} is not supported. Supported file types are ${linterClient.getSupportedFileExtensions().join(", ")}`
       )
     );
     process.exit(1);
@@ -8776,7 +8862,7 @@ async function main(args) {
     console.log(source_default.green("No accessibility violations found! Awesome!"));
     process.exit(EXIT_CODES.SUCCESS);
   }
-  console.log(formatResults(lintResultsFlat));
+  console.log(formatResults(lintResultsFlat, inferOutputFormat(args)));
   process.exit(
     lintResultsFlat.length > 0 ? args.nonStrict ? EXIT_CODES.SUCCESS : EXIT_CODES.FAILURE : EXIT_CODES.SUCCESS
   );

package/package.json

@@ -2,7 +2,7 @@
   "name": "@browserstack/accessibility-devtools-cli",
   "displayName": "BrowserStack Accessibility Linter CLI (Beta)",
   "description": "Command-line interface for BrowserStack Accessibility Linter",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "main": "./index.js",
   "author": {
     "name": "Rishabh Jain",
@@ -17,4 +17,4 @@
   "scripts": {},
   "devDependencies": {},
   "dependencies": {}
-}
+}