@williamthorsen/tsconfig 0.6.1 → 0.7.0

package/.readyup/kits/default.js

@@ -1,6 +1,6 @@
 /** @noformat -- @generated. Do not edit. Compiled by rdy. */
 /* eslint-disable */
-export const __readyupVersion = "0.34.0";
+export const __readyupVersion = "0.35.0";
 
 
 // .readyup/kits/default.ts
@@ -71,6 +71,46 @@ function toStringArray(value) {
   return value.filter((entry) => typeof entry === "string");
 }
 
+// src/readiness/findEscapingPaths.ts
+import { dirname, join, relative } from "node:path/posix";
+var CONFIG_DIR_TEMPLATE = "${configDir}";
+var FIELDS = ["exclude", "files", "include"];
+var ROOTED_PATH = /^(?:\/|[A-Za-z]:)/;
+function findEscapingPaths(entries) {
+  const judged = entries[0];
+  if (judged === void 0) return [];
+  const judgedDir = dirname(judged.path);
+  return FIELDS.flatMap((field) => findEscapingPathsInField(entries, field, judgedDir));
+}
+function findDeclaringEntry(entries, field) {
+  for (const entry of entries) {
+    const declared = entry.config[field];
+    if (declared) return entry;
+  }
+  return void 0;
+}
+function findEscapingPathsInField(entries, field, judgedDir) {
+  const declaring = findDeclaringEntry(entries, field);
+  if (declaring === void 0) return [];
+  const declared = declaring.config[field];
+  if (!Array.isArray(declared)) return [];
+  const declaredDir = dirname(declaring.path);
+  return declared.filter((value) => typeof value === "string").flatMap((value) => {
+    const outward = findOutwardPath(value, declaredDir, judgedDir);
+    return outward === void 0 ? [] : [{ declaredIn: declaring.path, field, path: outward }];
+  });
+}
+function findOutwardPath(value, declaredDir, judgedDir) {
+  const normalized = value.split("\\").join("/");
+  if (ROOTED_PATH.test(normalized)) return normalized;
+  const resolved = startsWithConfigDir(normalized) ? join(judgedDir, normalized.slice(CONFIG_DIR_TEMPLATE.length)) : join(declaredDir, normalized);
+  const fromJudged = relative(judgedDir, resolved);
+  return fromJudged === ".." || fromJudged.startsWith("../") ? fromJudged : void 0;
+}
+function startsWithConfigDir(value) {
+  return value.slice(0, CONFIG_DIR_TEMPLATE.length).toLowerCase() === CONFIG_DIR_TEMPLATE.toLowerCase();
+}
+
 // src/readiness/findRedundantOptions.ts
 import { isDeepStrictEqual } from "node:util";
 function findRedundantOptions(entries, baseIndex) {
@@ -140,7 +180,7 @@ var cache = {
   chains: /* @__PURE__ */ new Map()
 };
 var default_default = defineRdyKit({
-  description: `Adoption and alignment checks for a project consuming ${PACKAGE_NAME}`,
+  description: `Adoption, alignment, and hygiene checks for a project consuming ${PACKAGE_NAME}`,
   defaultSeverity: "warn",
   checklists: [
     {
@@ -177,6 +217,17 @@ var default_default = defineRdyKit({
           fix: "Raise engines.node to a major implementing the base's ES year: below it, code that typechecks fails at runtime"
         }
       ]
+    },
+    {
+      name: "hygiene",
+      checks: [
+        {
+          name: "No tsconfig's include, exclude, or files names a path outside its own directory",
+          skip: skipUnlessSomeTsconfigWasFound,
+          check: noEscapingPaths,
+          fix: "Declare the field named above in the config that owns the directory, listing every path it needs, since a local declaration replaces the inherited one rather than merging and discards the default exclude of node_modules, bower_components, jspm_packages, and outDir; or prefix each path in the config being extended with ${configDir}, which resolves to the consuming config's directory"
+        }
+      ]
     }
   ]
 });
@@ -193,6 +244,10 @@ function classifyTsconfig(path) {
 function dedupe(values) {
   return [...new Set(values)];
 }
+function describeEscape(configPath, escaping) {
+  const source = escaping.declaredIn === configPath ? "" : `, from ${escaping.declaredIn}`;
+  return `${escaping.field}: ${escaping.path}${source}`;
+}
 function everyEsYearMatchesTheBase() {
   const baseEsYear = readBaseEsYear();
   if (baseEsYear === void 0) return true;
@@ -267,6 +322,23 @@ function nodeFloorSupportsBaseEsYear() {
   const verdict = judgeNodeFloor();
   return verdict.kind === "skip" ? true : { ok: verdict.kind === "pass", detail: verdict.detail };
 }
+function noEscapingPaths() {
+  const judged = findTsconfigs().flatMap((path) => {
+    const chain = readChain(path);
+    return chain === void 0 ? [] : [{ escapes: findEscapingPaths(chain.entries), path }];
+  });
+  const offenders = judged.filter((judgedConfig) => judgedConfig.escapes.length > 0);
+  const progress = {
+    type: "fraction",
+    passedCount: judged.length - offenders.length,
+    count: judged.length
+  };
+  if (offenders.length === 0) return { ok: true, progress };
+  const details = offenders.flatMap(
+    (offender) => offender.escapes.map((escaping) => `${offender.path} (${describeEscape(offender.path, escaping)})`)
+  );
+  return { ok: false, detail: details.join(", "), progress };
+}
 function noRedundantOptions() {
   const offenders = listAdoptedTsconfigs().flatMap(
     (adoption) => findRedundantOptions(adoption.chain.entries, adoption.baseIndex).map(
@@ -307,6 +379,9 @@ function skipUnlessSomeTsconfigIsAccountable() {
   if (classified.length === 0) return "no workspace tsconfig was found";
   return classified.some((adoption) => adoption.kind !== "external-base") ? false : "every workspace tsconfig extends a base belonging to another package";
 }
+function skipUnlessSomeTsconfigWasFound() {
+  return findTsconfigs().length === 0 ? "no workspace tsconfig was found" : false;
+}
 export {
   default_default as default
 };

package/.readyup/manifest.json

@@ -4,13 +4,14 @@
     {
       "checklists": [
         "adoption",
-        "alignment"
+        "alignment",
+        "hygiene"
       ],
-      "description": "Adoption and alignment checks for a project consuming @williamthorsen/tsconfig",
+      "description": "Adoption, alignment, and hygiene checks for a project consuming @williamthorsen/tsconfig",
       "esbuildVersion": "0.28.2",
       "inputs": [
         {
-          "hash": "defbbe48",
+          "hash": "f4ec4ffd",
           "kind": "module",
           "path": "kits/default.ts"
         },
@@ -29,6 +30,11 @@
           "kind": "module",
           "path": "../src/readiness/es-year.ts"
         },
+        {
+          "hash": "bfbb0002",
+          "kind": "module",
+          "path": "../src/readiness/findEscapingPaths.ts"
+        },
         {
           "hash": "acd6ba2b",
           "kind": "module",
@@ -47,10 +53,10 @@
       ],
       "name": "default",
       "path": "kits/default.js",
-      "readyupVersion": "0.34.0",
+      "readyupVersion": "0.35.0",
       "source": "kits/default.ts",
-      "sourceHash": "defbbe48",
-      "targetHash": "20355baf"
+      "sourceHash": "f4ec4ffd",
+      "targetHash": "2bcc6e9b"
     }
   ]
 }

package/README.md

@@ -3,13 +3,13 @@
 Shared TypeScript base config for Node-only projects. Inlines the settings of [`@tsconfig/strictest`](https://www.npmjs.com/package/@tsconfig/strictest) and adds the Node and build options it leaves out, so a consuming repo declares only what is genuinely its own.
 
 <!-- section:release-notes -->
-## Release notes — v0.6.1 (2026-08-27)
+## Release notes — v0.7.0 (2026-08-30)
 
-### 🐛 Bug fixes
+### 🎉 Features
 
-- Restore the repo root to both readiness kits' search directories (#187)
+- Report an include, exclude, or files path outside a tsconfig's directory (#197)
 
-  Fixes an issue where the readiness kits in `@williamthorsen/tsconfig` and `@williamthorsen/eslint-config-typescript` skipped the repo root in a monorepo running readyup below 0.33.0. Each kit now supplies the root itself, so the sweep is whole under any readyup version.
+  Adds a `hygiene` checklist to the `@williamthorsen/tsconfig` readiness kit, reporting at `warn` a workspace tsconfig whose effective `include`, `exclude`, or `files` names a path outside the directory holding it, whether that config declared the field itself or inherited it from a base.
 <!-- /section:release-notes -->
 
 ## Installation
@@ -100,10 +100,11 @@ export default defineRdyConfig({
 
 The `readyup >=0.33.0` optional peer names the version the kit is developed and tested against. Below 0.33.0, readyup does not report the repo root among a monorepo's workspaces, so the kit supplies the root itself and sweeps every member package alongside it.
 
-The kit walks each workspace tsconfig's `extends` chain and reports four things:
+The kit walks each workspace tsconfig's `extends` chain and reports five things:
 
 - **Adoption**: a tsconfig reaching neither this base nor a framework base. A tsconfig naming this base through a specifier that does not resolve is reported separately, as declared but not installed.
 - **Re-declaration**: an option restated with the base's own value. A key that a framework base in the same chain also declares is exempt, since restating it is how a config wins against that base.
+- **Escaping paths**: an `include`, `exclude`, or `files` path resolving outside the directory that holds the tsconfig. A config that is extended hands these fields down resolved against its own directory, so a package inheriting them is governed by paths pointing outside itself; the remedy is a complete local declaration, or `${configDir}` in the config being extended.
 - **ES year**: a `target` or `lib` declaring a year other than the base's, read from the base you extend rather than from a constant compiled into the kit.
 - **Node floor**: an `engines.node` below the major that implements that ES year. This is the one failure `tsc` cannot surface on its own, which is why it alone is an error.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@williamthorsen/tsconfig",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Shared TypeScript base config for Node-only projects",
   "keywords": [
     "tsconfig",
@@ -31,7 +31,7 @@
   "devDependencies": {
     "@tsconfig/strictest": "2.0.8",
     "esbuild": "0.28.2",
-    "readyup": "0.34.0"
+    "readyup": "0.35.0"
   },
   "peerDependencies": {
     "readyup": ">=0.33.0"