feat: Add schema converter library and GitHub PR workflow by GarthDB · Pull Request #691 · adobe/spectrum-design-data

GarthDB · 2026-01-24T00:41:11Z

Overview

This PR adds two major features:

1. Schema Converter Library (`@adobe/component-schema-converter`)

A new library for bidirectional conversion between the Figma plugin's simplified JSON format and the official Spectrum JSON Schema format.

Features:

✅ Bidirectional conversion (Plugin ↔ Schema)
✅ 296 tests with 96.4% code coverage
✅ Validates all 80 component schemas
✅ 96.3% perfect round-trip (77/80 components)
✅ Supports all property types (string, boolean, dimension, enums, icon refs, color refs)

Test Results:

41/80 components: Byte-for-byte identical round-trip
36/80 components: Cosmetic differences only (property ordering)
3/80 components: Missing advanced JSON Schema features (examples, definitions, oneOf)

2. GitHub PR Workflow (`@adobe/component-options-editor`)

Adds the ability to create pull requests directly from the Figma plugin.

Features:

🔐 Personal Access Token authentication with secure storage (figma.clientStorage)
🔄 Automatic schema conversion using the converter library
📝 Changeset generation for version management
✨ Support for creating new and updating existing component schemas
🛡️ Comprehensive error handling and user feedback

Documentation:

Added docs/CREATE_PR.md with complete user guide
Updated README with GitHub integration details

Testing

✅ All converter tests passing (296 tests)
✅ Comprehensive validation against all 80 component schemas
✅ Schema diff tool confirms no breaking changes for 77/80 components
✅ Plugin builds successfully with webpack polyfills for Octokit

Breaking Changes

None - this is a new feature addition.

- Add @adobe/component-schema-converter library with bidirectional conversion - Plugin format ↔ Official JSON Schema format - 296 tests with 96.4% code coverage - Validates all 80 component schemas (96.3% perfect round-trip) - Add GitHub PR creation workflow to Figma plugin - Personal Access Token authentication with secure storage - Automatic schema conversion using converter library - Changeset generation for version management - Support for creating new and updating existing schemas - Add comprehensive test suite and documentation

changeset-bot · 2026-01-24T00:41:15Z

⚠️ No Changeset found

Latest commit: 4103a1f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

GarthDB · 2026-01-24T00:42:13Z

Run report for 4103a1f4

Total time: 43.7s | Comparison time: 1m 25s | Estimated savings: 42.3s (49.2% faster)

	Action	Time	Status
⬛️	`SetupProto(0.51.4)`	0ms	Skipped
🟩	`SyncWorkspace`	6.9ms	Passed
🟩	`SyncProject(componentSchemas)`	0.3ms	Passed
🟩	`SyncProject(component-options-editor)`	0.4ms	Passed
⬛️	`SetupToolchain(node:20.17.0)`	1.3s	Skipped
🟩	`InstallWorkspaceDeps(node:20.17.0)`	10.2s	Passed
🟩	`RunTask(component-options-editor:type-check)`	12.1s	Passed
🟩	`RunTask(component-options-editor:lint)`	13.1s	Passed
🟩	`RunTask(component-options-editor:test)`	14.1s	Passed
🟩	`RunTask(component-options-editor:validate)`	16.3s	Passed
🟩	`RunTask(component-options-editor:build)`	32.1s	Passed

Touched files

