Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

feat(cli): add displayName and metadata to discover API (#1925) (#1936)

rubyycheung41fe74c61bca
diff --git a/packages/cli/package.json b/packages/cli/package.json
index ad7dabf51f..232af4eb31 100644
--- a/packages/cli/package.json
+++ b/packages/cli/package.json
@@ -1,7 +1,8 @@
{
"name": "@xds/cli",
"version": "0.0.13",
- "description": "XDS design system CLI — init, swizzle, theme, templates, and agent docs",
+ "displayName": "CLI",
+ "description": "Scaffold projects, browse templates, generate themes, and get agent-ready docs from the command line.",
"author": "Meta Open Source",
"license": "MIT",
"homepage": "https://github.com/facebookexperimental/xds#readme",
diff --git a/packages/cli/src/api/discover.mjs b/packages/cli/src/api/discover.mjs
index 843e3fca36..cbfc866a2a 100644
--- a/packages/cli/src/api/discover.mjs
+++ b/packages/cli/src/api/discover.mjs
@@ -29,7 +29,14 @@ function validateDocs(docs) {
export async function discover(query, options = {}) {
const {lang = null, zh = false} = options;
const config = await loadConfig();
- const toEntry = (pkg) => ({name: pkg.name, category: pkg.category, components: pkg.components});
+ const toEntry = (pkg) => ({
+ name: pkg.name,
+ category: pkg.category,
+ components: pkg.components,
+ version: pkg.version,
+ description: pkg.description,
+ displayName: pkg.displayName,
+ });
if (config.packages.length === 0) {
return {type: 'discover.list', data: []};
diff --git a/packages/cli/src/commands/discover.mjs b/packages/cli/src/commands/discover.mjs
index a7c676404c..a3aedb136f 100644
--- a/packages/cli/src/commands/discover.mjs
+++ b/packages/cli/src/commands/discover.mjs
@@ -73,7 +73,11 @@ export function registerDiscover(program) {
for (const pkg of result.data) {
const count = pkg.components.length;
const label = count === 1 ? 'component' : 'components';
- console.log(pkg.name + ' (' + count + ' ' + label + ')');
+ const heading = pkg.displayName
+ ? pkg.displayName + ' ' + pkg.name + ' (' + count + ' ' + label + ')'
+ : pkg.name + ' (' + count + ' ' + label + ')';
+ console.log(heading);
+ if (pkg.description) console.log(' ' + pkg.description);
if (options.components) {
for (const comp of pkg.components) console.log(' ' + comp);
@@ -97,7 +101,12 @@ export function registerDiscover(program) {
case 'discover.detail': {
console.log('');
- console.log(result.data.name + ' (' + result.data.components.length + ' components)');
+ const d = result.data;
+ const detailHeading = d.displayName
+ ? d.displayName + ' ' + d.name + ' (' + d.components.length + ' components)'
+ : d.name + ' (' + d.components.length + ' components)';
+ console.log(detailHeading);
+ if (d.description) console.log(' ' + d.description);
console.log('');
for (const comp of result.data.components) console.log(' ' + comp);
console.log('');
diff --git a/packages/cli/src/lib/package-scanner.mjs b/packages/cli/src/lib/package-scanner.mjs
index efe8c4c2e6..646a2a5a1f 100644
--- a/packages/cli/src/lib/package-scanner.mjs
+++ b/packages/cli/src/lib/package-scanner.mjs
@@ -21,6 +21,9 @@ export function scanDirectory(scanDir) {
if (components.length === 0) continue;
packages.push({
name: pkg.name || entry.name,
+ version: pkg.version,
+ description: pkg.description,
+ displayName: pkg.displayName,
dir: pkgDir,
xds: pkg.xds,
category: pkg.xds.category || pkg.name || entry.name,
diff --git a/packages/cli/src/types/discover.d.ts b/packages/cli/src/types/discover.d.ts
index 6b780410da..6fdc2915db 100644
--- a/packages/cli/src/types/discover.d.ts
+++ b/packages/cli/src/types/discover.d.ts
@@ -23,6 +23,9 @@ export interface DiscoverListEntry {
name: string;
category: string;
components: string[];
+ version?: string;
+ description?: string;
+ displayName?: string;
}
/** xds --json discover @scope/name */
diff --git a/packages/core/package.json b/packages/core/package.json
index 2e5c84184d..b9527176c4 100644
--- a/packages/core/package.json
+++ b/packages/core/package.json
@@ -1,7 +1,8 @@
{
"name": "@xds/core",
"version": "0.0.13",
- "description": "XDS design system — accessible, themeable React components with automatic spacing and plugin architecture",
+ "displayName": "XDS Core",
+ "description": "The component library. Accessible, themeable React components with built-in spacing, dark mode, and StyleX styling.",
"author": "Meta Open Source",
"license": "MIT",
"homepage": "https://github.com/facebookexperimental/xds#readme",
diff --git a/packages/themes/default/package.json b/packages/themes/default/package.json
index cf94219680..46e9dd9666 100644
--- a/packages/themes/default/package.json
+++ b/packages/themes/default/package.json
@@ -1,8 +1,9 @@
{
"name": "@xds/theme-default",
"version": "0.0.13",
+ "displayName": "Default Theme",
"private": false,
- "description": "Default theme for XDS — clean neutrals with Heroicons icon set",
+ "description": "Clean neutrals with a blue accent. Pairs with Heroicons for a polished, professional look.",
"author": "Meta Open Source",
"license": "MIT",
"homepage": "https://github.com/facebookexperimental/xds#readme",
diff --git a/packages/themes/neutral/package.json b/packages/themes/neutral/package.json
index 06aa46579d..91ffc6cb5d 100644
--- a/packages/themes/neutral/package.json
+++ b/packages/themes/neutral/package.json
@@ -1,8 +1,9 @@
{
"name": "@xds/theme-neutral",
"version": "0.0.13",
+ "displayName": "Neutral Theme",
"private": false,
- "description": "Neutral theme for XDS — understated palette with Lucide icon set",
+ "description": "Understated warm grays with a subtle palette. Pairs with Lucide icons for a minimal, quiet aesthetic.",
"author": "Meta Open Source",
"license": "MIT",
"homepage": "https://github.com/facebookexperimental/xds#readme",