11# DESIGN SDK
22
3- > Build a single app that supports all figma, sketch, xd and bridged.
3+ > Build a single app that supports all figma, sketch and bridged.
44
55A mid wrapper for building consistant figma & ; sketch & ; reflection plugin, with single api reference
66
@@ -11,24 +11,32 @@ A mid wrapper for building consistant figma & sketch & reflection plugin
1111- mocks desing platform environment - faster development.
1212- single api reference - write once, run everywhere.
1313- reflect standard in the box - based on [ reflect] ( https://reflect-ui.com ) DSL, develop with unified api structure.
14- - UI support - different ui feedback features by platform such as modals (xd), notify (figma) is supported by ui library
14+ - UI support - different ui feedback features by platform such as notify (figma) is supported by ui library
1515- OOP Based design access objects
1616- General UI Related utilities in the box
1717- Testing supported
1818- Provides Web based development environment
1919
20+ ## Tech Stack
21+
22+ - ** Package Manager** : pnpm (monorepo workspace)
23+ - ** Build Tool** : tsup
24+ - ** Test Framework** : vitest
25+ - ** TypeScript** : ^5.3.3
26+ - ** Monorepo** : Turborepo
27+ - ** CI/CD** : GitHub Actions with Changesets for automated publishing
28+
2029## Packages & Usage
2130
2231``` sh
23- yarn add @design-sdk/< package>
32+ pnpm add @design-sdk/< package>
2433```
2534
2635** Packages**
2736
2837- figma
2938 - figma-remote
3039 - figma-url
31- - xd
3240- sketch
3341
3442## Are you looking for universal design converter?
@@ -44,6 +52,44 @@ Take a look at [design-file-converter](https://github.com/gridaco/design-file-co
4452
4553- https://www.figma.com/plugin-docs/api/
4654
47- ## XD reference
55+ ## Development
56+
57+ ### Setup
58+
59+ ``` sh
60+ pnpm install
61+ ```
62+
63+ ### Build
64+
65+ ``` sh
66+ pnpm build
67+ ```
68+
69+ ### Test
70+
71+ ``` sh
72+ pnpm test
73+ ```
74+
75+ ### Typecheck
76+
77+ ``` sh
78+ pnpm typecheck
79+ ```
80+
81+ ### Watch Mode
82+
83+ ``` sh
84+ pnpm dev
85+ ```
86+
87+ ## Publishing
88+
89+ This repository uses [ Changesets] ( https://github.com/changesets/changesets ) for version management and automated publishing.
90+
91+ 1 . Create a changeset: ` pnpm changeset `
92+ 2 . Version packages: ` pnpm version ` (or let CI handle it)
93+ 3 . Publish: ` pnpm release ` (or let CI handle it)
4894
49- - https://adobexdplatform.com/plugin-docs/reference/xd-index.html
95+ Changesets automatically create version bump PRs and publish to npm when merged to main.
0 commit comments