astro-broken-links-checker 1.0.3

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,53 @@
+# Astro Broken Links Checker
+
+An Astro integration that checks for broken links in your website during static build. It logs any broken links to the console and writes them to a file, grouping them by the document in which they occur.
+
+## Goals
+
+- **Checks Internal and External Links**: Validates all `<a href="...">` links found in your HTML pages.
+- **Logs Broken Links**: Outputs broken link information to both the console and a log file.
+- **Grouped by broken URL**: To allow for quick search and replacement, a list of all pages containing the broken URL is logged.
+- **Caching Mechanism**: Avoids redundant checks by caching the results of previously checked links, both internal and external, whether they are valid or not.
+- **Parallel Processing**: Checks links and does IO and network operations in parallel to improve performance. We first collect all links from all pages, then only check each once, first loading the tsv cache, then saving it again when we are done. All http requests happen in parallel.
+- **Local redirect awareness**: If a link is redirected in astro.config.mjs, it will be followed.
+- **Timeouts and retries**: To avoid false positives, links that fail to load with ECONNRESET are retried 3 times with exponential backoff. Timeouts are set to 3 second max including retries.
+- **Link text preservation**: The contents of "href" are only normalized to a domain-relative path (like /foo/bar/) if they are "../relative" or "./relative" or "relative" etc. It is otherwise preserved for reporting purposes.
+- **Cross-platform compatibility**: The physical paths of the html files are normalized to domain relative paths.
+- **Disk caching of remote links**: To speed up subsequent builds, a tab-delimited text file is optionally written to disk containing the contents of all remote links checked and the status code returned by the server, in the form URL<tab>ok/failed<tab>status code<tab>ISO-8601-formatted timestamp.
+
+
+
+
+## Installation
+
+Install the package using npm:
+
+```bash
+npm install astro-broken-links-checker
+```
+
+> [!NOTE]
+> You can also install from GitHub if you need the latest development version:
+> ```json
+>   "dependencies": {
+>     "astro": "5.16.6",
+>     "astro-broken-links-checker": "imazen/astro-broken-link-checker"
+>   }
+> ```
+
+Finally, update your `astro.config.mjs`
+```js
+import { defineConfig } from 'astro/config';
+import astroBrokenLinksChecker from 'astro-broken-link-checker';
+
+export default defineConfig({
+  // ... other configurations ...
+  integrations: [
+    astroBrokenLinksChecker({
+      logFilePath: 'broken-links.log', // Optional: specify the log file path
+      checkExternalLinks: false, // Optional: check external links (currently, caching to disk is not supported, and it is slow)
+      throwError: true // Optional: throw an error to fail the build if broken links are found. Defaults to false.
+    }),
+  ],
+});
+```

package/check-links.js