packages/component-schema-converter/CHANGELOG.md
packages/component-schema-converter/README.md
packages/component-schema-converter/ava.config.js
packages/component-schema-converter/moon.yml
packages/component-schema-converter/package.json
packages/component-schema-converter/src/converters/index.js
packages/component-schema-converter/src/converters/pluginToSchema.js
packages/component-schema-converter/src/converters/schemaToPlugin.js
packages/component-schema-converter/src/converters/validators.js
packages/component-schema-converter/src/index.d.ts
packages/component-schema-converter/src/index.js
packages/component-schema-converter/src/types/schemas.js
packages/component-schema-converter/src/utils/errorHandling.js
packages/component-schema-converter/src/utils/index.js
packages/component-schema-converter/src/utils/schemaGeneration.js
packages/component-schema-converter/src/utils/typeDetection.js
packages/component-schema-converter/test/ROUND_TRIP_ANALYSIS.md
packages/component-schema-converter/test/comprehensive-validation.test.js
packages/component-schema-converter/test/converters/integration.test.js
packages/component-schema-converter/test/converters/pluginToSchema.test.js
packages/component-schema-converter/test/converters/roundTrip.test.js
packages/component-schema-converter/test/converters/schemaToPlugin.test.js
packages/component-schema-converter/test/converters/validators.test.js
packages/component-schema-converter/test/fixtures/official-schema/action-button.json
packages/component-schema-converter/test/fixtures/official-schema/button.json
packages/component-schema-converter/test/fixtures/official-schema/checkbox.json
packages/component-schema-converter/test/fixtures/plugin-format/action-button-icons.json
packages/component-schema-converter/test/fixtures/plugin-format/button-complete.json
packages/component-schema-converter/test/fixtures/plugin-format/button-simple.json
packages/component-schema-converter/test/fixtures/plugin-format/edge-cases.json
packages/component-schema-converter/test/fixtures/plugin-format/empty-options.json
packages/component-schema-converter/test/utils/schemaGeneration.test.js
packages/component-schema-converter/test/utils/typeDetection.test.js
pnpm-lock.yaml
tools/component-options-editor/README.md
tools/component-options-editor/build/plugin/plugin.js
tools/component-options-editor/build/plugin/plugin.js.map
tools/component-options-editor/build/ui/app/litAppElement.js
tools/component-options-editor/build/ui/app/litAppElement.js.map
tools/component-options-editor/docs/CREATE_PR.md
tools/component-options-editor/manifest.json
tools/component-options-editor/package.json
tools/component-options-editor/src/plugin/plugin.ts
tools/component-options-editor/src/services/changesetGenerator.ts
tools/component-options-editor/src/services/errors.ts
tools/component-options-editor/src/services/githubService.ts
tools/component-options-editor/src/services/prWorkflow.ts
tools/component-options-editor/src/types/github.ts
tools/component-options-editor/src/ui/app/litAppElement.ts
tools/component-options-editor/src/ui/app/templates/githubAuth.ts
tools/component-options-editor/test/services/changesetGenerator.test.js
tools/component-options-editor/webpack.config.cjs

- Format all test and source files with Prettier - Apply Remark markdown formatting to documentation - Consistent code style across converter library and plugin - No functional changes

Replace all `any` types with `unknown` for proper type safety: - errors.ts: Use `unknown` for error parameters with proper type guards - githubService.ts: Replace `any` error types with `unknown` and type assertions - litAppElement.ts: Fix unused import and `any` type in error handling - githubAuth.ts: Remove unused `nothing` import from lit Add proper type narrowing using instanceof checks and type assertions to satisfy TypeScript strict mode while maintaining ESLint compliance. All tests passing, linter clean.

GarthDB added 2 commits January 23, 2026 17:43

style: apply prettier and remark formatting

6009cff

- Format all test and source files with Prettier - Apply Remark markdown formatting to documentation - Consistent code style across converter library and plugin - No functional changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add schema converter library and GitHub PR workflow#691

feat: Add schema converter library and GitHub PR workflow#691
GarthDB wants to merge 3 commits intomainfrom
feat/schema-converter-and-github-pr-workflow

GarthDB commented Jan 24, 2026

Uh oh!

changeset-bot bot commented Jan 24, 2026 •

edited

Loading

Uh oh!

GarthDB commented Jan 24, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

GarthDB commented Jan 24, 2026

Overview

1. Schema Converter Library (@adobe/component-schema-converter)

2. GitHub PR Workflow (@adobe/component-options-editor)

Testing

Breaking Changes

Uh oh!

changeset-bot bot commented Jan 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

GarthDB commented Jan 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Run report for 4103a1f4

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

1. Schema Converter Library (`@adobe/component-schema-converter`)

2. GitHub PR Workflow (`@adobe/component-options-editor`)

changeset-bot bot commented Jan 24, 2026 •

edited

Loading

GarthDB commented Jan 24, 2026 •

edited

Loading