@davidvornholt/standards 0.26.1 → 0.26.2

package/README.md

@@ -97,7 +97,7 @@ bun standards structure --profile source
 
 `doctor` checks project-owned integration points such as `biome.jsonc`, `AGENTS.local.md`, package scripts, sync policy, settings overlays, and Dependabot inputs.
 
-`structure` checks the exact Bun declaration, workspace scripts, internal dependency versions, package exports, TypeScript inheritance, accessibility wiring, workspace READMEs, and CI secret structure. The `source` profile records the few intentional differences in this repository itself.
+`structure` checks the exact Bun declaration, workspace scripts, internal dependency versions, package exports, TypeScript inheritance, accessibility wiring, and CI secret structure. The `source` profile records the few intentional differences in this repository itself.
 
 ## dependabot
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@davidvornholt/standards",
-  "version": "0.26.1",
+  "version": "0.26.2",
   "description": "Bootstrap, synchronize, and validate davidvornholt/standards consumers",
   "license": "MIT",
   "repository": {
@@ -166,7 +166,6 @@
     "src/structure-check.ts",
     "src/structure-bun-version.ts",
     "src/structure-profile.ts",
-    "src/structure-readme.ts",
     "src/structure-secret-document.ts",
     "src/structure-script.ts",
     "src/structure-secrets.ts",

package/src/cli.ts

@@ -1189,7 +1189,7 @@ const parseArgs = (argv: ReadonlyArray<string>): CliOptions => {
 
 // Canonical monorepo structure gate: workspace and root script shapes,
 // internal versioning, `exports`, tsconfig inheritance, a11y wiring,
-// repo-owned workspace READMEs, and the undecrypted CI secrets contract
+// and the undecrypted CI secrets contract
 // (SOPS shape mirroring plus the keys the synced workflows require).
 // The `source` profile instead pins the standards template repository's own
 // deliberate exceptions to the consumer contract.

package/src/structure-check.ts

@@ -1,6 +1,7 @@
 import { existsSync } from 'node:fs';
 import { readdir } from 'node:fs/promises';
 import { isAbsolute, join } from 'node:path';
+import { isContainedPath } from './contained-path';
 import { isRecord } from './github-settings-parse';
 import { readJsonFile } from './json-file';
 import { collectBunVersionProblems } from './structure-bun-version';
@@ -9,7 +10,6 @@ import {
   rootScriptExpectations,
   type StructureProfile,
 } from './structure-profile';
-import { collectWorkspaceReadmeProblems } from './structure-readme';
 import { filteredTurboAliasProblem, hasSafeCommands } from './structure-script';
 import { collectCiSecretsProblems } from './structure-secrets';
 import { inspectWorkspace, type Workspace } from './structure-workspace';
@@ -106,6 +106,12 @@ const loadWorkspace = async (
   if (!existsSync(path)) {
     return { workspace: null, problem: null };
   }
+  if (!isContainedPath(consumer, `${rel}/package.json`, 'file')) {
+    return {
+      workspace: null,
+      problem: `${rel}: package.json must be a contained regular file; symlinked paths are not allowed`,
+    };
+  }
   const manifest = await readJsonFile(path);
   if (manifest === null) {
     return {
@@ -174,16 +180,9 @@ export const collectStructureProblems = async (
       .map((ws) => ws.manifest.name)
       .filter((name): name is string => typeof name === 'string'),
   );
-  const [inspections, readmeProblems] = await Promise.all([
-    Promise.all(
-      workspaces.map((ws) => inspectWorkspace(ws, workspaceNames, profile)),
-    ),
-    collectWorkspaceReadmeProblems(
-      consumer,
-      profile,
-      workspaces.map((ws) => ws.rel),
-    ),
-  ]);
+  const inspections = await Promise.all(
+    workspaces.map((ws) => inspectWorkspace(ws, workspaceNames, profile)),
+  );
   const requireA11y = inspections.some((i) => i.hasA11ySuite);
   return [
     ...declaration.problems,
@@ -193,7 +192,6 @@ export const collectStructureProblems = async (
     ...collectBunVersionProblems(root),
     ...inspectRootScripts(root, profile, requireA11y),
     ...inspections.flatMap((i) => [...i.problems]),
-    ...readmeProblems,
     ...secretsProblems,
   ];
 };

package/src/structure-readme.ts

@@ -1,85 +0,0 @@
-import { lstat, readFile } from 'node:fs/promises';
-import { join } from 'node:path';
-import { isContainedPath } from './contained-path';
-import { readJsonFile } from './json-file';
-import type { StructureProfile } from './structure-profile';
-
-const SYNC_MANIFEST = 'sync-standards.json';
-const TRAILING_SLASHES = /\/+$/u;
-const MANIFEST_REQUIREMENT = `${SYNC_MANIFEST}: must contain a JSON object with a "paths" array of strings; the structure gate reads it to tell canonical workspaces from repo-owned ones`;
-const MANIFEST_CONTAINMENT = `${SYNC_MANIFEST}: must be a contained regular file; symlinked paths are not allowed`;
-
-type CanonicalRels = {
-  readonly rels: ReadonlySet<string>;
-  readonly problem: string | null;
-};
-
-// Canonical workspaces are synced from the standards template and cannot be
-// fixed in a consumer checkout, so the consumer profile exempts them from
-// repo-owned documentation rules. The source repository owns those workspaces,
-// so the source profile exempts nothing.
-const canonicalWorkspaceRels = async (
-  consumer: string,
-  profile: StructureProfile,
-): Promise<CanonicalRels> => {
-  if (profile === 'source') {
-    return { rels: new Set(), problem: null };
-  }
-  const manifestPath = join(consumer, SYNC_MANIFEST);
-  const manifestInfo = await lstat(manifestPath).catch(() => null);
-  if (
-    manifestInfo !== null &&
-    !isContainedPath(consumer, SYNC_MANIFEST, 'file')
-  ) {
-    return { rels: new Set(), problem: MANIFEST_CONTAINMENT };
-  }
-  const manifest = await readJsonFile(manifestPath);
-  const paths = manifest?.paths;
-  if (
-    !(
-      Array.isArray(paths) &&
-      paths.every((path): path is string => typeof path === 'string')
-    )
-  ) {
-    return { rels: new Set(), problem: MANIFEST_REQUIREMENT };
-  }
-  return {
-    rels: new Set(paths.map((path) => path.replace(TRAILING_SLASHES, ''))),
-    problem: null,
-  };
-};
-
-const readmeProblem = async (
-  consumer: string,
-  rel: string,
-): Promise<string | null> => {
-  const readmeRel = `${rel}/README.md`;
-  const readmePath = join(consumer, readmeRel);
-  const info = await lstat(readmePath).catch(() => null);
-  if (info !== null && !isContainedPath(consumer, readmeRel, 'file')) {
-    return `${rel}: README.md must be a contained regular file; symlinked paths are not allowed`;
-  }
-  const raw = await readFile(readmePath, 'utf8').catch(() => null);
-  return raw !== null && raw.trim() !== ''
-    ? null
-    : `${rel}: repo-owned workspace must have a non-empty README.md`;
-};
-
-export const collectWorkspaceReadmeProblems = async (
-  consumer: string,
-  profile: StructureProfile,
-  rels: ReadonlyArray<string>,
-): Promise<ReadonlyArray<string>> => {
-  const canonical = await canonicalWorkspaceRels(consumer, profile);
-  if (canonical.problem !== null) {
-    // Without the manifest the gate cannot tell canonical workspaces from
-    // repo-owned ones, so it fails on the manifest instead of guessing.
-    return [canonical.problem];
-  }
-  const problems = await Promise.all(
-    rels
-      .filter((rel) => !canonical.rels.has(rel))
-      .map((rel) => readmeProblem(consumer, rel)),
-  );
-  return problems.filter((problem): problem is string => problem !== null);
-};