An open source design system that's fully customizable and agent ready
TypeScript
fix(docsite): filter package registry to installed dependencies (#2041)
Cindy Zhang1acd5c93ef33
diff --git a/apps/docsite/scripts/generate-data.mjs b/apps/docsite/scripts/generate-data.mjsindex 0205e49ee8..e35ccdf6e6 100644--- a/apps/docsite/scripts/generate-data.mjs+++ b/apps/docsite/scripts/generate-data.mjs@@ -120,6 +120,8 @@ function generatePackageRegistry() {console.log('Generating package registry...');const packageDirs = discoverPackageDirs();+ const docsitePkg = JSON.parse(fs.readFileSync(path.join(DOCSITE_ROOT, 'package.json'), 'utf-8'));+ const docsiteDeps = {...docsitePkg.dependencies, ...docsitePkg.devDependencies};const packages = packageDirs.map(dir => {@@ -129,6 +131,9 @@ function generatePackageRegistry() {// Skip private packagesif (raw.private === true) return null;+ // Skip packages not installed in the docsite+ if (docsiteDeps[raw.name] == null) return null;+const hasReadme = fs.existsSync(path.join(REPO_ROOT, dir, 'README.md'));const hasChangelog = fs.existsSync(path.join(REPO_ROOT, dir, 'CHANGELOG.md'));const readme = hasReadme@@ -685,11 +690,7 @@ export const docsCount = ${docTopics.length};function generateThemeRegistry(packages) {console.log('Generating theme registry...');- const docsitePkg = JSON.parse(fs.readFileSync(path.join(DOCSITE_ROOT, 'package.json'), 'utf-8'));- const docsiteDeps = {...docsitePkg.dependencies, ...docsitePkg.devDependencies};- const themePackages = packages.filter(p =>- p.name.startsWith('@xds/theme-') && docsiteDeps[p.name] != null- );+ const themePackages = packages.filter(p => p.name.startsWith('@xds/theme-'));if (!themePackages.length) {writeRegistry('themeRegistry.ts', `// Auto-generated — no theme packages foundimport type {XDSDefinedTheme} from '@xds/core/theme';diff --git a/apps/docsite/src/__tests__/data-extraction.test.ts b/apps/docsite/src/__tests__/data-extraction.test.tsindex 93acd17f43..861197eb74 100644--- a/apps/docsite/src/__tests__/data-extraction.test.ts+++ b/apps/docsite/src/__tests__/data-extraction.test.ts@@ -18,7 +18,7 @@ import {exampleRegistry} from '../generated/exampleRegistry';// ── Package Registry ───────────────────────────────────────────────────describe('packageRegistry', () => {- it('discovers all published packages (private packages excluded)', () => {+ it('discovers installed packages (private and uninstalled excluded)', () => {const names = packages.map(p => p.name);expect(names).toContain('@xds/core');expect(names).toContain('@xds/cli');@@ -30,6 +30,19 @@ describe('packageRegistry', () => {expect(packages.length).toBeGreaterThanOrEqual(5);});+ it('only includes packages listed in docsite dependencies', () => {+ const docsitePkg = JSON.parse(+ fs.readFileSync(new URL('../../package.json', import.meta.url), 'utf-8'),+ );+ const docsiteDeps = {+ ...docsitePkg.dependencies,+ ...docsitePkg.devDependencies,+ };+ for (const pkg of packages) {+ expect(docsiteDeps[pkg.name]).toBeDefined();+ }+ });+it('each package has required fields', () => {for (const pkg of packages) {expect(pkg.name).toBeTruthy();@@ -487,16 +500,9 @@ describe('themeRegistry', () => {expect(registrySource).toContain('themeObjects');});- it('has an import and entry for every installed theme package', () => {- const docsitePkg = JSON.parse(- fs.readFileSync(new URL('../../package.json', import.meta.url), 'utf-8'),- );- const docsiteDeps = {- ...docsitePkg.dependencies,- ...docsitePkg.devDependencies,- };- const themePackages = packages.filter(- p => p.name.startsWith('@xds/theme-') && docsiteDeps[p.name] != null,+ it('has an import and entry for every theme package', () => {+ const themePackages = packages.filter(p =>+ p.name.startsWith('@xds/theme-'),);expect(themePackages.length).toBeGreaterThan(0);for (const pkg of themePackages) {@@ -506,22 +512,6 @@ describe('themeRegistry', () => {}});- it('excludes theme packages not installed in the docsite', () => {- const docsitePkg = JSON.parse(- fs.readFileSync(new URL('../../package.json', import.meta.url), 'utf-8'),- );- const docsiteDeps = {- ...docsitePkg.dependencies,- ...docsitePkg.devDependencies,- };- const uninstalled = packages.filter(- p => p.name.startsWith('@xds/theme-') && docsiteDeps[p.name] == null,- );- for (const pkg of uninstalled) {- expect(registrySource).not.toContain(`from '${pkg.name}/built'`);- }- });-it('has no entries for non-theme packages', () => {const nonTheme = packages.filter(p => !p.name.startsWith('@xds/theme-'));for (const pkg of nonTheme) {