feat: upgrade to linkinator 7.4 and add statusCodes and redirects options (#216)

* feat: upgrade to linkinator 7.4 and add statusCodes and redirects options

This update brings linkinator to version 7.4.0 and exposes new configuration
options for more flexible link validation:

- statusCodes: Map HTTP status codes to actions (ok, warn, skip, error)
  with support for patterns like 4xx and 5xx
- redirects: Configure how to handle HTTP redirects (allow, warn, or error)

The new options enable users to customize which status codes should be
treated as errors, warnings, or skipped, providing greater control over
link validation behavior.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* npm run build

---------

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: BeckwithRobot <justin.beckwith+beckwithrobot@gmail.com>

Author: 3 people

README.md

@@ -66,6 +66,8 @@ jobs:
 - `cleanUrls` - Enable support for clean URLs (extensionless paths). Allows validation of URLs without file extensions, useful for modern static hosting. Defaults to `false`.
 - `checkCss` - Enable parsing and extraction of URLs from CSS files, style blocks, and inline styles. Defaults to `false`.
 - `checkFragments` - Enable validation of fragment identifiers (anchor links) on HTML pages. Defaults to `false`.
+- `statusCodes` - JSON object mapping HTTP status codes to actions (`ok`, `warn`, `skip`, `error`). Supports patterns like `4xx` or `5xx`. Example: `{"404": "error", "5xx": "warn", "301": "ok"}`.
+- `redirects` - How to handle HTTP redirects. Options: `allow` (default), `warn`, or `error`.
 - `urlRewriteSearch` - Pattern to search for in urls.  Must be used with `urlRewriteReplace`.
 - `urlRewriteReplace` - Expression used to replace search content.  Must be used with `urlRewriteSearch`.
 - `verbosity` - Override the default verbosity for this command. Available options are "DEBUG", "INFO", "WARNING", "ERROR", and "NONE".  Defaults to "WARNING".

action.yml

@@ -90,6 +90,13 @@ inputs:
     description: Enable validation of fragment identifiers (anchor links) on HTML pages.
     default: 'false'
     required: false
+  statusCodes:
+    description: JSON object mapping HTTP status codes to actions (ok, warn, skip, error). Supports patterns like 4xx or 5xx. Example - {"404":"error","5xx":"warn"}
+    required: false
+  redirects:
+    description: How to handle HTTP redirects. Options - "allow" (default), "warn", or "error".
+    default: 'allow'
+    required: false
 outputs:
   results:
     description: 'The full results of the scan.'

dist/index.cjs

@@ -35394,6 +35394,30 @@ async function bufferStream(stream2) {
   return Buffer.concat(chunks);
 }
 
+// node_modules/linkinator/build/src/url-utils.js
+function normalizeBaseUrl(baseUrl, cleanUrls = false) {
+  if (cleanUrls) {
+    return baseUrl;
+  }
+  try {
+    const url = new URL(baseUrl);
+    const pathname = url.pathname;
+    if (pathname.endsWith("/")) {
+      return baseUrl;
+    }
+    const lastSegment = pathname.split("/").pop() || "";
+    const hasExtension = lastSegment.includes(".") && lastSegment.indexOf(".") > 0;
+    const isCommonPageName = ["index", "default", "home", "main"].includes(lastSegment.toLowerCase());
+    if (!hasExtension && !isCommonPageName) {
+      url.pathname = `${pathname}/`;
+      return url.href;
+    }
+    return baseUrl;
+  } catch {
+    return baseUrl;
+  }
+}
+
 // node_modules/linkinator/build/src/config.js
 var import_node_fs3 = require("node:fs");
 var import_node_path4 = __toESM(require("node:path"), 1);
@@ -35710,7 +35734,23 @@ var LinkChecker = class extends import_node_events3.EventEmitter {
       return;
     }
     const redirect = detectRedirect(status, originalUrl, response);
-    if (status === 999) {
+    const customAction = getStatusCodeAction(status, options.checkOptions.statusCodes);
+    if (customAction === "ok") {
+      state = LinkState.OK;
+    } else if (customAction === "warn") {
+      state = LinkState.OK;
+      this.emit("statusCodeWarning", {
+        url: originalUrl,
+        status
+      });
+    } else if (customAction === "skip") {
+      state = LinkState.SKIPPED;
+    } else if (customAction === "error") {
+      state = LinkState.BROKEN;
+      if (response !== void 0) {
+        failures.push(response);
+      }
+    } else if (status === 999) {
       state = LinkState.SKIPPED;
     } else if (status === 403 && response !== void 0 && response.headers["cf-mitigated"]) {
       state = LinkState.SKIPPED;
@@ -35799,7 +35839,10 @@ var LinkChecker = class extends import_node_events3.EventEmitter {
       let urlResults = [];
       if (response?.body) {
         const nodeStream = toNodeReadable(response.body);
-        const baseUrl = response.url || options.url.href;
+        let baseUrl = response.url || options.url.href;
+        if (isHtml(response)) {
+          baseUrl = normalizeBaseUrl(baseUrl, options.checkOptions.cleanUrls);
+        }
         if (isHtml(response)) {
           urlResults = await getLinks(nodeStream, baseUrl, options.checkOptions.checkCss);
         } else if (isCss(response) && options.checkOptions.checkCss) {
@@ -36055,6 +36098,32 @@ async function makeRequest(method, url, options = {}) {
     url: response.url
   };
 }
+function matchesStatusCodePattern(status, pattern) {
+  if (pattern === status.toString()) {
+    return true;
+  }
+  if (pattern.endsWith("xx") && pattern.length === 3) {
+    const firstDigit = pattern[0];
+    const statusFirstDigit = Math.floor(status / 100).toString();
+    return firstDigit === statusFirstDigit;
+  }
+  return false;
+}
+function getStatusCodeAction(status, statusCodes) {
+  if (!statusCodes) {
+    return void 0;
+  }
+  const exactMatch = statusCodes[status.toString()];
+  if (exactMatch) {
+    return exactMatch;
+  }
+  for (const [pattern, action] of Object.entries(statusCodes)) {
+    if (matchesStatusCodePattern(status, pattern)) {
+      return action;
+    }
+  }
+  return void 0;
+}
 function detectRedirect(status, originalUrl, response) {
   const isRedirectStatus = status >= 300 && status < 400;
   const urlChanged = response?.url && response.url !== originalUrl;
@@ -36087,7 +36156,8 @@ async function getFullConfig() {
     requireHttps: false,
     cleanUrls: false,
     checkCss: false,
-    checkFragments: false
+    checkFragments: false,
+    redirects: "allow"
   };
   const actionsConfig = {
     path: parseList("paths"),
@@ -36109,7 +36179,9 @@ async function getFullConfig() {
     requireHttps: parseBoolean("requireHttps"),
     cleanUrls: parseBoolean("cleanUrls"),
     checkCss: parseBoolean("checkCss"),
-    checkFragments: parseBoolean("checkFragments")
+    checkFragments: parseBoolean("checkFragments"),
+    statusCodes: parseJSON("statusCodes"),
+    redirects: parseString("redirects")
   };
   const urlRewriteSearch = parseString("urlRewriteSearch");
   const urlRewriteReplace = parseString("urlRewriteReplace");
@@ -36290,6 +36362,17 @@ function parseBoolean(input) {
   }
   return void 0;
 }
+function parseJSON(input) {
+  const value = import_core.default.getInput(input) || void 0;
+  if (value) {
+    try {
+      return JSON.parse(value);
+    } catch (err) {
+      throw new Error(`Invalid JSON for ${input}: ${err.message}`);
+    }
+  }
+  return void 0;
+}
 function getVerbosity(verbosity) {
   verbosity = verbosity.toUpperCase();
   const options = Object.keys(LogLevel);

dist/index.cjs.map

@@ -30,7 +30,7 @@
   "homepage": "https://github.com/JustinBeckwith/linkinator-action#readme",
   "dependencies": {
     "@actions/core": "^1.11.1",
-    "linkinator": "^7.3.0"
+    "linkinator": "^7.4.0"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.2.7",

package-lock.json

@@ -20,6 +20,7 @@ export async function getFullConfig() {
     cleanUrls: false,
     checkCss: false,
     checkFragments: false,
+    redirects: 'allow',
   };
   // The options returned from `getInput` appear to always be strings.
   const actionsConfig = {
@@ -43,6 +44,8 @@ export async function getFullConfig() {
     cleanUrls: parseBoolean('cleanUrls'),
     checkCss: parseBoolean('checkCss'),
     checkFragments: parseBoolean('checkFragments'),
+    statusCodes: parseJSON('statusCodes'),
+    redirects: parseString('redirects'),
   };
   const urlRewriteSearch = parseString('urlRewriteSearch');
   const urlRewriteReplace = parseString('urlRewriteReplace');
@@ -254,6 +257,18 @@ function parseBoolean(input) {
   return undefined;
 }
 
+function parseJSON(input) {
+  const value = core.getInput(input) || undefined;
+  if (value) {
+    try {
+      return JSON.parse(value);
+    } catch (err) {
+      throw new Error(`Invalid JSON for ${input}: ${err.message}`);
+    }
+  }
+  return undefined;
+}
+
 function getVerbosity(verbosity) {
   verbosity = verbosity.toUpperCase();
   const options = Object.keys(LogLevel);

package.json

@@ -372,6 +372,37 @@ describe('linkinator action', () => {
     assert.ok(inputStub.called);
   });
 
+  it('should handle statusCodes option', async () => {
+    const inputStub = sinon.stub(core, 'getInput');
+    inputStub.withArgs('paths').returns('test/fixtures/test.md');
+    inputStub.withArgs('statusCodes').returns('{"404":"error","5xx":"warn"}');
+    inputStub.returns('');
+    const config = await getFullConfig();
+    assert.deepStrictEqual(config.statusCodes, { '404': 'error', '5xx': 'warn' });
+    assert.ok(inputStub.called);
+  });
+
+  it('should handle redirects option', async () => {
+    const inputStub = sinon.stub(core, 'getInput');
+    inputStub.withArgs('paths').returns('test/fixtures/test.md');
+    inputStub.withArgs('redirects').returns('warn');
+    inputStub.returns('');
+    const config = await getFullConfig();
+    assert.strictEqual(config.redirects, 'warn');
+    assert.ok(inputStub.called);
+  });
+
+  it('should throw for invalid statusCodes JSON', async () => {
+    const inputStub = sinon.stub(core, 'getInput');
+    inputStub.withArgs('paths').returns('test/fixtures/test.md');
+    inputStub.withArgs('statusCodes').returns('{invalid json}');
+    inputStub.returns('');
+    await assert.rejects(
+      async () => await getFullConfig(),
+      /Invalid JSON for statusCodes/
+    );
+  });
+
   it('should handle branch names with slashes in URL rewriting', async () => {
     stubSummary();
     sinon.stub(process, 'env').value({