@cplieger/deadset-ts 7.2.0-dev.3 → 8.0.0-dev.1

package/src/convention-rows.ts

@@ -31,6 +31,22 @@ export interface ShortNameReading extends MoveReading {
   readonly package: string;
 }
 
+/**
+ * One configuration property whose values name packages by the tool's prefix convention:
+ * `x` stands for `<prefix>-x`, `@s` for `@s/<prefix>` and `@s/x` for `@s/<prefix>-x`, and
+ * a name already holding the prefix for itself.
+ */
+export interface PrefixedNameReading extends MoveReading {
+  /** The prefix the convention puts before a short name. */
+  readonly prefix: string;
+  /**
+   * The text a value starts with to name a package, the name ending at its last `/`.
+   * Absent, every value without a `:` names one, the name ending at its first `/` past
+   * a scope.
+   */
+  readonly marker?: string;
+}
+
 /**
  * One configuration property whose value makes the tool's output import a runtime helper
  * package, so the package is used where the property holds that value.
@@ -63,6 +79,14 @@ export interface TestFileReading extends MoveReading {
   readonly roots: readonly string[];
 }
 
+/** One member of the declaring `package.json` whose strings name the tool's entries. */
+export interface ManifestEntryKey {
+  /** The member's path through nested objects, its keys joined by `.`, a `*` key standing for every member. */
+  readonly key: string;
+  /** Whether each string names a directory of entries, or one entry, its extension optional. */
+  readonly directory: boolean;
+}
+
 /** One directory a row's globs name that a configuration property moves. */
 export interface DirectoryMove {
   /** The placeholder the row's globs and later moves write as `<id>`. */
@@ -96,6 +120,8 @@ export interface ConventionRow {
   readonly moves: readonly DirectoryMove[];
   /** The properties that name a package the configuration uses by a short name. */
   readonly shortNames?: readonly ShortNameReading[];
+  /** The properties that name a package the configuration uses by its prefix convention. */
+  readonly prefixedNames?: readonly PrefixedNameReading[];
   /**
    * The properties whose value only selects files to test, mutate, cover or ignore, so a
    * string there names no file the tool runs or loads.
@@ -110,6 +136,8 @@ export interface ConventionRow {
   readonly packageKeys?: readonly PackageKey[];
   /** The members of a `package.json` the tool reads its configuration from. */
   readonly manifestKeys?: readonly string[];
+  /** The members of the declaring `package.json` whose strings name entries, as an entry glob does. */
+  readonly manifestEntries?: readonly ManifestEntryKey[];
   /** The settings that make the tool's output import a runtime helper package. */
   readonly helpers?: readonly HelperReading[];
 }
@@ -118,6 +146,8 @@ 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}"];
 
 const SVELTEKIT_ROUTE_FILES = "+{page,layout,server,page.server,layout.server,error}";
 
@@ -231,6 +261,25 @@ export const CONVENTION_ROWS: readonly ConventionRow[] = [
       package: "@babel/runtime",
     })),
   },
+  {
+    name: "docusaurus",
+    package: "@docusaurus/core",
+    range: ">=2.0.0 <4.0.0",
+    entries: [`src/pages/**/*.${SCRIPT}`, `src/theme/**/*.${SCRIPT}`],
+    moves: [],
+  },
+  {
+    name: "eslint",
+    package: "eslint",
+    range: ">=4.0.0 <10.0.0",
+    entries: [],
+    moves: [],
+    prefixedNames: [
+      { property: "plugins", files: ESLINTRC, prefix: "eslint-plugin" },
+      { property: "extends", files: ESLINTRC, prefix: "eslint-plugin", marker: "plugin:" },
+      { property: "extends", files: ESLINTRC, prefix: "eslint-config" },
+    ],
+  },
   {
     name: "eslint",
     package: "eslint",
@@ -238,6 +287,13 @@ export const CONVENTION_ROWS: readonly ConventionRow[] = [
     entries: [`**/eslint.config.${ANY_MODULE}`],
     moves: [],
   },
+  {
+    name: "expo",
+    package: "expo",
+    range: ">=44.0.0 <60.0.0",
+    entries: [`{index,App}.${SCRIPT}`],
+    moves: [],
+  },
   {
     name: "expo-router",
     package: "expo-router",
@@ -322,6 +378,28 @@ export const CONVENTION_ROWS: readonly ConventionRow[] = [
       },
     ],
   },