@@ -0,0 +1,186 @@
+import {parse} from 'node-html-parser';
+import fs from 'fs';
+import fetch from 'node-fetch';
+import {URL, fileURLToPath} from 'url';
+import path from 'path';
+import pLimit from 'p-limit';
+
+export async function checkLinksInHtml(
+  htmlContent,
+  brokenLinksMap,
+  baseUrl,
+  documentPath,
+  checkedLinks = new Map(),
+  distPath = '',
+  astroConfigRedirects = {},
+  logger,
+  checkExternalLinks = true,
+  trailingSlash = 'ignore',
+) {
+  const root = parse(htmlContent);
+  const linkElements = root.querySelectorAll('a[href]');
+  const links = linkElements.map((el) => el.getAttribute('href'));
+  // add img src
+  const imgElements = root.querySelectorAll('img[src]');
+  const imgLinks = imgElements.map((el) => el.getAttribute('src'));
+  links.push(...imgLinks);
+
+  const limit = pLimit(50); // Limit to 10 concurrent link checks
+
+  const checkLinkPromises = links.map((link) =>
+    limit(async () => {
+      if (!isValidUrl(link)) {
+        return;
+      }
+
+      let absoluteLink;
+      try {
+        // Differentiate between absolute, domain-relative, and relative links
+        if (/^https?:\/\//i.test(link) || /^:\/\//i.test(link)) {
+          // Absolute URL
+          absoluteLink = link;
+        } else {
+          absoluteLink = new URL(link, "https://localhost" + baseUrl).pathname;
+          // if (link !== absoluteLink) {
+          //   logger.info(`Link ${link} was resolved to ${absoluteLink}`);
+          // }
+        }
+      } catch (err) {
+        // Invalid URL, skip
+        logger.error(`Invalid URL in ${normalizePath(documentPath)} ${link} ${err}`);
+        return;
+      }
+
+      let fetchLink = link;
+      if (absoluteLink.startsWith('/') && distPath) {
+        fetchLink = absoluteLink;
+      }
+
+      if (astroConfigRedirects[fetchLink]) {
+        // Check if the link is a redirect
+        const redirect = astroConfigRedirects[fetchLink];
+        if (redirect) {
+          fetchLink = redirect.destination ? redirect.destination : redirect;
+        }
+      }
+
+      if (checkedLinks.has(fetchLink)) {
+        const isBroken = !checkedLinks.get(fetchLink);
+        if (isBroken) {
+          addBrokenLink(brokenLinksMap, documentPath, link, distPath);
+        }
+        return;
+      }
+
+      let isBroken = false;
+
+      if (fetchLink.startsWith('/') && distPath) {
+        // Internal link in build mode, check if file exists
+        const relativePath = fetchLink;
+        // Potential file paths to check
+        const possiblePaths = [
+          path.join(distPath, relativePath),
+          path.join(distPath, relativePath, 'index.html'),
+          path.join(distPath, `${relativePath}.html`),
+        ];
+
+        // Check if any of the possible paths exist
+        if (!possiblePaths.some((p) => fs.existsSync(p))) {
+          // console.log('Failed paths', possiblePaths);
+          isBroken = true;
+          // Fall back to checking a redirect file if it exists.
+        }
+
+        // check trailing slash is correct on internal links
+        const re = /\/$|\.[a-z0-9]+$/;  // match trailing slash or file extension
+        if (trailingSlash === 'always' && !fetchLink.match(re)) {
+          isBroken = true;
+        } else if (trailingSlash === 'never' && fetchLink !== '/' && fetchLink.endsWith('/')) {
+          isBroken = true;
+        }
+      } else {
+        // External link, check via HTTP request. Retry 3 times if ECONNRESET
+        if (checkExternalLinks) {
+          let retries = 0;
+          while (retries < 3) {
+            try {
+              const response = await fetch(fetchLink, {method: 'GET'});
+              isBroken = !response.ok;
+              if (isBroken) {
+                logger.error(`${response.status} Error fetching ${fetchLink}`);
+              }
+              break;
+            } catch (error) {
+              isBroken = true;
+              let statusCodeNumber = error.errno === 'ENOTFOUND' ? 404 : (error.errno);
+              logger.error(`${statusCodeNumber} error fetching ${fetchLink}`);
+              if (error.errno === 'ECONNRESET') {
+                retries++;
+                continue;
+              }
+              break;
+            }
+          }
+        }
+      }
+
+      // Cache the link's validity
+      checkedLinks.set(fetchLink, !isBroken);
+      checkedLinks.set(absoluteLink, !isBroken);
+
+      if (isBroken) {
+        addBrokenLink(brokenLinksMap, documentPath, link, distPath);
+      }
+    })
+  );
+
+  await Promise.all(checkLinkPromises);
+}
+
+function isValidUrl(url) {
+  // Skip mailto:, tel:, javascript:, and empty links
+  return !(
+    url.startsWith('mailto:') ||
+    url.startsWith('tel:') ||
+    url.startsWith('javascript:') ||
+    url.startsWith('#') ||
+    url.trim() === ''
+  );
+}
+
+function normalizePath(p) {
+  p = p.toString();
+  // Remove query parameters and fragments
+  p = p.split('?')[0].split('#')[0];
+
+  // Remove '/index.html' or '.html' suffixes
+  if (p.endsWith('/index.html')) {
+    p = p.slice(0, -'index.html'.length);
+  } else if (p.endsWith('.html')) {
+    p = p.slice(0, -'.html'.length);
+  }
+
+  // Ensure leading '/'
+  if (!p.startsWith('/')) {
+    p = '/' + p;
+  }
+
+  return p;
+}
+
+export function normalizeHtmlFilePath(filePath, distPath = '') {
+  return normalizePath(distPath ? path.relative(distPath, filePath) : filePath);
+}
+
+function addBrokenLink(brokenLinksMap, documentPath, brokenLink, distPath) {
+  // Normalize document path
+  documentPath = normalizeHtmlFilePath(documentPath, distPath);
+
+  // Normalize broken link for reporting
+  let normalizedBrokenLink = brokenLink;
+
+  if (!brokenLinksMap.has(normalizedBrokenLink)) {
+    brokenLinksMap.set(normalizedBrokenLink, new Set());
+  }
+  brokenLinksMap.get(normalizedBrokenLink).add(documentPath);
+}

package/index.js

