@astryxdesign/cli 0.7.2-canary.e2909cf → 0.7.2-canary.e4bdd70

package/api/integration/integrationCheck.doc.mjs

@@ -0,0 +1,73 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file FunctionDoc for `integrationCheck()` / `astryx integration check`.
+ * Colocated with the API function it documents; the shape source of truth stays
+ * in `integration-check.type.mjs`.
+ */
+
+/** @type {import('@astryxdesign/cli/authoring').FunctionDoc} */
+export const doc = {
+  type: 'function',
+  kind: 'api',
+  name: 'integrationCheck',
+  namespace: 'cli/api',
+  displayName: 'integrationCheck()',
+  summary:
+    'Run every source check against the integration package in the current folder, as its build does: validate, components, templates, and docs.',
+  description:
+    'Runs `validateIntegration`, `integrationComponentConflicts`, ' +
+    '`integrationTemplateConflicts`, and `integrationDocConflicts` against the ' +
+    'integration package in `options.cwd`, and counts each result the way that ' +
+    "check's own subcommand exits. The run fails when any of the four would fail on " +
+    'its own. With `strict` it also fails on any warning and on any check that did ' +
+    'not run: a package with no integration manifest, or a comparison a check ' +
+    "carries that was skipped, such as one that needs the project's TypeScript. " +
+    '`strict` adds no check: it reports those warnings and skipped work again, as ' +
+    "errors in the checks' own issue format. " +
+    'A new check, or a new failure code, joins only in a minor release, named in the release notes.',
+  importPath: '@astryxdesign/cli/api',
+  signature:
+    'integrationCheck(options?: IntegrationCheckOptions): Promise<IntegrationCheckCommandResponse>',
+  keywords: ['integration', 'check', 'build', 'strict', 'validate', 'doctor'],
+  params: [
+    {
+      name: 'options.cwd',
+      type: 'string',
+      default: 'process.cwd()',
+      description: 'The integration package folder to check.',
+    },
+    {
+      name: 'options.strict',
+      type: 'boolean',
+      default: 'false',
+      description:
+        'Also fail on any warning and on any check that did not run, not only on errors.',
+    },
+  ],
+  returns: [
+    {
+      type: 'integration.check',
+      description:
+        "`data.validated` (false when no integration manifest was found, so nothing was checked), `data.name` and `data.version` of the package, `data.strict`, and `data.checks`, one entry per check in the order they run (`validate`, `components`, `templates`, `docs`), each with `check`, `errors` (what makes that check's own subcommand exit 1), `warnings`, `skipped` (why work did not run), `failed` (whether that subcommand exits 1), and `response`, the envelope the check returns on its own. The totals are `data.errors`, `data.warnings`, and `data.skipped` (each reason prefixed with its check); an issue every check starts from, such as one about the manifest, counts once, and every other finding counts on its own. `data.unchecked` counts the items the checks list as not compared, which never fail it. With `strict`, `data.failures` lists each warning and each piece of skipped work once again as an error in the checks' own issue format ({check, severity: `error`, code, message, component, prop, fix, file, line}, each where it applies); it is empty without `strict`. `data.failed` decides the exit code.",
+    },
+  ],
+  examples: [
+    {
+      label: 'Check the local package',
+      code: 'const r = await integrationCheck();',
+    },
+    {
+      label: 'Fail on warnings too',
+      code: 'const {data} = await integrationCheck({strict: true});\nif (data.failed) process.exitCode = 1;',
+    },
+  ],
+  command: 'integration check',
+  related: [
+    'validateIntegration',
+    'integrationComponentConflicts',
+    'integrationTemplateConflicts',
+    'integrationDocConflicts',
+    'integrationPackCheck',
+  ],
+};

package/api/integration/integrationComponentConflicts.doc.mjs

