@cplieger/deadset-ts 8.0.0-dev.1 → 8.0.0-dev.11

package/src/convention-rows.ts

@@ -140,14 +140,16 @@ export interface ConventionRow {
   readonly manifestEntries?: readonly ManifestEntryKey[];
   /** The settings that make the tool's output import a runtime helper package. */
   readonly helpers?: readonly HelperReading[];
+  /** Whether the tool bundles the package's modules, so it resolves them as a bundler does. */
+  readonly bundles?: true;
 }
 
 const SCRIPT = "{js,jsx,ts,tsx}";
 const MODULE = "{js,mjs,ts,mts}";
 const ANY_MODULE = "{js,mjs,cjs,ts,mts,cts}";
 const VITE_CONFIG = `vite.config.${ANY_MODULE}`;
-/** The legacy configuration files of ESLint that hold JSON or a CommonJS module. */
-const ESLINTRC = [".eslintrc", ".eslintrc.json", ".eslintrc.{js,cjs}"];
+/** The legacy configuration files of ESLint: JSON, YAML or a CommonJS module. */
+const ESLINTRC = [".eslintrc", ".eslintrc.json", ".eslintrc.{yml,yaml}", ".eslintrc.{js,cjs}"];
 
 const SVELTEKIT_ROUTE_FILES = "+{page,layout,server,page.server,layout.server,error}";
 
@@ -209,6 +211,60 @@ const ANGULAR_PACKAGE_KEYS: readonly PackageKey[] = [
   "scripts",
 ].map((key) => ({ key, files: ["angular.json"] }));
 
