@beatzball/create-litro 0.1.3 → 0.2.0

package/src/scaffold.test.ts

@@ -225,4 +225,152 @@ describe('scaffold', () => {
         .rejects.toThrow();
     });
   });
+
+  // ---------------------------------------------------------------------------
+  // starlight recipe
+  // ---------------------------------------------------------------------------
+
+  it('starlight recipe writes litro.recipe.json with ssg mode', async () => {
+    await withTmpDir(async (dir) => {
+      const targetDir = join(dir, 'my-docs');
+      await scaffold('starlight', { projectName: 'my-docs', mode: 'ssg' }, targetDir);
+
+      const { existsSync } = await import('node:fs');
+      expect(existsSync(join(targetDir, 'litro.recipe.json'))).toBe(true);
+
+      const manifest = JSON.parse(await readFile(join(targetDir, 'litro.recipe.json'), 'utf-8')) as Record<string, unknown>;
+      expect(manifest.recipe).toBe('starlight');
+      expect(manifest.mode).toBe('ssg');
+      expect(manifest.contentDir).toBe('content');
+    });
+  });
+
+  it('starlight recipe writes all expected files', async () => {
+    await withTmpDir(async (dir) => {
+      const targetDir = join(dir, 'my-docs');
+      await scaffold('starlight', { projectName: 'my-docs', mode: 'ssg' }, targetDir);
+
+      const { existsSync } = await import('node:fs');
+      // Core config
+      expect(existsSync(join(targetDir, 'package.json'))).toBe(true);
+      expect(existsSync(join(targetDir, 'tsconfig.json'))).toBe(true);
+      expect(existsSync(join(targetDir, 'nitro.config.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'vite.config.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'app.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, '.gitignore'))).toBe(true);
+      expect(existsSync(join(targetDir, 'litro.recipe.json'))).toBe(true);
+      // Server
+      expect(existsSync(join(targetDir, 'server/starlight.config.js'))).toBe(true);
+      expect(existsSync(join(targetDir, 'server/routes/[...].ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'server/middleware/vite-dev.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'server/stubs/page-manifest.ts'))).toBe(true);
+      // Pages
+      expect(existsSync(join(targetDir, 'pages/index.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'pages/docs/[slug].ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'pages/blog/index.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'pages/blog/[slug].ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'pages/blog/tags/[tag].ts'))).toBe(true);
+      // Utilities
+      expect(existsSync(join(targetDir, 'src/extract-headings.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'src/date-utils.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'src/route-meta.ts'))).toBe(true);
+      // Components
+      expect(existsSync(join(targetDir, 'src/components/starlight-page.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'src/components/starlight-header.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'src/components/starlight-sidebar.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'src/components/starlight-toc.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'src/components/sl-card.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'src/components/sl-card-grid.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'src/components/sl-badge.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'src/components/sl-aside.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'src/components/sl-tabs.ts'))).toBe(true);
+      expect(existsSync(join(targetDir, 'src/components/sl-tab-item.ts'))).toBe(true);
+      // Content
+      expect(existsSync(join(targetDir, 'content/docs/.11tydata.json'))).toBe(true);
+      expect(existsSync(join(targetDir, 'content/docs/getting-started.md'))).toBe(true);
+      expect(existsSync(join(targetDir, 'content/blog/.11tydata.json'))).toBe(true);
+      expect(existsSync(join(targetDir, 'content/blog/welcome.md'))).toBe(true);
+      // Public
+      expect(existsSync(join(targetDir, 'public/styles/starlight.css'))).toBe(true);
+      // Data
+      expect(existsSync(join(targetDir, '_data/metadata.js'))).toBe(true);
+    });
+  });
+
+  it('starlight recipe interpolates {{projectName}} in package.json', async () => {
+    await withTmpDir(async (dir) => {
+      const targetDir = join(dir, 'awesome-docs');
+      await scaffold('starlight', { projectName: 'awesome-docs', mode: 'ssg' }, targetDir);
+
+      const pkg = JSON.parse(await readFile(join(targetDir, 'package.json'), 'utf-8')) as Record<string, unknown>;
+      expect(pkg.name).toBe('awesome-docs');
+    });
+  });
+
+  it('starlight recipe interpolates {{projectName}} in server/starlight.config.js', async () => {
+    await withTmpDir(async (dir) => {
+      const targetDir = join(dir, 'my-docs-site');
+      await scaffold('starlight', { projectName: 'my-docs-site', mode: 'ssg' }, targetDir);
+
+      const config = await readFile(join(targetDir, 'server/starlight.config.js'), 'utf-8');
+      expect(config).toContain('my-docs-site');
+      expect(config).not.toContain('{{projectName}}');
+    });
+  });
+
+  it('starlight recipe has no un-interpolated {{ }} in any output file', async () => {
+    await withTmpDir(async (dir) => {
+      const targetDir = join(dir, 'my-docs');
+      await scaffold('starlight', { projectName: 'my-docs', mode: 'ssg' }, targetDir);
+
+      const binaryExts = new Set(['.png', '.jpg', '.jpeg', '.gif', '.ico', '.webp', '.svg',
+        '.woff', '.woff2', '.ttf', '.eot', '.otf', '.pdf', '.zip', '.gz', '.tar', '.gitkeep']);
+
+      async function collectFiles(d: string): Promise<string[]> {
+        const { readdir: rd } = await import('node:fs/promises');
+        const entries = await rd(d, { withFileTypes: true });
+        const results: string[] = [];
+        for (const e of entries) {
+          const p = join(d, e.name);
+          if (e.isDirectory()) results.push(...(await collectFiles(p)));
+          else results.push(p);
+        }
+        return results;
+      }
+
+      const files = await collectFiles(targetDir);
+      for (const file of files) {
+        const extPart = file.includes('.') ? `.${file.split('.').pop()}` : '';
+        if (binaryExts.has(extPart.toLowerCase())) continue;
+        const content = await readFile(file, 'utf-8');
+        const matches = content.match(/\{\{[^}]+\}\}/g);
+        if (matches) {
+          throw new Error(`Un-interpolated placeholder in ${file}: ${matches.join(', ')}`);
+        }
+      }
+    });
+  });
+
+  it('starlight recipe page files use plain <a> tags, not <litro-link>', async () => {
+    // SSG pages must use <a> for full-page-reload navigation so each pre-rendered
+    // page loads its own __litro_data__. <litro-link> triggers SPA navigation which
+    // leaves serverData=null on the navigated page (no __litro_data__ in DOM).
+    await withTmpDir(async (dir) => {
+      const targetDir = join(dir, 'my-docs');
+      await scaffold('starlight', { projectName: 'my-docs', mode: 'ssg' }, targetDir);
+
+      const pageFiles = [
+        join(targetDir, 'pages/index.ts'),
+        join(targetDir, 'pages/docs/[slug].ts'),
+        join(targetDir, 'pages/blog/index.ts'),
+        join(targetDir, 'pages/blog/[slug].ts'),
+        join(targetDir, 'pages/blog/tags/[tag].ts'),
+      ];
+
+      for (const file of pageFiles) {
+        const content = await readFile(file, 'utf-8');
+        expect(content, `${file} should not contain <litro-link>`).not.toContain('litro-link');
+      }
+    });
+  });
 });