@@ -10,17 +10,45 @@ export const doc = {
   namespace: 'cli/api',
   displayName: 'integrationComponentConflicts()',
   summary:
-    'Check integration component names and replaces declarations against Core.',
+    'Check integration component names, replaces declarations, and documented props.',
   description:
     'Loads one local or installed integration, compares its component names with ' +
     'Core, and returns non-blocking conflicts with the exact package-qualified ' +
     "component command required to keep an intentional overlap. Each component's " +
     'replaces is checked too: its findings are issues, errors for a package that ' +
-    'declares the CLI range that turns replacement on and warnings otherwise.',
+    'declares the CLI range that turns replacement on and warnings otherwise. ' +
+    "Each component doc's props are compared with the component's TypeScript props, " +
+    "read with the project's own `typescript`: a documented prop the code lacks, a " +
+    'prop the package declares that the doc omits, a wrong `required`, or a type ' +
+    'that does not match. A type is judged only when it reads exactly: the same ' +
+    'text as the source, once whitespace, quotes and union order are set aside (exactly, if it contains `readonly`), ' +
+    'or primitives, literals, arrays and unions of those, or a name for one, on ' +
+    'both sides, a field such as `status.type` included, and for a union of ' +
+    "props types, the type of any one member. A field the prop's variants give " +
+    "different types is listed when the doc gives only some variants' types. A " +
+    'mutable array type matches a readonly one, because callers can pass it; a ' +
+    'readonly one documented for a mutable array is a mismatch. ' +
+    '`Name = …` with a union after it ' +
+    "must match in both parts; one value after it (`Size = 'md'`) is read as a " +
+    "default. A name only TypeScript's own libraries declare is not resolved, and " +
+    '`React.X` resolves through React where the prop is declared. Every ' +
+    'other type is listed as not compared, never reported, and so is a name an ' +
+    'index signature takes unless exactly one the package declares takes it; ' +
+    'with a TypeScript older than 4.8 no type is judged. ' +
+    'Those findings are warnings in `propDrift`; without TypeScript it is ' +
+    '`skipped` with a reason.',
   importPath: '@astryxdesign/cli/api',
   signature:
     'integrationComponentConflicts(pkg?: string, options?: IntegrationAuthoringOptions): Promise<IntegrationComponentConflictResponse>',
-  keywords: ['integration', 'component', 'conflict', 'authoring', 'doctor'],
+  keywords: [
+    'integration',
+    'component',
+    'conflict',
+    'authoring',
+    'doctor',
+    'props',
+    'drift',
+  ],
   params: [
     {name: 'pkg', type: 'string', description: 'Installed package; omit for the local package.'},
     {name: 'options.cwd', type: 'string', description: 'Resolution directory.'},
@@ -29,11 +57,14 @@ export const doc = {
     {
       type: 'integration.component-conflicts',
       description:
-        '`validated` (false when no integration manifest was found, so nothing was inspected), integration identity, structural and replaces issues, and Core component-name conflicts with package-qualified commands. An active replacement that keeps the Core name it replaces is not a conflict.',
+        '`validated` (false when no integration manifest was found, so nothing was inspected), integration identity, structural and replaces issues, and Core component-name conflicts with package-qualified commands. An active replacement that keeps the Core name it replaces is not a conflict. When the manifest loads and declares a components root, `propDrift` holds the props comparison: `status` (`checked` | `skipped`), `reason` when skipped, `typescript`, `components` compared, `typesCompared` (documented prop types judged), `typesSkipped` (why none was, with a TypeScript older than 4.8), `findings` ({component, prop, kind: `not_in_code` | `not_in_doc` | `required_mismatch` | `type_mismatch`, severity: `warning`, message, doc, source, docType?, codeType?, docRequired?, codeRequired?}), `unchecked` ({component, doc, reason}), `typesNotCompared` ({component, doc, reason, props}: every other documented prop type, grouped by why it was not judged: not a form the check judges exactly (a doc type that does not parse, or a prop a mapped type builds from keys the check cannot trace, included), a field the prop\'s variants give different types, a standard prop such as `className`, or a prop declared outside the package), and `propsNotChecked` when a mapped type builds props from keys the check cannot trace to the package ({component, doc, reason, props}: no warning is drawn for those props).',
     },
   ],
   examples: [
-    {label: 'Check the local integration', code: 'await integrationComponentConflicts();'},
+    {
+      label: 'Check the local integration',
+      code: 'await integrationComponentConflicts();',
+    },
   ],
   command: 'doctor integration components',
   related: ['integrationTemplateConflicts', 'component'],

package/api/integration/pack-check.mjs

@@ -24,7 +24,6 @@ import * as path from 'node:path';
 import * as os from 'node:os';
 import {fileURLToPath} from 'node:url';
 import {spawnSync} from 'node:child_process';
-import jscodeshift from 'jscodeshift';
 import {assertWithin} from '../../foundation/fs/path-safety.mjs';
 import {resolvePackageDir} from '../../foundation/integrations/integrations.mjs';
 import {
@@ -41,6 +40,7 @@ import {
 } from '../../foundation/discovery/docs-discovery.mjs';
 import {discoverIntegrationThemes} from '../../foundation/discovery/theme-discovery.mjs';
 import {inspectPackageExport} from '../../foundation/discovery/package-exports.mjs';
+import {moduleExportsName} from '../../foundation/discovery/module-exports.mjs';
 import {
   ThemeImportError,
   resolveThemeImports,
@@ -51,6 +51,9 @@ import {
 } from '../theme/build/build.mjs';
 import {
   discoverIntegrationComponents,
+  docStem,
+  familyImports,
+  isIntegrationMember,
   resolveIntegrationImportPath,
 } from '../../foundation/discovery/component-discovery.mjs';
 import {loadComponentReplacements} from '../component/_adapter.mjs';
@@ -307,98 +310,6 @@ function extractTarball(tgzPath, extractDir) {
   }
 }
 
-const MODULE_EXTENSIONS = ['.mjs', '.js', '.mts', '.ts', '.tsx', '.jsx'];
-const moduleParser = jscodeshift.withParser('tsx');
-
-/** @param {unknown} specifier @param {string} fromFile */
-function resolveLocalModule(specifier, fromFile) {
-  if (typeof specifier !== 'string' || !specifier.startsWith('.')) return null;
-  const base = path.resolve(path.dirname(fromFile), specifier);
-  const candidates = [
-    base,
-    ...MODULE_EXTENSIONS.map(extension => `${base}${extension}`),
-    ...MODULE_EXTENSIONS.map(extension => path.join(base, `index${extension}`)),
-  ];
-  return candidates.find(candidate => fs.existsSync(candidate)) ?? null;
-}
-
-/** @param {any} declaration @param {string} exportName */
-function declarationExports(declaration, exportName) {
-  if (!declaration) return false;
-  if (['FunctionDeclaration', 'ClassDeclaration'].includes(declaration.type)) {
-    return declaration.id?.name === exportName;
-  }
-  if (declaration.type !== 'VariableDeclaration') return false;
-  return declaration.declarations.some(
-    (/** @type {any} */ item) =>
-      item.id?.type === 'Identifier' && item.id.name === exportName,
-  );
-}
-
-/**
- * Check one resolved module's static export surface without executing package
- * code. Local ESM re-exports are followed recursively.
- *
- * @param {string} file
- * @param {string} exportName
- * @param {Set<string>} [seen]
- */
-function moduleExportsName(file, exportName, seen = new Set()) {
-  const identity = `${file}\0${exportName}`;
-  if (seen.has(identity) || !fs.existsSync(file)) return false;
-  seen.add(identity);
-
-  let root;
-  try {
-    root = moduleParser(fs.readFileSync(file, 'utf-8'));
-  } catch {
-    return false;
-  }
-
-  let found = false;
-  root
-    .find(moduleParser.ExportNamedDeclaration)
-    .forEach((/** @type {any} */ exportPath) => {
-      if (found) return;
-      const node = exportPath.node;
-      if (declarationExports(node.declaration, exportName)) {
-        found = true;
-        return;
-      }
-      for (const specifier of node.specifiers ?? []) {
-        const exported = specifier.exported?.name ?? specifier.exported?.value;
-        if (exported !== exportName) continue;
-        if (!node.source) {
-          found = true;
-          return;
-        }
-        const target = resolveLocalModule(node.source.value, file);
-        const imported =
-          specifier.local?.name ?? specifier.local?.value ?? exportName;
-        if (target && moduleExportsName(target, imported, seen)) {
-          found = true;
-          return;
-        }
-      }
-    });
-  if (found) return true;
-  if (
-    exportName === 'default' &&
-    root.find(moduleParser.ExportDefaultDeclaration).size() > 0
-  ) {
-    return true;
-  }
-
-  root
-    .find(moduleParser.ExportAllDeclaration)
-    .forEach((/** @type {any} */ exportPath) => {
-      if (found) return;
-      const target = resolveLocalModule(exportPath.node.source?.value, file);
-      if (target && moduleExportsName(target, exportName, seen)) found = true;
-    });
-  return found;
-}
-
 /**
  * Whether any of these doc files has a section that sets `id`.
  * @param {string[]} files
@@ -472,15 +383,20 @@ async function validatePackedComponentExports(integration, scratchBase) {
   const issues = [];
   /** @type {Array<{name: string, specifier: string}>} */
   const components = [];
+  // A family doc backs several records: load it, and report it, once.
+  const loads = new Map();
   for (const record of records) {
+    const first = !loads.has(record.docPath);
+    if (first) loads.set(record.docPath, loadComponentDoc(record.docPath));
     let docs;
     try {
-      docs = await loadComponentDoc(record.docPath);
+      docs = await loads.get(record.docPath);
     } catch (err) {
+      if (!first) continue;
       issues.push(
         error(
           'component_doc_unloadable',
-          `Component "${record.name}" doc at "${record.docPath}" could not be loaded: ${err instanceof Error ? err.message : String(err)}`,
+          `Component "${docStem(record.docPath)}" doc at "${record.docPath}" could not be loaded: ${err instanceof Error ? err.message : String(err)}`,
         ),
       );
       continue;
@@ -1085,6 +1001,24 @@ export async function integrationPackCheck(options = {}) {
   const fileInv = computeRequiredFiles(loaded);
   const {identities: localIdentities, errors: localDiscoveryErrors} =
     await collectIdentities(loaded);
+  // A family lists its members from the module its import names, which the
+  // pack lifecycle may build or rebuild, so they are compared as local
+  // discovery lists them after the pack.
+  const familiesBefore = familyImports(loaded).map(family => family.docPath);
+  /**
+   * @param {Array<{name: string, docPath: string|null}>} records
+   * @param {Set<string>} families
+   */
+  const membersOf = (records, families) =>
+    records
+      .filter(
+        r =>
+          r.docPath != null &&
+          families.has(r.docPath) &&
+          isIntegrationMember(r),
+      )
+      .map(r => r.name);
+  const recordsBefore = discoverIntegrationComponents(loaded);
   for (const discoveryError of localDiscoveryErrors) {
     issues.push(
       error(
@@ -1345,7 +1279,27 @@ export async function integrationPackCheck(options = {}) {
       );
     }
 
-    issues.push(...compareIdentities(localIdentities, packedIdentities));
+    const families = new Set([
+      ...familiesBefore,
+      ...familyImports(loaded).map(family => family.docPath),
+    ]);
+    let localComponents = localIdentities.components;
+    if (families.size > 0) {
+      const stale = new Set(membersOf(recordsBefore, families));
+      const built = new Set(
+        membersOf(discoverIntegrationComponents(loaded), families),
+      );
+      const {identities: afterPack} = await collectIdentities(loaded);
+      localComponents = [
+        ...new Set([
+          ...localComponents.filter(name => !stale.has(name)),
+          ...afterPack.components.filter(name => built.has(name)),
+        ]),
+      ].sort();
+    }
+    // The receipt reports the local inventory that was compared.
+    const comparedLocal = {...localIdentities, components: localComponents};
+    issues.push(...compareIdentities(comparedLocal, packedIdentities));
     issues.push(
       ...(await validatePackedThemeExports(
         loaded,
@@ -1367,7 +1321,7 @@ export async function integrationPackCheck(options = {}) {
       pkgVersion,
       fileInv,
       packResult,
-      localIdentities,
+      comparedLocal,
       packedIdentities,
       issues,
     );