+  {
+    name: "oclif",
+    package: "@oclif/core",
+    range: ">=1.0.0 <5.0.0",
+    entries: [`src/{commands,hooks}/**/*.${SCRIPT}`],
+    moves: [],
+    manifestEntries: [
+      { key: "oclif.commands", directory: true },
+      { key: "oclif.hooks", directory: false },
+    ],
+  },
+  {
+    name: "parcel",
+    package: "parcel",
+    range: ">=2.0.0 <3.0.0",
+    entries: [],
+    moves: [],
+    manifestEntries: [
+      { key: "source", directory: false },
+      { key: "targets.*.source", directory: false },
+    ],
+  },
   {
     name: "prettier",
     package: "prettier",
@@ -613,6 +691,31 @@ export const CONVENTION_ROWS: readonly ConventionRow[] = [
       },
     ],
   },
+  {
+    name: "tanstack-router",
+    package: "@tanstack/router-plugin",
+    range: ">=1.0.0 <2.0.0",
+    entries: [`<routes>/**/*.${SCRIPT}`],
+    moves: [
+      {
+        id: "routes",
+        defaults: ["src/routes"],
+        readings: [
+          { property: "routesDirectory", files: ["tsr.config.json"] },
+          {
+            property: "routesDirectory",
+            files: [VITE_CONFIG],
+            call: { module: "@tanstack/router-plugin/vite", export: "tanstackRouter" },
+          },
+          {
+            property: "routesDirectory",
+            files: [VITE_CONFIG],
+            call: { module: "@tanstack/router-plugin/vite", export: "TanStackRouterVite" },
+          },
+        ],
+      },
+    ],
+  },
   {
     name: "vite",
     package: "vite",

package/src/conventions.ts

@@ -51,9 +51,11 @@ import {
   type ConventionRow,
   type DirectoryMove,
   type HelperReading,
+  type ManifestEntryKey,
   type MoveReading,
   type OptionsCall,
   type PackageKey,
+  type PrefixedNameReading,
   type ShortNameReading,
   type TestFileReading,
 } from "./convention-rows.ts";
@@ -692,6 +694,47 @@ function manifestKeyUses(manifest: unknown, keys: readonly string[]): readonly s
   );
 }
 
