@astryxdesign/cli 0.7.2-canary.fe2c655 → 0.7.3-canary.02f5fe4

package/api/integration/validate-integration-case-disk.test.mjs

@@ -0,0 +1,111 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file A component doc whose file name differs from its source only in
+ * letter case, on a case-insensitive disk (macOS, Windows), where discovery
+ * still pairs the two: a warning naming the rename, not an error. The disk is
+ * simulated by finding the doc's source case-insensitively.
+ */
+
+import {afterEach, beforeEach, describe, expect, it, vi} from 'vitest';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+
+vi.mock(
+  '../../foundation/discovery/component-discovery.mjs',
+  async importOriginal => {
+    const original =
+      /** @type {typeof import('../../foundation/discovery/component-discovery.mjs')} */ (
+        await importOriginal()
+      );
+    return {
+      ...original,
+      /** @param {string} docPath */
+      integrationSourceForDoc: docPath => {
+        const dir = path.dirname(docPath);
+        const want = `${path
+          .basename(docPath)
+          .replace(/\.doc\.(ts|mjs|js)$/u, '')}.tsx`.toLowerCase();
+        const found = fs
+          .readdirSync(dir)
+          .find(name => name.toLowerCase() === want);
+        return found ? path.join(dir, found) : null;
+      },
+    };
+  },
+);
+
+const {validateIntegration} = await import('./validate-integration.mjs');
+
+/** @type {string} */
+let tmpDir;
+
+beforeEach(() => {
+  tmpDir = fs.mkdtempSync(path.join(process.cwd(), '.astryx-case-disk-'));
+});
+
+afterEach(() => {
+  fs.rmSync(tmpDir, {recursive: true, force: true});
+});
+
+describe('a doc whose name differs from its source only in case, on a case-insensitive disk', () => {
+  it('lists source_without_component_doc with the rename, without an issue', async () => {
+    fs.writeFileSync(
+      path.join(tmpDir, 'package.json'),
+      JSON.stringify({name: '@acme/kit', version: '1.0.0'}),
+    );
+    fs.writeFileSync(
+      path.join(tmpDir, 'astryx.integration.mjs'),
+      "export default {components: './components'};\n",
+    );
+    fs.mkdirSync(path.join(tmpDir, 'components'));
+    fs.writeFileSync(
+      path.join(tmpDir, 'components', 'Acmewidget.doc.mjs'),
+      "export default {type: 'component', name: 'AcmeWidget', displayName: 'AcmeWidget', usage: {description: 'A widget.'}, props: []};\n",
+    );
+    fs.writeFileSync(
+      path.join(tmpDir, 'components', 'AcmeWidget.tsx'),
+      'export function AcmeWidget() { return null; }\n',
+    );
+
+    const {data} = await validateIntegration(undefined, {cwd: tmpDir});
+    expect(data.issues).toEqual([]);
+    expect(data.notes).toEqual([
+      {
+        code: 'source_without_component_doc',
+        message:
+          'Component doc "Acmewidget.doc.mjs" and its source "AcmeWidget.tsx" differ only in letter case. They pair on a case-insensitive disk (macOS, Windows) but not on Linux, where CI and most installs run, so there the component is missing. Fix: rename Acmewidget.doc.mjs to AcmeWidget.doc.mjs.',
+      },
+    ]);
+  });
+
+  it('lists a hidden doc that pairs with its source, without an issue', async () => {
+    fs.writeFileSync(
+      path.join(tmpDir, 'package.json'),
+      JSON.stringify({name: '@acme/kit', version: '1.0.0'}),
+    );
+    fs.writeFileSync(
+      path.join(tmpDir, 'astryx.integration.mjs'),
+      "export default {components: './components'};\n",
+    );
+    fs.mkdirSync(path.join(tmpDir, 'components'));
+    fs.writeFileSync(
+      path.join(tmpDir, 'components', 'Acmewidget.doc.mjs'),
+      "export default {type: 'component',\n  hidden: true,\n  name: 'AcmeWidget', displayName: 'AcmeWidget', usage: {description: 'A widget.'}, props: []};\n",
+    );
+    fs.writeFileSync(
+      path.join(tmpDir, 'components', 'AcmeWidget.tsx'),
+      'export function AcmeWidget() { return null; }\n',
+    );
+
+    const {data} = await validateIntegration(undefined, {cwd: tmpDir});
+    expect(data.issues).toEqual([]);
+    expect(data.notes).toEqual([
+      {
+        code: 'source_without_component_doc',
+        message:
+          'Hidden component doc "Acmewidget.doc.mjs" and its source "AcmeWidget.tsx" differ only in letter case. They pair on a case-insensitive disk (macOS, Windows) but not on Linux, where CI and most installs run. Fix: rename Acmewidget.doc.mjs to AcmeWidget.doc.mjs.',
+      },
+    ]);
+  });
+});

package/api/integration/validate-integration-fixes.test.mjs

@@ -38,6 +38,9 @@ const componentDoc = name =>
 /** @param {string} name */
 const componentSource = name => `export function ${name}() { return null; }\n`;
 /** @param {string} name */