@@ -0,0 +1,91 @@
+import {fileURLToPath} from 'url';
+import {join} from 'path';
+import fs from 'fs';
+import {checkLinksInHtml, normalizeHtmlFilePath} from './check-links.js';
+import fastGlob from 'fast-glob';
+
+export default function astroBrokenLinksChecker(options = {}) {
+  const logFilePath = options.logFilePath || 'broken-links.log';
+  const brokenLinksMap = new Map(); // Map of brokenLink -> Set of documents
+  const checkedLinks = new Map();
+
+  return {
+    name: 'astro-broken-links-checker',
+    hooks: {
+      'astro:config:setup': async ({config}) => {
+        //console.log('config.redirects', config.redirects);
+        // save the redirects to the options
+        options.astroConfigRedirects = config.redirects;
+
+        // use astro trailingSlash setting, falling back to astro default of 'ignore'
+        options.trailingSlash = config.trailingSlash || 'ignore';
+      },
+
+      'astro:build:done': async ({dir, logger}) => {
+        const astroConfigRedirects = options.astroConfigRedirects;
+        //console.log('astroConfigRedirects', astroConfigRedirects);
+        const distPath = fileURLToPath(dir);
+        const htmlFiles = await fastGlob('**/*.html', {cwd: distPath});
+        logger.info(`Checking ${htmlFiles.length} html pages for broken links`);
+        // start time
+        const startTime = Date.now();
+        const checkHtmlPromises = htmlFiles.map(async (htmlFile) => {
+          const absoluteHtmlFilePath = join(distPath, htmlFile);
+          const htmlContent = fs.readFileSync(absoluteHtmlFilePath, 'utf8');
+          const baseUrl = normalizeHtmlFilePath(absoluteHtmlFilePath, distPath);
+          await checkLinksInHtml(
+            htmlContent,
+            brokenLinksMap,
+            baseUrl,
+            absoluteHtmlFilePath, // Document path
+            checkedLinks,
+            distPath,
+            astroConfigRedirects,
+            logger,
+            options.checkExternalLinks,
+            options.trailingSlash,
+          );
+        });
+
+        await Promise.all(checkHtmlPromises);
+        logBrokenLinks(brokenLinksMap, logFilePath, logger);
+
+        // end time
+        const endTime = Date.now();
+        logger.info(`Time to check links: ${endTime - startTime} ms`);
+
+        // stop the build if we have broken links and the option is set
+        if (options.throwError && brokenLinksMap.size > 0) {
+          throw new Error(`Broken links detected. Check the log file: ${logFilePath}`);
+        }
+      },
+    },
+  };
+}
+
+function logBrokenLinks(brokenLinksMap, logFilePath, logger) {
+  if (brokenLinksMap.size > 0) {
+    let logData = '';
+    for (const [brokenLink, documentsSet] of brokenLinksMap.entries()) {
+      const documents = Array.from(documentsSet);
+      logData += `Broken link: ${brokenLink}\n  Found in:\n`;
+      for (const doc of documents) {
+        logData += `    - ${doc}\n`;
+      }
+    }
+    logData = logData.trim();
+    if (logFilePath) {
+      fs.writeFileSync(logFilePath, logData, 'utf8');
+      logger.info(`Broken links have been logged to ${logFilePath}`);
+      logger.info(logData);
+    } else {
+      logger.info(logData);
+    }
+  } else {
+    logger.info('No broken links detected.');
+    if (fs.existsSync(logFilePath)) {
+      logger.info('Removing old log file:', logFilePath);
+      fs.rmSync(logFilePath);
+    }
+  }
+}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "astro-broken-links-checker",
+  "version": "1.0.3",
+  "description": "An Astro integration to check for broken links in your website during development and build time.",
+  "main": "index.js",
+  "type": "module",
+  "exports": {
+    ".": "./index.js"
+  },
+  "files": [
+    "index.js",
+    "check-links.js",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "astro",
+    "astro-integration",
+    "broken-links",
+    "link-checker"
+  ],
+  "author": "Lilith River",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/imazen/astro-broken-link-checker.git"
+  },
+  "bugs": {
+    "url": "https://github.com/imazen/astro-broken-link-checker/issues"
+  },
+  "homepage": "https://github.com/imazen/astro-broken-link-checker#readme",
+  "dependencies": {
+    "fast-glob": "^3.3.2",
+    "node-fetch": "^3.3.2",
+    "node-html-parser": "^6.1.13",
+    "p-limit": "^6.1.0"
+  },
+  "devDependencies": {
+    "execa": "^9.4.0",
+    "vitest": "^3.2.4"
+  },
+  "scripts": {
+    "build": "echo 'no build needed'",
+    "test": "cd tests && npm run build && cd .. && vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest --watch"
+  }
+}