+/** The extensions an entry a manifest entry key names without one may carry. */
+const ENTRY_EXTENSIONS = "{js,jsx,mjs,cjs,ts,tsx,mts,cts}";
+
+/** The characters that make a manifest string a pattern rather than a directory's name. */
+const PATTERN = /[*?{}[\]]/u;
+
+/**
+ * The entry globs one applied row's manifest entry keys write, below the manifest's
+ * directory: a directory's every module, or a file with or without an extension. A string
+ * that leaves the directory names nothing.
+ */
+function manifestEntryGlobs(manifest: unknown, keys: readonly ManifestEntryKey[]): string[] {
+  const at = (value: unknown, path: readonly string[]): unknown[] => {
+    const [key, ...rest] = path;
+    if (key === undefined) {
+      return [value];
+    }
+    if (!isRecord(value)) {
+      return [];
+    }
+    const next = key === "*" ? Object.values(value) : Object.hasOwn(value, key) ? [value[key]] : [];
+    return next.flatMap((one) => at(one, rest));
+  };
+  return keys.flatMap(({ key, directory }) =>
+    at(manifest, key.split(".")).flatMap((value) =>
+      documentStrings(value).flatMap((text) => {
+        const path = normalizePath(text)
+          .replace(/^(?:\.\/)+/u, "")
+          .replace(/\/+$/u, "");
+        if (path === "" || path === ".." || path.startsWith("../") || path.startsWith("/")) {
+          return [];
+        }
+        if (!directory) {
+          return [path, `${path}.${ENTRY_EXTENSIONS}`];
+        }
+        return PATTERN.test(path) ? [] : [`${path}/**/*.${ENTRY_EXTENSIONS}`];
+      }),
+    ),
+  );
+}
+
 /** What one configuration file states about one property. */
 interface PropertyReading {
   /** The literal values the file sets the property to. */
@@ -892,6 +935,66 @@ function shortNameUses(
   return [...used].filter((name) => declared.has(name)).sort(compare);
 }
 
+/**
+ * The package one value of a prefixed-name reading names, or none: ESLint's own naming,
+ * https://github.com/eslint/eslintrc/blob/main/lib/shared/naming.js
+ */
+function prefixedPackage(value: string, reading: PrefixedNameReading): string | undefined {
+  const { prefix, marker } = reading;
+  let name: string;
+  if (marker === undefined) {
+    if (value.includes(":") || value.startsWith(".") || value.startsWith("/")) {
+      return undefined;
+    }
+    const parts = value.split("/");
+    name = (value.startsWith("@") ? parts.slice(0, 2) : parts.slice(0, 1)).join("/");
+  } else {
+    if (!value.startsWith(marker) || !value.includes("/", marker.length)) {
+      return undefined;
+    }
+    name = value.slice(marker.length, value.lastIndexOf("/"));
+  }
+  if (name === "") {
+    return undefined;
+  }
+  if (!name.startsWith("@")) {
+    return name.startsWith(`${prefix}-`) ? name : `${prefix}-${name}`;
+  }
+  const [scope, rest] = name.split("/");
+  if (rest === undefined || rest === "" || rest === prefix) {
+    return `${scope ?? name}/${prefix}`;
+  }
+  return rest.startsWith(`${prefix}-`) ? name : `${scope ?? name}/${prefix}-${rest}`;
+}
+
+/** The declared dependencies an applied row's prefixed names use. */
+function prefixedNameUses(
+  host: Host,
+  parse: ParseSource,
+  dir: string,
+  manifest: unknown,
+  readings: readonly PrefixedNameReading[],
+): readonly string[] {
+  const declared = new Set(
+    DEPENDENCY_SECTIONS.flatMap((section) => {
+      const held = isRecord(manifest) ? manifest[section] : undefined;
+      return isRecord(held) ? Object.keys(held) : [];
+    }),
+  );
+  const used = new Set<string>();
+  for (const reading of readings) {
+    for (const { file } of readingFiles(host, parse, dir, reading.files)) {
+      for (const value of readProperty(file, reading.property, reading.call, true).values) {
+        const named = prefixedPackage(value, reading);
+        if (named !== undefined && declared.has(named)) {
+          used.add(named);
+        }
+      }
+    }
+  }
+  return [...used].sort(compare);
+}
+
 /** The declared dependencies an applied row's helper settings use. */
 function helperUses(
   host: Host,
@@ -1064,6 +1167,10 @@ export function readConventions(
       for (const name of shortNameUses(host, parse, manifest.dir, declared, row.shortNames ?? [])) {
         uses.add(name);
       }
+      const prefixed = row.prefixedNames ?? [];
+      for (const name of prefixedNameUses(host, parse, manifest.dir, declared, prefixed)) {
+        uses.add(name);
+      }
       const keys = row.packageKeys ?? [];
       for (const name of packageKeyUses(host, parse, manifest.dir, declared, keys)) {
         uses.add(name);
@@ -1082,7 +1189,11 @@ export function readConventions(
       for (const below of new Set((row.generated ?? []).flatMap((one) => expand(one, resolved)))) {
         generated.push({ dir: manifest.dir, row: row.name, below });
       }
-      for (const glob of new Set(row.entries.flatMap((entry) => expand(entry, resolved)))) {
+      const written = [
+        ...row.entries.flatMap((entry) => expand(entry, resolved)),
+        ...manifestEntryGlobs(declared, row.manifestEntries ?? []),
+      ];
+      for (const glob of new Set(written)) {
         globs.push({
           dir: manifest.dir,
           row: row.name,
@@ -1138,12 +1249,15 @@ export function conventionEntries(
   const found = new Map<string, ConventionEntry>();
   for (const glob of conventions.globs) {
     for (const file of files.byName.values()) {
-      const path = relativePath(glob.dir, file.fileName);
-      if (
-        path !== undefined &&
-        glob.expression.test(path) &&
-        !glob.excludes.some((one) => one.test(path))
-      ) {
+      const matched = [file.fileName, ...files.writtenAs(file)].some((name) => {
+        const path = relativePath(glob.dir, name);
+        return (
+          path !== undefined &&
+          glob.expression.test(path) &&
+          !glob.excludes.some((one) => one.test(path))
+        );
+      });
+      if (matched) {
         found.set(`${file.fileName}\u0000${glob.row}`, { file, row: glob.row });
       }
     }

package/src/decorator.ts

@@ -1,14 +1,10 @@
 /**
- * The decorator class: a member a decorator expression is attached to, and every
- * member of a class a decorator expression is attached to, is held back, because the
- * decorator receives the member or the class when the class is defined and may reach
- * the member by its name.
- *
- * The rule is read from the tree alone: a decorator is attached where it is written.
- * The use the decorator itself makes of what it decorates is the reference pass's,
- * which records it as a `decorator` reference; this class records only that the
- * declaration is held back, and the member set of a decorated class is every member
- * the inventory holds for the class, static members included.
+ * The decorator class: a member a decorator expression is attached to, and every member
+ * of a class one is attached to but the member a parameter property declares, is held
+ * back, because the decorator may reach the member by its name. The rule is read from
+ * the tree alone. The decorator's own use of what it decorates is the reference pass's
+ * `decorator` reference; this class records only that the declaration is held back,
+ * static members of a decorated class included.
  */
 
 import type { Node } from "@typescript/native/ast";
@@ -44,25 +40,39 @@ export function decorator<Brand>(input: DetectorInput<Brand>): readonly Evidence
     }
   }
 
-  const found: Evidence[] = [];
+  const decorated: {
+    readonly symbol: InventorySymbol;
+    readonly detail: string;
+    readonly site: Evidence["site"];
+  }[] = [];
+  // A decorated class's container passes each constructor argument, which keeps the
+  // parameter, not the member a parameter property stores it in.
+  const parameterMembers = new Set<string>();
   for (const file of project.ownSourceFiles()) {
     const visit = (node: Node): void => {
       const id = held.declarations.get(nodeKey(file, node));
       const symbol = id === undefined ? undefined : byId.get(id);
+      if (id !== undefined && isParameterProperty(node)) {
+        parameterMembers.add(id);
+      }
       // A parameter property's decorator is attached to its parameter, and to no member.
       if (symbol !== undefined && DECORATED.has(symbol.kind) && !isParameterProperty(node)) {
         for (const attached of decoratorsOf(node)) {
-          const detail = `decorated by ${spelledDecorator(attached)}`;
-          const site = renderPosition(file, targetRoot, attached.getStart());
-          const reached = symbol.kind === "class" ? (membersOf.get(symbol.id) ?? []) : [symbol];
-          for (const member of reached) {
-            found.push({ id: member.id, detail, site });
-          }
+          decorated.push({
+            symbol,
+            detail: `decorated by ${spelledDecorator(attached)}`,
+            site: renderPosition(file, targetRoot, attached.getStart()),
+          });
         }
       }
       node.forEachChild(visit);
     };
     file.forEachChild(visit);
   }
-  return found;
+  return decorated.flatMap(({ symbol, detail, site }) =>
+    (symbol.kind === "class"
+      ? (membersOf.get(symbol.id) ?? []).filter((member) => !parameterMembers.has(member.id))
+      : [symbol]
+    ).map((member) => ({ id: member.id, detail, site })),
+  );
 }