Initial design system setup#28
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Initial setup of the SURF design system. This PR is based on a near-empty
main, so the whole bootstrap can be reviewed in one place.Reviewer's guide
Most of the diff is generated or vendored. Roughly in priority order:
Review closely (the actual decisions live here):
packages/react/vite.config.ts(lib mode + dts externalisation),packages/angular/ng-package.json(allowedNonPeerDependencies),turbo.json(pipeline),.github/workflows/ci.yml.packages/angular/angular.json. KeepbrowserTarget: "angular:build"(see AGENTS.md), easy to break.packages/react/src/components/ui/button/button.tsx,packages/angular/src/lib/ui/button/src/lib/hlm-button.ts. First vendored component in each package; sets the per-component layout convention.packages/react/src/index.css,packages/angular/src/styles.css. The shared oklch token set (should match across the two). This will be moved to the a shared 'tokens' package eventually.packages/react/components.json(Base UIstyle: base-nova, Tabler icons).pnpm-workspace.yaml,.npmrc. Install cooldown (minimumReleaseAge),allowBuildslifecycle-script allowlist,blockExoticSubdeps. The most security-relevant config in the PR.Skim (convention/config, mostly mechanical):
package.json, the twopackages/*/package.json), tsconfigs,.storybook/*, Prettier/husky/gitignore.*.stories.*) and barrels (index.ts).AGENTS.md/README.md. Docs; worth a read but not code.Skip (generated or copied by shadcn/spartan):
pnpm-lock.yaml, generated lockfile..agents/skills/shadcn/**and.agents/skills/spartan/**, upstream skills copied verbatim from the shadcn/spartan repos. Only our own.agents/skills/add-component/*is hand-written.packages/angular/src/lib/ui/utils/src/lib/hlm.ts, vendored Spartan utility, generated by the CLI.Overview
A Turborepo + pnpm monorepo with three packages:
@surfnet/reactvite-plugin-dts@surfnet/angularng-packagr@surfnet/typescript-configBoth component packages style with Tailwind CSS v4 and share the same oklch token set. Each ships a
Buttonas the first vendored component.What's included
build,lint,dev,storybook), Prettier, and exact-pinned dependencies across all packages.shadcnandspartan-uiMCP servers plus vendored agent skills, with conventions documented inAGENTS.md.minimumReleaseAge), dependency lifecycle scripts blocked except for an explicitallowBuildsallowlist, andblockExoticSubdeps.Commands
pnpm install --frozen-lockfile,pnpm build, andpnpm lintall pass on pnpm 11.7.0.