+/**
+ * The row of a code generator that writes its output below one directory its
+ * configuration's `property` sets, `fallback` where no configuration file sets it, so
+ * every file there is a generated file.
+ */
+function outputDirectoryRow(row: {
+  readonly name: string;
+  readonly package: string;
+  readonly range: string;
+  readonly files: readonly string[];
+  readonly property: string;
+  readonly fallback: string;
+}): ConventionRow {
+  return {
+    name: row.name,
+    package: row.package,
+    range: row.range,
+    entries: [],
+    generated: ["<output>"],
+    moves: [
+      {
+        id: "output",
+        defaults: [row.fallback],
+        readings: [{ property: row.property, files: row.files }],
+      },
+    ],
+  };
+}
+
+/**
+ * The test runners and the assertion, mock and runner libraries whose import is test
+ * evidence beside each runner a row reads test files for. Each applies whether or not a
+ * manifest declares it, so none is a row.
+ */
+export const TEST_LIBRARIES: readonly string[] = [
+  "@jest/globals",
+  "@playwright/test",
+  "ava",
+  "chai",
+  "expect",
+  "jasmine",
+  "jest",
+  "mocha",
+  "msw",
+  "nock",
+  "node:test",
+  "sinon",
+  "tap",
+  "uvu",
+];
+
+/** The scopes every package of which is a test library. */
+export const TEST_LIBRARY_SCOPES: readonly string[] = ["@testing-library/"];
+
 /** Every row, ordered by name and then by range. */
 export const CONVENTION_ROWS: readonly ConventionRow[] = [
   {
@@ -229,6 +285,7 @@ export const CONVENTION_ROWS: readonly ConventionRow[] = [
   },
   {
     name: "astro",
+    bundles: true,
     package: "astro",
     range: ">=5.0.0 <8.0.0",
     entries: [
@@ -274,6 +331,7 @@ export const CONVENTION_ROWS: readonly ConventionRow[] = [
     range: ">=4.0.0 <10.0.0",
     entries: [],
     moves: [],
+    packageKeys: [{ key: "parser", files: ESLINTRC }],
     prefixedNames: [
       { property: "plugins", files: ESLINTRC, prefix: "eslint-plugin" },
       { property: "extends", files: ESLINTRC, prefix: "eslint-plugin", marker: "plugin:" },
@@ -297,12 +355,13 @@ export const CONVENTION_ROWS: readonly ConventionRow[] = [
   {
     name: "expo-router",
     package: "expo-router",
-    range: ">=3.0.0 <58.0.0",
+    range: ">=3.0.0 <59.0.0",
     entries: [`{,src/}app/**/*.${SCRIPT}`],
     moves: [],
   },
   {
     name: "next",
+    bundles: true,
     package: "next",
     range: ">=13.4.0 <17.0.0",
     generated: [".next"],
@@ -320,6 +379,7 @@ export const CONVENTION_ROWS: readonly ConventionRow[] = [
   },
   {
     name: "nuxt",
+    bundles: true,
     package: "nuxt",
     range: ">=3.0.0 <5.0.0",
     generated: [".nuxt"],
@@ -389,8 +449,17 @@ export const CONVENTION_ROWS: readonly ConventionRow[] = [
       { key: "oclif.hooks", directory: false },
     ],
   },
+  outputDirectoryRow({
+    name: "panda",
+    package: "@pandacss/dev",
+    range: ">=0.1.0 <2.0.0",
+    files: [`panda.config.${ANY_MODULE}`],
+    property: "outdir",
+    fallback: "styled-system",
+  }),
   {
     name: "parcel",
+    bundles: true,
     package: "parcel",
     range: ">=2.0.0 <3.0.0",
     entries: [],
@@ -456,6 +525,13 @@ export const CONVENTION_ROWS: readonly ConventionRow[] = [
       },
     ],
   },
+  {
+    name: "react-scripts",
+    package: "react-scripts",
+    range: ">=1.0.0 <6.0.0",
+    entries: [`src/index.${SCRIPT}`, "src/setupProxy.js", `src/setupTests.${SCRIPT}`],
+    moves: [],
+  },
   {
     name: "remix",
     package: "@remix-run/dev",
@@ -483,6 +559,7 @@ export const CONVENTION_ROWS: readonly ConventionRow[] = [
   },
   {
     name: "rolldown",
+    bundles: true,
     package: "rolldown",
     range: ">=1.0.0 <2.0.0",
     entries: [],
@@ -528,6 +605,7 @@ export const CONVENTION_ROWS: readonly ConventionRow[] = [
   },
   {
     name: "storybook",
+    bundles: true,
     package: "storybook",
     range: ">=7.0.0 <11.0.0",
     entries: [
@@ -561,6 +639,7 @@ export const CONVENTION_ROWS: readonly ConventionRow[] = [
   },
   {
     name: "sveltekit",
+    bundles: true,
     package: "@sveltejs/kit",
     range: ">=2.0.0 <3.0.0",
     entries: [...SVELTEKIT_ENTRIES, "<params>/*.{js,ts}"],
@@ -626,6 +705,7 @@ export const CONVENTION_ROWS: readonly ConventionRow[] = [
   },
   {
     name: "sveltekit",
+    bundles: true,
     package: "@sveltejs/kit",
     range: ">=3.0.0 <4.0.0",
     entries: [...SVELTEKIT_ENTRIES, "<params>.{js,ts}"],
@@ -718,6 +798,7 @@ export const CONVENTION_ROWS: readonly ConventionRow[] = [
   },
   {
     name: "vite",
+    bundles: true,
     package: "vite",
     range: ">=8.0.0 <9.0.0",
     entries: [],
@@ -733,6 +814,7 @@ export const CONVENTION_ROWS: readonly ConventionRow[] = [
   },
   {
     name: "vitepress",
+    bundles: true,
     package: "vitepress",
     range: ">=1.0.0 <2.0.0-0 || >=2.0.0-alpha.0 <3.0.0",
     entries: [

package/src/conventions.ts

@@ -8,7 +8,6 @@
 
 import {
   isArrayLiteralExpression,
-  isAsExpression,
   isBinaryExpression,
   isCallExpression,
   isClassDeclaration,
@@ -22,27 +21,20 @@ import {
   isNamedExports,
   isNamespaceImport,
   isNoSubstitutionTemplateLiteral,
-  isNonNullExpression,
   isNumericLiteral,
   isObjectBindingPattern,
   isObjectLiteralExpression,
-  isParenthesizedExpression,
   isPropertyAccessExpression,
   isPropertyAssignment,
-  isSatisfiesExpression,
   isShorthandPropertyAssignment,
   isSpreadAssignment,
   isStringLiteral,
   isVariableStatement,
   SyntaxKind,
-  type AsExpression,
   type Identifier,
   type Node,
   type ObjectBindingPattern,
-  type NonNullExpression,
   type ObjectLiteralExpression,
-  type ParenthesizedExpression,
-  type SatisfiesExpression,
   type SourceFile,
 } from "@typescript/native/ast";
 import { lineOf } from "./component-files.ts";
@@ -60,12 +52,25 @@ import {
   type TestFileReading,
 } from "./convention-rows.ts";
 import { documentStrings } from "./configuration-files.ts";
-import { globExpression } from "./glob.ts";
 import type { Host } from "./host.ts";
-import { dirnamePath, joinPath, normalizePath, relativePath, resolvePath } from "./paths.ts";
-import type { SetupFailure } from "./setup-failure.ts";
+import {
+  ancestors,
+  dirnamePath,
+  joinPath,
+  normalizePath,
+  relativePath,
+  resolvePath,
+} from "./paths.ts";
+import type { Failure } from "./failure.ts";
 import type { SourceFiles } from "./source-files.ts";
 import { satisfies } from "./version-range.ts";
+import { bytewise } from "./text/compare.ts";
+import { isRecord } from "./json-document.ts";
+import { unwrapped } from "./unwrap.ts";
+import { filesIn } from "./fs/tree.ts";
+import { DEPENDENCY_SECTIONS, INSTALLED_PACKAGES, MANIFEST, readJSON } from "./fs/manifest.ts";
+import { globExpression } from "./text/glob.ts";
+import { yamlDocument } from "./text/yaml.ts";
 
 /** One manifest the analysis reads. */
 export interface ConventionManifest {
@@ -110,7 +115,7 @@ interface GeneratedDirectory {
 /** A setup failure a row met, at the directory of the manifest that declared it. */
 interface ConventionFailure {
   readonly dir: string;
-  readonly failure: SetupFailure;
+  readonly failure: Failure;
 }
 
 /** What the rows decided for one run. */
@@ -151,30 +156,19 @@ type ParseSource = (fileName: string, text: string) => SourceFile;
 
 const JSON_EXTENSION = ".json";
 
+/**
+ * A configuration file its tool reads as a YAML document, read as the JSON document it
+ * denotes. Its nodes' offsets are that JSON text's, so no move may read one: a failure's
+ * line would name the wrong line.
+ */
+const YAML_NAME = /\.ya?ml$/u;
+
 /** A configuration file with no extension that its tool reads as a JSON document. */
 const JSON_RC = /^\.[\w-]+rc$/u;
 
 /** The sections an installed package is required by, so its absence fails the run. */
 const REQUIRED_SECTIONS = ["dependencies", "devDependencies"] as const;
 
-const DEPENDENCY_SECTIONS = [
-  ...REQUIRED_SECTIONS,
-  "peerDependencies",
-  "optionalDependencies",
-] as const;
-
-function isRecord(value: unknown): value is Record<string, unknown> {
-  return typeof value === "object" && value !== null && !Array.isArray(value);
-}
-
-function readJSON(host: Host, path: string): unknown {
-  try {
-    return JSON.parse(host.readFile(path));
-  } catch {
-    return undefined;
-  }
-}
-
 function declares(
   manifest: unknown,
   name: string,
@@ -195,38 +189,15 @@ function declares(
  * none, or `undefined` where no `node_modules` holds it.
  */
 function installedVersion(host: Host, dir: string, name: string): string | undefined {
-  for (let at = normalizePath(dir); ; at = dirnamePath(at)) {
-    const path = joinPath(at, "node_modules", name, "package.json");
+  for (const at of ancestors(dir)) {
+    const path = joinPath(at, INSTALLED_PACKAGES, name, MANIFEST);
     if (host.kindOf(path) === "file") {
       const manifest = readJSON(host, path);
       const version = isRecord(manifest) ? manifest["version"] : undefined;
       return typeof version === "string" ? version : "";
     }
-    if (dirnamePath(at) === at) {
-      return undefined;
-    }
   }
-}
-
-/** Whether one node wraps an expression without changing its value. */
-function isWrapper(
-  node: Node,
-): node is ParenthesizedExpression | AsExpression | SatisfiesExpression | NonNullExpression {
-  return (
-    isParenthesizedExpression(node) ||
-    isAsExpression(node) ||
-    isSatisfiesExpression(node) ||
-    isNonNullExpression(node)
-  );
-}
-
-/** The expression a wrapper that changes no value holds. */
-function unwrapped(node: Node): Node {
-  let at = node;
-  while (isWrapper(at)) {
-    at = at.expression;
-  }
-  return at;
+  return undefined;
 }
 
 /** The key one property is written with, where it is written as a name or as literal text. */
@@ -815,16 +786,7 @@ function expand(
 /** The configuration files in one directory that one glob names, by name. */
 function configurationFiles(host: Host, dir: string, glob: string): readonly string[] {
   const expression = globExpression(glob);
-  let entries;
-  try {
-    entries = host.readDirectory(dir);
-  } catch {
-    return [];
-  }
-  return entries
-    .filter((entry) => !entry.directory && expression.test(entry.name))
-    .map((entry) => entry.name)
-    .sort();
+  return filesIn(host, dir, (name) => expression.test(name));
 }
 
 /** What one move resolved to: its directories, or the failure its property met. */
@@ -883,6 +845,14 @@ function readingFiles(
       } catch {
         continue;
       }
+      if (YAML_NAME.test(name)) {
+        const value = yamlDocument(text);
+        if (value !== undefined) {
+          const json = JSON.stringify(value);
+          found.push({ name, text: json, file: parse(`${path}${JSON_EXTENSION}`, json) });
+        }
+        continue;
+      }
       found.push({
         name,
         text,
@@ -932,7 +902,7 @@ function shortNameUses(
       }
     }
   }
-  return [...used].filter((name) => declared.has(name)).sort(compare);
+  return [...used].filter((name) => declared.has(name)).sort(bytewise);
 }
 
 /**
@@ -992,7 +962,7 @@ function prefixedNameUses(
       }
     }
   }
-  return [...used].sort(compare);
+  return [...used].sort(bytewise);
 }
 
 /** The declared dependencies an applied row's helper settings use. */
@@ -1076,14 +1046,6 @@ function packageKeyUses(
   );
 }
 
-/** Two strings ordered bytewise. */
-function compare(a: string, b: string): number {
-  if (a === b) {
-    return 0;
-  }
-  return a < b ? -1 : 1;
-}
-
 /**
  * What the rows decide over the manifests the analysis reads. A row `disabled` names
  * is skipped before anything is read for it.
@@ -1103,7 +1065,7 @@ export function readConventions(
   const selected = new Map<string, { starts: Set<number>; texts: string[] }>();
   const testFiles = new Set<string>();
   for (const manifest of manifests) {
-    const declared = readJSON(host, joinPath(manifest.dir, "package.json"));
+    const declared = readJSON(host, joinPath(manifest.dir, MANIFEST));
     const versions = new Map<string, string | undefined>();
     const missing = new Set<string>();
     for (const row of rows) {
@@ -1126,7 +1088,7 @@ export function readConventions(
         failures.push({
           dir: manifest.dir,
           failure: {
-            setupClass: "missing-module",
+            failureClass: "missing-module",
             detail:
               `${manifest.path} declares ${row.package}, which no node_modules at or ` +
               `above its directory holds: run the package manager's install`,
@@ -1152,7 +1114,7 @@ export function readConventions(
         failures.push({
           dir: manifest.dir,
           failure: {
-            setupClass: "convention-not-literal",
+            failureClass: "convention-not-literal",
             detail: where === "." ? failed : `${where}/${failed}`,
           },
         });
@@ -1206,16 +1168,16 @@ export function readConventions(
   const unique = [...new Map(applied.map((one) => [JSON.stringify(one), one])).values()];
   unique.sort(
     (a, b) =>
-      compare(a.name, b.name) ||
-      compare(a.manifest, b.manifest) ||
-      compare(JSON.stringify(a), JSON.stringify(b)),
+      bytewise(a.name, b.name) ||
+      bytewise(a.manifest, b.manifest) ||
+      bytewise(JSON.stringify(a), JSON.stringify(b)),
   );
   return {
     applied: unique,
     globs,
     generated,
     failures,
-    uses: [...uses].sort(compare),
+    uses: [...uses].sort(bytewise),
     selected,
     testFiles,
   };
@@ -1273,7 +1235,7 @@ export function conventionFailuresFor(
   conventions: Conventions,
   configFile: string,
   ownFiles: readonly string[],
-): readonly SetupFailure[] {
+): readonly Failure[] {
   return conventions.failures
     .filter(
       ({ dir }) =>