Merge pull request #364 from dudeofawesome/feat/reporters

✨ add support for additional test reporters

.gitignore

@@ -1,2 +1,3 @@
 node_modules
 .tern-port
+junit.xml

markdown-link-check

@@ -4,7 +4,8 @@
 
 let chalk;
 const fs = require('fs');
-const markdownLinkCheck = require('./');
+const { promisify } = require('util');
+const markdownLinkCheck = promisify(require('./'));
 const needle = require('needle');
 const path = require('path');
 const pkg = require('./package.json');
@@ -30,6 +31,10 @@ function commaSeparatedCodesList(value, dummyPrevious) {
     });
 }
 
+function commaSeparatedReportersList(value) {
+    return value.split(',').map((reporter) => require(path.resolve('reporters', reporter)));
+}
+
 function getInputs() {
     const inputs = [];
 
@@ -42,6 +47,7 @@ function getInputs() {
         .option('-i --ignore <paths>', 'ignore input paths including an ignore path', commaSeparatedPathsList)
         .option('-a, --alive <code>', 'comma separated list of HTTP codes to be considered as alive', commaSeparatedCodesList)
         .option('-r, --retry', 'retry after the duration indicated in \'retry-after\' header when HTTP code is 429')
+        .option('--reporters <names>', 'specify reporters to use', commaSeparatedReportersList)
         .option('--projectBaseUrl <url>', 'the URL to use for {{BASEURL}} replacement')
         .arguments('[filenamesOrUrls...]')
         .action(function (filenamesOrUrls) {
@@ -121,6 +127,7 @@ function getInputs() {
         input.opts.verbose = (program.opts().verbose === true);
         input.opts.retryOn429 = (program.opts().retry === true);
         input.opts.aliveStatusCodes = program.opts().alive;
+        input.opts.reporters = program.opts().reporters ?? [require(path.resolve('reporters', 'default.js'))];
         const config = program.opts().config;
         if (config) {
             input.opts.config = config.trim();
@@ -195,68 +202,23 @@ async function processInput(filenameForOutput, stream, opts) {
         opts.retryCount = config.retryCount;
         opts.fallbackRetryDelay = config.fallbackRetryDelay;
         opts.aliveStatusCodes = config.aliveStatusCodes;
+        opts.reporters = config.reporters;
     }
 
     await runMarkdownLinkCheck(filenameForOutput, markdown, opts);
 }
 
 async function runMarkdownLinkCheck(filenameForOutput, markdown, opts) {
-    const statusLabels = {
-        alive: chalk.green('✓'),
-        dead: chalk.red('✖'),
-        ignored: chalk.gray('/'),
-        error: chalk.yellow('⚠'),
-    };
-
-    return new Promise((resolve, reject) => {
-        markdownLinkCheck(markdown, opts, function (err, results) {
-            if (err) {
-                console.error(chalk.red('\n  ERROR: something went wrong!'));
-                console.error(err.stack);
-                reject();
-            }
-
-            if (results.length === 0 && !opts.quiet) {
-                console.log(chalk.yellow('  No hyperlinks found!'));
-            }
-            results.forEach(function (result) {
-                // Skip messages for non-deadlinks in quiet mode.
-                if (opts.quiet && result.status !== 'dead') {
-                    return;
-                }
-
-                if (opts.verbose) {
-                    if (result.err) {
-                        console.log('  [%s] %s → Status: %s %s', statusLabels[result.status], result.link, result.statusCode, result.err);
-                    } else {
-                        console.log('  [%s] %s → Status: %s', statusLabels[result.status], result.link, result.statusCode);
-                    }
-                }
-                else if(!opts.quiet) {
-                    console.log('  [%s] %s', statusLabels[result.status], result.link);
-                }
-            });
+    const [err, results] = await markdownLinkCheck(markdown, opts)
+        .then(res => [null, res]).catch(err => [err]);
 
-            if(!opts.quiet){
-                console.log('\n  %s links checked.', results.length);
-            }
-
-            if (results.some((result) => result.status === 'dead')) {
-                let deadLinks = results.filter(result => { return result.status === 'dead'; });
-                if(!opts.quiet){
-                    console.error(chalk.red('\n  ERROR: %s dead links found!'), deadLinks.length);
-                } else {
-                    console.error(chalk.red('\n  ERROR: %s dead links found in %s !'), deadLinks.length, filenameForOutput);
-                }
-                deadLinks.forEach(function (result) {
-                    console.log('  [%s] %s → Status: %s', statusLabels[result.status], result.link, result.statusCode);
-                });
-                reject();
-            }
+    await Promise.allSettled(
+        opts.reporters.map(reporter => reporter(err, results, opts, filenameForOutput)
+    ));
 
-            resolve();
-        });
-    });
+    if (err) throw null;
+    else if (results.some((result) => result.status === 'dead')) return;
+    else return;
 }
 
 async function main() {

package.json

@@ -40,7 +40,8 @@
     "markdown-link-extractor": "^4.0.2",
     "needle": "^3.3.1",
     "progress": "^2.0.3",
-    "proxy-agent": "^6.4.0"
+    "proxy-agent": "^6.4.0",
+    "xmlbuilder2": "^3.1.1"
   },
   "devDependencies": {
     "@eslint/js": "^9.3.0",

reporters/default.js

@@ -0,0 +1,59 @@
+module.exports = async function defaultReporter(err, results, opts, filenameForOutput) {
+    const chalk = (await import('chalk')).default
+
+    const statusLabels = {
+        alive: chalk.green('✓'),
+        dead: chalk.red('✖'),
+        ignored: chalk.gray('/'),
+        error: chalk.yellow('⚠'),
+    };
+
+    if (err) {
+        console.error(chalk.red("\n  ERROR: something went wrong!"));
+        console.error(err.stack);
+    }
+
+    if (results.length === 0 && !opts.quiet) {
+        console.log(chalk.yellow("  No hyperlinks found!"));
+    }
+    results.forEach(function (result) {
+        // Skip messages for non-deadlinks in quiet mode.
+        if (opts.quiet && result.status !== "dead") {
+            return;
+        }
+
+        if (opts.verbose) {
+            if (result.err) {
+                console.log(
+                    "  [%s] %s → Status: %s %s",
+                    statusLabels[result.status],
+                    result.link,
+                    result.statusCode,
+                    result.err
+                );
+            } else {
+                console.log("  [%s] %s → Status: %s", statusLabels[result.status], result.link, result.statusCode);
+            }
+        } else if (!opts.quiet) {
+            console.log("  [%s] %s", statusLabels[result.status], result.link);
+        }
+    });
+
+    if (!opts.quiet) {
+        console.log("\n  %s links checked.", results.length);
+    }
+
+    if (results.some((result) => result.status === "dead")) {
+        let deadLinks = results.filter((result) => {
+            return result.status === "dead";
+        });
+        if (!opts.quiet) {
+            console.error(chalk.red("\n  ERROR: %s dead links found!"), deadLinks.length);
+        } else {
+            console.error(chalk.red("\n  ERROR: %s dead links found in %s !"), deadLinks.length, filenameForOutput);
+        }
+        deadLinks.forEach(function (result) {
+            console.log("  [%s] %s → Status: %s", statusLabels[result.status], result.link, result.statusCode);
+        });
+    }
+};