An open source design system that's fully customizable and agent ready
TypeScript
feat: auto-sync package.json exports with source condition (#291)
Cindy Zhang197cc06d90f1
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.ymlindex a4dd23ccf9..6d8d329c49 100644--- a/.github/workflows/deploy.yml+++ b/.github/workflows/deploy.yml@@ -1,5 +1,5 @@# Deploy Storybook to GitHub Pages-# Only runs on push to main — simple and sequential: test → deploy+# Only runs on push to main — simple and sequential: sync → test → deployname: Deployon:@@ -17,10 +17,36 @@ concurrency:cancel-in-progress: falsejobs:+ # Sync package.json exports with src/ and commit if changed.+ # Runs first so test and deploy always see correct exports.+ sync-exports:+ # Skip runs triggered by our own auto-commits to avoid loops+ if: "!contains(github.event.head_commit.message, '[skip ci]')"+ runs-on: ubuntu-latest+ steps:+ - uses: actions/checkout@v4++ - name: Sync package.json exports+ run: node scripts/sync-exports.js++ - name: Commit and push if changed+ run: |+ git diff --quiet packages/core/package.json && exit 0++ git config user.name "github-actions[bot]"+ git config user.email "github-actions[bot]@users.noreply.github.com"+ git add packages/core/package.json+ git commit -m "chore: sync package.json exports [skip ci]"+ git push+test:+ needs: sync-exports+ if: always() && !cancelled()runs-on: ubuntu-lateststeps:- uses: actions/checkout@v4+ with:+ ref: main- uses: actions/setup-node@v4with:@@ -39,6 +65,8 @@ jobs:steps:- name: Checkoutuses: actions/checkout@v4+ with:+ ref: main- name: Setup Node.jsuses: actions/setup-node@v4diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex bae38df2fd..b87998986b 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -217,19 +217,10 @@ export const Default: Story = {export * from './MyComponent';```-### 7. Update tsup Entry (if tree-shaking needed)--```ts-// packages/core/tsup.config.ts-export default defineConfig({- entry: [- 'src/index.ts',- 'src/Button/index.ts',- 'src/MyComponent/index.ts', // Add this- ],- // ...-});-```+> **Note:** Do not manually edit the `"exports"` field in `packages/core/package.json`.+> It is auto-generated from the `src/` directory by `scripts/sync-exports.js` and+> committed automatically when changes land on `main`. If you need to verify your+> component will be included, run `yarn sync:exports:check`.## Testingdiff --git a/package.json b/package.jsonindex 7a5c12a596..71d5345e6a 100644--- a/package.json+++ b/package.json@@ -21,6 +21,8 @@"storybook": "yarn workspace @xds/storybook dev","storybook:build": "yarn workspace @xds/storybook build","docs": "yarn workspace @xds/docs dev",+ "sync:exports": "node scripts/sync-exports.js",+ "sync:exports:check": "node scripts/sync-exports.js --check","package:source": "node scripts/package-source.js","changeset": "changeset","version-packages": "changeset version",diff --git a/packages/core/package.json b/packages/core/package.jsonindex f2b6320c4b..91f0be80b4 100644--- a/packages/core/package.json+++ b/packages/core/package.json@@ -14,128 +14,302 @@],"exports": {".": {+ "source": "./src/index.ts","types": "./dist/index.d.ts","import": "./dist/index.mjs","require": "./dist/index.js"},"./reset.css": "./src/reset.css","./typography.css": "./src/typography.css",+ "./theme/tokens.stylex": {+ "source": "./src/theme/tokens.stylex.ts",+ "types": "./dist/theme/tokens.stylex.d.ts",+ "import": "./dist/theme/tokens.stylex.mjs",+ "require": "./dist/theme/tokens.stylex.js"+ },+ "./xds.md": "./xds.md",+ "./AppShell": {+ "source": "./src/AppShell/index.ts",+ "types": "./dist/AppShell/index.d.ts",+ "import": "./dist/AppShell/index.mjs",+ "require": "./dist/AppShell/index.js"+ },+ "./AspectRatio": {+ "source": "./src/AspectRatio/index.ts",+ "types": "./dist/AspectRatio/index.d.ts",+ "import": "./dist/AspectRatio/index.mjs",+ "require": "./dist/AspectRatio/index.js"+ },"./Avatar": {+ "source": "./src/Avatar/index.ts","types": "./dist/Avatar/index.d.ts","import": "./dist/Avatar/index.mjs","require": "./dist/Avatar/index.js"},"./Badge": {+ "source": "./src/Badge/index.ts","types": "./dist/Badge/index.d.ts","import": "./dist/Badge/index.mjs","require": "./dist/Badge/index.js"},+ "./Banner": {+ "source": "./src/Banner/index.ts",+ "types": "./dist/Banner/index.d.ts",+ "import": "./dist/Banner/index.mjs",+ "require": "./dist/Banner/index.js"+ },+ "./Breadcrumbs": {+ "source": "./src/Breadcrumbs/index.ts",+ "types": "./dist/Breadcrumbs/index.d.ts",+ "import": "./dist/Breadcrumbs/index.mjs",+ "require": "./dist/Breadcrumbs/index.js"+ },"./Button": {+ "source": "./src/Button/index.ts","types": "./dist/Button/index.d.ts","import": "./dist/Button/index.mjs","require": "./dist/Button/index.js"},+ "./Calendar": {+ "source": "./src/Calendar/index.ts",+ "types": "./dist/Calendar/index.d.ts",+ "import": "./dist/Calendar/index.mjs",+ "require": "./dist/Calendar/index.js"+ },"./Card": {+ "source": "./src/Card/index.ts","types": "./dist/Card/index.d.ts","import": "./dist/Card/index.mjs","require": "./dist/Card/index.js"},+ "./Center": {+ "source": "./src/Center/index.ts",+ "types": "./dist/Center/index.d.ts",+ "import": "./dist/Center/index.mjs",+ "require": "./dist/Center/index.js"+ },+ "./CheckboxInput": {+ "source": "./src/CheckboxInput/index.ts",+ "types": "./dist/CheckboxInput/index.d.ts",+ "import": "./dist/CheckboxInput/index.mjs",+ "require": "./dist/CheckboxInput/index.js"+ },+ "./CloseButton": {+ "source": "./src/CloseButton/index.ts",+ "types": "./dist/CloseButton/index.d.ts",+ "import": "./dist/CloseButton/index.mjs",+ "require": "./dist/CloseButton/index.js"+ },"./CollapsibleGroup": {+ "source": "./src/CollapsibleGroup/index.ts","types": "./dist/CollapsibleGroup/index.d.ts","import": "./dist/CollapsibleGroup/index.mjs","require": "./dist/CollapsibleGroup/index.js"},- "./Calendar": {- "types": "./dist/Calendar/index.d.ts",- "import": "./dist/Calendar/index.mjs",- "require": "./dist/Calendar/index.js"+ "./DateInput": {+ "source": "./src/DateInput/index.ts",+ "types": "./dist/DateInput/index.d.ts",+ "import": "./dist/DateInput/index.mjs",+ "require": "./dist/DateInput/index.js"},- "./CheckboxInput": {- "types": "./dist/CheckboxInput/index.d.ts",- "import": "./dist/CheckboxInput/index.mjs",- "require": "./dist/CheckboxInput/index.js"+ "./Dialog": {+ "source": "./src/Dialog/index.ts",+ "types": "./dist/Dialog/index.d.ts",+ "import": "./dist/Dialog/index.mjs",+ "require": "./dist/Dialog/index.js"+ },+ "./Divider": {+ "source": "./src/Divider/index.ts",+ "types": "./dist/Divider/index.d.ts",+ "import": "./dist/Divider/index.mjs",+ "require": "./dist/Divider/index.js"},- "./DatePicker": {- "types": "./dist/DatePicker/index.d.ts",- "import": "./dist/DatePicker/index.mjs",- "require": "./dist/DatePicker/index.js"+ "./DropdownMenu": {+ "source": "./src/DropdownMenu/index.ts",+ "types": "./dist/DropdownMenu/index.d.ts",+ "import": "./dist/DropdownMenu/index.mjs",+ "require": "./dist/DropdownMenu/index.js"+ },+ "./EmptyState": {+ "source": "./src/EmptyState/index.ts",+ "types": "./dist/EmptyState/index.d.ts",+ "import": "./dist/EmptyState/index.mjs",+ "require": "./dist/EmptyState/index.js"},"./Field": {+ "source": "./src/Field/index.ts","types": "./dist/Field/index.d.ts","import": "./dist/Field/index.mjs","require": "./dist/Field/index.js"},+ "./Grid": {+ "source": "./src/Grid/index.ts",+ "types": "./dist/Grid/index.d.ts",+ "import": "./dist/Grid/index.mjs",+ "require": "./dist/Grid/index.js"+ },"./Icon": {+ "source": "./src/Icon/index.ts","types": "./dist/Icon/index.d.ts","import": "./dist/Icon/index.mjs","require": "./dist/Icon/index.js"},+ "./Layer": {+ "source": "./src/Layer/index.ts",+ "types": "./dist/Layer/index.d.ts",+ "import": "./dist/Layer/index.mjs",+ "require": "./dist/Layer/index.js"+ },+ "./Layout": {+ "source": "./src/Layout/index.ts",+ "types": "./dist/Layout/index.d.ts",+ "import": "./dist/Layout/index.mjs",+ "require": "./dist/Layout/index.js"+ },+ "./Link": {+ "source": "./src/Link/index.ts",+ "types": "./dist/Link/index.d.ts",+ "import": "./dist/Link/index.mjs",+ "require": "./dist/Link/index.js"+ },+ "./NumberInput": {+ "source": "./src/NumberInput/index.ts",+ "types": "./dist/NumberInput/index.d.ts",+ "import": "./dist/NumberInput/index.mjs",+ "require": "./dist/NumberInput/index.js"+ },+ "./PageNav": {+ "source": "./src/PageNav/index.ts",+ "types": "./dist/PageNav/index.d.ts",+ "import": "./dist/PageNav/index.mjs",+ "require": "./dist/PageNav/index.js"+ },+ "./ProgressBar": {+ "source": "./src/ProgressBar/index.ts",+ "types": "./dist/ProgressBar/index.d.ts",+ "import": "./dist/ProgressBar/index.mjs",+ "require": "./dist/ProgressBar/index.js"+ },+ "./RadioList": {+ "source": "./src/RadioList/index.ts",+ "types": "./dist/RadioList/index.d.ts",+ "import": "./dist/RadioList/index.mjs",+ "require": "./dist/RadioList/index.js"+ },"./Section": {+ "source": "./src/Section/index.ts","types": "./dist/Section/index.d.ts","import": "./dist/Section/index.mjs","require": "./dist/Section/index.js"},"./Selector": {+ "source": "./src/Selector/index.ts","types": "./dist/Selector/index.d.ts","import": "./dist/Selector/index.mjs","require": "./dist/Selector/index.js"},+ "./Skeleton": {+ "source": "./src/Skeleton/index.ts",+ "types": "./dist/Skeleton/index.d.ts",+ "import": "./dist/Skeleton/index.mjs",+ "require": "./dist/Skeleton/index.js"+ },+ "./Slider": {+ "source": "./src/Slider/index.ts",+ "types": "./dist/Slider/index.d.ts",+ "import": "./dist/Slider/index.mjs",+ "require": "./dist/Slider/index.js"+ },+ "./Spinner": {+ "source": "./src/Spinner/index.ts",+ "types": "./dist/Spinner/index.d.ts",+ "import": "./dist/Spinner/index.mjs",+ "require": "./dist/Spinner/index.js"+ },"./Stack": {+ "source": "./src/Stack/index.ts","types": "./dist/Stack/index.d.ts","import": "./dist/Stack/index.mjs","require": "./dist/Stack/index.js"},- "./Layout": {- "types": "./dist/Layout/index.d.ts",- "import": "./dist/Layout/index.mjs",- "require": "./dist/Layout/index.js"+ "./StatusDot": {+ "source": "./src/StatusDot/index.ts",+ "types": "./dist/StatusDot/index.d.ts",+ "import": "./dist/StatusDot/index.mjs",+ "require": "./dist/StatusDot/index.js"},- "./Skeleton": {- "types": "./dist/Skeleton/index.d.ts",- "import": "./dist/Skeleton/index.mjs",- "require": "./dist/Skeleton/index.js"+ "./Switch": {+ "source": "./src/Switch/index.ts",+ "types": "./dist/Switch/index.d.ts",+ "import": "./dist/Switch/index.mjs",+ "require": "./dist/Switch/index.js"+ },+ "./TabList": {+ "source": "./src/TabList/index.ts",+ "types": "./dist/TabList/index.d.ts",+ "import": "./dist/TabList/index.mjs",+ "require": "./dist/TabList/index.js"+ },+ "./Table": {+ "source": "./src/Table/index.ts",+ "types": "./dist/Table/index.d.ts",+ "import": "./dist/Table/index.mjs",+ "require": "./dist/Table/index.js"},"./Text": {+ "source": "./src/Text/index.ts","types": "./dist/Text/index.d.ts","import": "./dist/Text/index.mjs","require": "./dist/Text/index.js"},+ "./TextArea": {+ "source": "./src/TextArea/index.ts",+ "types": "./dist/TextArea/index.d.ts",+ "import": "./dist/TextArea/index.mjs",+ "require": "./dist/TextArea/index.js"+ },"./TextInput": {+ "source": "./src/TextInput/index.ts","types": "./dist/TextInput/index.d.ts","import": "./dist/TextInput/index.mjs","require": "./dist/TextInput/index.js"},- "./TextArea": {- "types": "./dist/TextArea/index.d.ts",- "import": "./dist/TextArea/index.mjs",- "require": "./dist/TextArea/index.js"+ "./TimeInput": {+ "source": "./src/TimeInput/index.ts",+ "types": "./dist/TimeInput/index.d.ts",+ "import": "./dist/TimeInput/index.mjs",+ "require": "./dist/TimeInput/index.js"},- "./Layer": {- "types": "./dist/Layer/index.d.ts",- "import": "./dist/Layer/index.mjs",- "require": "./dist/Layer/index.js"+ "./Token": {+ "source": "./src/Token/index.ts",+ "types": "./dist/Token/index.d.ts",+ "import": "./dist/Token/index.mjs",+ "require": "./dist/Token/index.js"+ },+ "./TopNav": {+ "source": "./src/TopNav/index.ts",+ "types": "./dist/TopNav/index.d.ts",+ "import": "./dist/TopNav/index.mjs",+ "require": "./dist/TopNav/index.js"},"./hooks": {+ "source": "./src/hooks/index.ts","types": "./dist/hooks/index.d.ts","import": "./dist/hooks/index.mjs","require": "./dist/hooks/index.js"},"./theme": {+ "source": "./src/theme/index.ts","types": "./dist/theme/index.d.ts","import": "./dist/theme/index.mjs","require": "./dist/theme/index.js"},- "./theme/tokens.stylex": {- "types": "./dist/theme/tokens.stylex.d.ts",- "import": "./dist/theme/tokens.stylex.mjs",- "require": "./dist/theme/tokens.stylex.js"- },"./utils": {+ "source": "./src/utils/index.ts","types": "./dist/utils/index.d.ts","import": "./dist/utils/index.mjs","require": "./dist/utils/index.js"- },- "./xds.md": "./xds.md"+ }},"scripts": {"build": "NODE_OPTIONS='--max-old-space-size=4096' tsup",diff --git a/scripts/package-source.js b/scripts/package-source.jsindex babc3c2153..ed0d8bf645 100644--- a/scripts/package-source.js+++ b/scripts/package-source.js@@ -55,11 +55,14 @@ function copyDir(src, dest) {}/**- * Transform dist exports to source exports- * e.g., "./dist/Button/index.mjs" -> "./Button/index.ts"+ * Derive source exports from the "source" condition in package.json exports.*- * Also auto-discovers component directories that have an index.ts- * but are missing from the core package.json exports.+ * The canonical exports map is maintained by scripts/sync-exports.js, which+ * adds a "source" condition pointing to the TypeScript source for each entry.+ * This function reads those "source" paths and strips the "src/" prefix+ * (since the source distribution root IS the src/ directory).+ *+ * Falls back to auto-discovery if "source" conditions are missing.*/function deriveSourceExports() {const sourceExports = {};@@ -67,7 +70,6 @@ function deriveSourceExports() {for (const [key, value] of Object.entries(PKG.exports)) {// Handle string exports (e.g., "./typography.css": "./src/typography.css")if (typeof value === 'string') {- // Convert src paths, keep as-is for non-dist pathsif (value.startsWith('./src/')) {sourceExports[key] = value.replace('./src/', './');} else if (!value.includes('/dist/')) {@@ -76,19 +78,21 @@ function deriveSourceExports() {continue;}- // Handle object exports with types/import/require+ // Handle object exports — prefer the "source" conditionif (typeof value === 'object' && value !== null) {- // Get the import path and transform it- const importPath = value.import || value.require || value.types;- if (!importPath) continue;-- // Transform ./dist/Button/index.mjs -> ./Button/index.ts- const sourcePath = importPath- .replace('./dist/', './')- .replace(/\.mjs$/, '.ts')- .replace(/\.js$/, '.ts');-- sourceExports[key] = sourcePath;+ if (value.source) {+ // Strip ./src/ prefix since the tarball root is src/+ sourceExports[key] = value.source.replace('./src/', './');+ } else {+ // Fallback: derive from import/require path+ const importPath = value.import || value.require || value.types;+ if (!importPath) continue;+ const sourcePath = importPath+ .replace('./dist/', './')+ .replace(/\.mjs$/, '.ts')+ .replace(/\.js$/, '.ts');+ sourceExports[key] = sourcePath;+ }}}diff --git a/scripts/sync-exports.js b/scripts/sync-exports.jsnew file mode 100644index 0000000000..4fcab7899a--- /dev/null+++ b/scripts/sync-exports.js@@ -0,0 +1,174 @@+#!/usr/bin/env node+/**+ * @file sync-exports.js+ * @description Auto-generates the "exports" map in packages/core/package.json+ * from the source tree. Ensures every component with src/Component/index.ts+ * has correct export entries with source, types, import, and require conditions.+ *+ * Usage:+ * node scripts/sync-exports.js # Update package.json in place+ * node scripts/sync-exports.js --check # Exit 1 if package.json is stale+ *+ * The "source" export condition follows the convention used by Parcel, webpack,+ * and other bundlers for pointing to unbuilt TypeScript source files. This+ * enables monorepo consumers to resolve imports to source without post-import+ * transforms.+ *+ * Condition ordering matters — Node.js resolves top-to-bottom:+ * 1. "source" — for bundlers configured with the "source" condition+ * 2. "types" — for TypeScript+ * 3. "import" — for ESM consumers+ * 4. "require" — for CJS consumers+ */++const fs = require('fs');+const path = require('path');++const CORE_DIR = path.resolve(__dirname, '..', 'packages', 'core');+const SRC_DIR = path.join(CORE_DIR, 'src');+const PKG_PATH = path.join(CORE_DIR, 'package.json');++const CHECK_MODE = process.argv.includes('--check');++/**+ * Directories that are exported as subpath modules but aren't components.+ * These use the same pattern (source/types/import/require) but are listed+ * separately for clarity.+ */+const UTILITY_DIRS = new Set(['hooks', 'theme', 'utils']);++/**+ * Additional exports that can't be auto-discovered from directory structure.+ * These are maintained manually here as the single source of truth.+ */+const STATIC_EXPORTS = {+ './reset.css': './src/reset.css',+ './typography.css': './src/typography.css',+ './theme/tokens.stylex': {+ source: './src/theme/tokens.stylex.ts',+ types: './dist/theme/tokens.stylex.d.ts',+ import: './dist/theme/tokens.stylex.mjs',+ require: './dist/theme/tokens.stylex.js',+ },+ './xds.md': './xds.md',+};++/**+ * Discover all exportable directories under src/.+ * A directory is exportable if it contains an index.ts file.+ */+function discoverExportDirs() {+ const entries = fs.readdirSync(SRC_DIR, {withFileTypes: true});+ const dirs = [];++ for (const entry of entries) {+ if (!entry.isDirectory()) continue;++ const indexPath = path.join(SRC_DIR, entry.name, 'index.ts');+ if (fs.existsSync(indexPath)) {+ dirs.push(entry.name);+ }+ }++ return dirs.sort();+}++/**+ * Generate the export entry for a directory.+ * Condition order: source → types → import → require+ */+function makeExportEntry(dirName) {+ return {+ source: `./src/${dirName}/index.ts`,+ types: `./dist/${dirName}/index.d.ts`,+ import: `./dist/${dirName}/index.mjs`,+ require: `./dist/${dirName}/index.js`,+ };+}++/**+ * Build the complete exports map.+ */+function buildExports() {+ const exports = {};++ // Root export+ exports['.'] = {+ source: './src/index.ts',+ types: './dist/index.d.ts',+ import: './dist/index.mjs',+ require: './dist/index.js',+ };++ // Static exports (CSS, markdown, etc.)+ for (const [key, value] of Object.entries(STATIC_EXPORTS)) {+ exports[key] = value;+ }++ // Auto-discovered directories+ const dirs = discoverExportDirs();+ for (const dir of dirs) {+ const key = `./${dir}`;+ // Skip if already covered by static exports+ if (exports[key]) continue;+ exports[key] = makeExportEntry(dir);+ }++ return exports;+}++function main() {+ const pkg = JSON.parse(fs.readFileSync(PKG_PATH, 'utf8'));+ const newExports = buildExports();++ if (CHECK_MODE) {+ const currentStr = JSON.stringify(pkg.exports, null, 2);+ const newStr = JSON.stringify(newExports, null, 2);++ if (currentStr === newStr) {+ console.log('✓ package.json exports are up to date');+ process.exit(0);+ } else {+ console.error('✗ package.json exports are stale!');+ console.error('');+ console.error('Run `node scripts/sync-exports.js` to update.');+ console.error('');++ // Show what changed+ const currentKeys = new Set(Object.keys(pkg.exports));+ const newKeys = new Set(Object.keys(newExports));++ for (const key of newKeys) {+ if (!currentKeys.has(key)) {+ console.error(` + ${key} (missing from package.json)`);+ }+ }+ for (const key of currentKeys) {+ if (!newKeys.has(key)) {+ console.error(` - ${key} (in package.json but not in src/)`);+ }+ }+ for (const key of newKeys) {+ if (+ currentKeys.has(key) &&+ JSON.stringify(pkg.exports[key]) !== JSON.stringify(newExports[key])+ ) {+ console.error(` ~ ${key} (conditions differ)`);+ }+ }++ process.exit(1);+ }+ }++ // Write mode+ pkg.exports = newExports;+ fs.writeFileSync(PKG_PATH, JSON.stringify(pkg, null, 2) + '\n');++ const dirs = discoverExportDirs();+ console.log(+ `✓ Synced ${Object.keys(newExports).length} exports (${dirs.length} components/modules)`+ );+}++main();