I wrote last month about using weird tests. Here's another example: checking for broken internal links in our upcoming docsite redesign!

const extractInternalLinks = (content: string): string[] => {
  // Check for internal links only, in the form of [text](/path).
  const internalLinks = content.match(/\[.*?\]\(\/.*?\)/g);
  return (
      ?.map((link) => {
        const path = link.match(/\(\/.*?\)/)
          ? link.match(/\(\/.*?\)/)![0].slice(2, -1)
          : null;

        // For now, we'll filter out any images or other non-page links under
        // the assumption that they can be caught elsewhere (e.g. the build step.)
        if (path && path.match(/\.(png|jpg|jpeg|gif|svg|webp|ico|pdf)$/)) {
          return null;
        return path;
      .filter((link) => link !== null) as string[]) || []

const MARKDOC_DIRECTORY = "content/pages";

// Make sure all mdoc files with internal links are valid.
fs.readdirSync(MARKDOC_DIRECTORY).forEach((filename) => {
  test("Check internal links in " + filename, () => {
    const fullyQualifiedFilename = `${MARKDOC_DIRECTORY}/${filename}`;
    const content = fs.readFileSync(fullyQualifiedFilename, "utf-8");
    const internalLinks = extractInternalLinks(content);
    internalLinks.forEach((outboundPath) => {
      const mungedOutboundPath = mungeInternalLinks(outboundPath);
      const expectedOutboundFilename = `${MARKDOC_DIRECTORY}/${mungedOutboundPath}.mdoc`;
        `Internal link to "/${outboundPath}" in "${filename}" does not exist.`

This is admittedly less weird than some other examples I've written about, but the core idea is the same: your test runner is a fast, ergonomic, pre-existing tool to express invariants upon your codebase, and it's easier to reach for something like this than pull in another third-party dependency.

Lightning bolt
Subscribe to my newsletter

I publish monthly roundups of everything I've written, plus pictures of my corgi.
© 2024 Justin Duke · All rights reserved · have a nice day.