+const templateSource = name =>
+  `export default function ${name}() { return null; }\n`;
+/** @param {string} name */
 const topic = name =>
   `export default ${JSON.stringify({
     type: 'generic',
@@ -396,9 +399,9 @@ describe('unreachable_contribution fixes hold when followed', () => {
     const dir = writePackage({
       [MANIFEST]: manifest({templates: './templates'}),
       'templates/hero.doc.mjs': `export default {type: 'page', name: 'hero', displayName: 'Hero'};\n`,
-      'templates/hero.tsx': componentSource('Hero'),
+      'templates/hero.tsx': templateSource('Hero'),
       'src/blocks/Carousel.doc.mjs': `export default {type: 'block', name: 'Carousel', displayName: 'Carousel', aspectRatio: 1};\n`,
-      'src/blocks/Carousel.tsx': componentSource('Carousel'),
+      'src/blocks/Carousel.tsx': templateSource('Carousel'),
     });
 
     const message = only(await issuesOf(dir), 'unreachable_contribution');
@@ -421,7 +424,7 @@ describe('unreachable_contribution fixes hold when followed', () => {
       [MANIFEST]: manifest({templates: './templates'}),
       'templates/.keep': '',
       'src/blocks/Carousel.doc.mjs': `export default {type: 'block', name: 'Carousel', displayName: 'Carousel', aspectRatio: 1};\n`,
-      'src/blocks/Carousel.tsx': componentSource('Carousel'),
+      'src/blocks/Carousel.tsx': templateSource('Carousel'),
     });
 
     const message = only(await issuesOf(dir), 'unreachable_contribution');
@@ -685,9 +688,9 @@ describe('fixes never move a contribution onto a name its root already has', ()
     const dir = writePackage({
       [MANIFEST]: manifest({templates: './templates'}),
       'templates/hero.doc.mjs': `export default {type: 'page', name: 'hero', displayName: 'Hero'};\n`,
-      'templates/hero.tsx': componentSource('Hero'),
+      'templates/hero.tsx': templateSource('Hero'),
       'extra/hero.doc.mjs': `export default {type: 'page', name: 'hero', displayName: 'Hero'};\n`,
-      'extra/hero.tsx': componentSource('Hero'),
+      'extra/hero.tsx': templateSource('Hero'),
     });
 
     const message = only(await issuesOf(dir), 'unreachable_contribution');
@@ -1131,6 +1134,71 @@ describe('source_without_component_doc fixes hold when followed', () => {
   });
 });
 
+describe('source_without_template_doc fixes hold when followed', () => {
+  it('adds the named doc, which resolves the warning', async () => {
+    const dir = writePackage({
+      [MANIFEST]: manifest({templates: './templates'}),
+      'templates/hero.tsx': templateSource('Hero'),
+      'templates/hero.test.tsx': templateSource('HeroTest'),
+    });
+
+    const message = only(await issuesOf(dir), 'source_without_template_doc');
+    expect(message).toBe(
+      "Template source \"hero.tsx\" has no same-stem metadata file hero.doc.mjs, so `astryx template` never lists it. Fix: add hero.doc.mjs beside it with type: 'page' or 'block'; `astryx docs authoring integration-template-doc` lists its fields. If it is not a template, move it out of the templates root.",
+    );
+
+    const fixed = follow(dir, {
+      write: {
+        'templates/hero.doc.mjs': `export default {type: 'page', name: 'hero', displayName: 'Hero'};\n`,
+      },
+    });
+    expect(await issuesOf(fixed)).toEqual([]);
+  });
+
+  it('checks a dotted template id, but no test, spec or story file', async () => {
+    const dir = writePackage({
+      [MANIFEST]: manifest({templates: './templates'}),
+      'templates/landing.page.tsx': templateSource('LandingPage'),
+      'templates/hero.test.tsx': templateSource('HeroTest'),
+      'templates/hero.spec.tsx': templateSource('HeroSpec'),
+      'templates/hero.stories.tsx': templateSource('HeroStories'),
+    });
+
+    const message = only(await issuesOf(dir), 'source_without_template_doc');
+    expect(message).toContain(
+      'Template source "landing.page.tsx" has no same-stem metadata file landing.page.doc.mjs',
+    );
+
+    const fixed = follow(dir, {
+      write: {
+        'templates/landing.page.doc.mjs': `export default {type: 'page', name: 'landing.page', displayName: 'Landing'};\n`,
+      },
+    });
+    expect(await issuesOf(fixed)).toEqual([]);
+  });
+
+  it('never flags a helper in a subfolder of the templates root', async () => {
+    const dir = writePackage({
+      [MANIFEST]: manifest({templates: './templates'}),
+      'templates/hero.doc.mjs': `export default {type: 'page', name: 'hero', displayName: 'Hero'};\n`,
+      'templates/hero.tsx': templateSource('Hero'),
+      'templates/hero/HeroCard.tsx': templateSource('HeroCard'),
+    });
+
+    expect(await issuesOf(dir)).toEqual([]);
+  });
+
+  it('accepts a released .template.mjs spec as the metadata', async () => {
+    const dir = writePackage({
+      [MANIFEST]: manifest({templates: './templates'}),
+      'templates/hero.tsx': templateSource('Hero'),
+      'templates/hero.template.mjs': `export default {type: 'page', name: 'hero', displayName: 'Hero'};\n`,
+    });
+
+    expect(await issuesOf(dir)).toEqual([]);
+  });
+});
+
 describe('codemod fixes hold when followed', () => {
   it('moves a stray codemod into a version folder, and renames a mis-named one', async () => {
     const dir = writePackage({