@lhechenberger/check-links 0.2.1 → 0.2.2

package/README.md

@@ -64,6 +64,11 @@ export default defineConfig({
 | `concurrency`        | `20`    | Parallel requests of the crawl                       |
 | `timeout`            | `30000` | Timeout per request in ms                            |
 
+### Type-checking and unused-file tools
+
+- The package ships TypeScript source (no build step). Relative imports inside it have no `.ts` extension, so a project that type-checks its `check-links.config.ts` (e.g. listed in `tsconfig.json` `include`) needs `moduleResolution: "bundler"` (or `"node16"`/`"nodenext"` is **not** supported) and Node or Bun types (`@types/node` or `@types/bun`), since the code uses `process`. Before 0.2.2 the imports ended in `.ts`; if you see `TS5097` from `node_modules/@lhechenberger/check-links`, update the package.
+- [knip](https://knip.dev) reports the config as an unused file. Declare it as an entry in `knip.json`: `{ "workspaces": { "apps/web": { "entry": ["check-links.config.ts"] } } }` (use `"entry"` at the top level in a single-package repo).
+
 ## GitHub workflow: check every Vercel deployment
 
 The package contains a workflow template that runs the check when Vercel reports a ready deployment, shows the result as a **"Broken Links" check run** on the deployed commit (so it appears on the pull request, with the full output) and reports the commit status that Vercel's Deployment Checks can require before a production deployment gets its domain.

package/package.json

@@ -1,29 +1,25 @@
 {
   "name": "@lhechenberger/check-links",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Crawls a deployed site for broken links, separating flaky failures from real ones. Built for Vercel preview deployments.",
   "keywords": [
     "broken-links",
+    "ci",
     "link-checker",
     "linkinator",
-    "vercel",
-    "ci"
+    "vercel"
   ],
   "homepage": "https://github.com/LukasHechenberger/workbench/tree/main/packages/check-links#readme",
   "bugs": {
     "url": "https://github.com/LukasHechenberger/workbench/issues"
   },
+  "license": "MIT",
+  "author": "Lukas Hechenberger",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/LukasHechenberger/workbench.git",
     "directory": "packages/check-links"
   },
-  "license": "MIT",
-  "author": "Lukas Hechenberger",
-  "type": "module",
-  "exports": {
-    ".": "./src/index.ts"
-  },
   "bin": {
     "check-links": "src/cli.ts"
   },
@@ -32,6 +28,13 @@
     "!src/**/*.test.ts",
     "templates"
   ],
+  "type": "module",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "test": "bun test"
   },
@@ -40,8 +43,5 @@
   },
   "engines": {
     "bun": ">=1.2"
-  },
-  "publishConfig": {
-    "access": "public"
   }
 }

package/src/classify.ts

@@ -38,6 +38,7 @@ export async function classify(
   // A burst of requests is what failed in the first place, so the second pass is gentle
   for (let i = 0; i < toRecheck.length; i += concurrency) {
     const batch = toRecheck.slice(i, i + concurrency);
+    // oxlint-disable-next-line no-await-in-loop -- one batch after the other, on purpose
     const results = await Promise.all(batch.map((link) => recovers(link)));
     for (const [index, link] of batch.entries()) (results[index] ? flaky : errors).push(link);
   }

package/src/cli.ts

@@ -2,8 +2,8 @@
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
 import { dirname, resolve } from 'node:path';
 import { parseArgs } from 'node:util';
-import type { CheckLinksConfig } from './config.ts';
-import { run } from './run.ts';
+import type { CheckLinksConfig } from './config';
+import { run } from './run';
 
 const usage = `Usage:
   check-links [url] [--config check-links.config.ts]
@@ -37,7 +37,8 @@ if (positionals[0] === 'init-workflow') {
 const configPath = resolve(values.config ?? 'check-links.config.ts');
 let config: CheckLinksConfig = {};
 if (existsSync(configPath)) {
-  config = ((await import(configPath)) as { default: CheckLinksConfig }).default;
+  const loaded: { default: CheckLinksConfig } = await import(configPath);
+  config = loaded.default;
 } else if (values.config) {
   console.error(`Config ${configPath} not found`);
   process.exit(1);

package/src/index.ts

@@ -1,3 +1,3 @@
-export { classify, type Classification, type ClassifyOptions } from './classify.ts';
-export { defineConfig, type CheckLinksConfig, type LinkContext } from './config.ts';
-export { run } from './run.ts';
+export { classify, type Classification, type ClassifyOptions } from './classify';
+export { defineConfig, type CheckLinksConfig, type LinkContext } from './config';
+export { run } from './run';

package/src/run.ts

@@ -1,9 +1,17 @@
 import { check, type LinkResult, LinkState } from 'linkinator';
-import { classify } from './classify.ts';
-import type { CheckLinksConfig } from './config.ts';
+import { classify } from './classify';
+import type { CheckLinksConfig } from './config';
 
 const BYPASS_ENV = 'VERCEL_AUTOMATION_BYPASS_SECRET';
 
+const print = (title: string, results: LinkResult[]) => {
+  if (results.length === 0) return;
+  console.log(`\n${title}`);
+  for (const link of results) {
+    console.log(`  [${link.status ?? 'error'}] ${link.url}\n    on ${link.parent}`);
+  }
+};
+
 /** Crawls `url` and prints the result. Returns the process exit code. */
 export async function run(url: string, config: CheckLinksConfig): Promise<number> {
   const { origin } = new URL(url);
@@ -64,14 +72,6 @@ export async function run(url: string, config: CheckLinksConfig): Promise<number
     concurrency: config.recheckConcurrency ?? 5,
   });
 
-  const print = (title: string, results: LinkResult[]) => {
-    if (results.length === 0) return;
-    console.log(`\n${title}`);
-    for (const link of results) {
-      console.log(`  [${link.status ?? 'error'}] ${link.url}\n    on ${link.parent}`);
-    }
-  };
-
   print(`${config.warningTitle ?? 'Broken links that are only warnings'} (warnings):`, warnings);
   print('Links that worked on a second request (warnings):', flaky);
   print('Broken links:', errors);