How sncfdevelopers/wcs works
Project Type and Purpose
• This is a monorepo for a Design System: “Web Components SNCF.”
• Built with StencilJS to generate reusable web components (wcs-core), plus framework integrations (wcs-angular, wcs-formly, wcs-react), a design-tokens generator, documentation (Storybook), and example apps (Angular & React).
File-Structure Analysis
• Top-level:
• src/ + stencil.config.ts → core components source.
• angular/ → Angular library projects (wcs-angular, wcs-formly).
• react/ → React wrapper library.
• design-tokens/ → JSON → CSS/DTF token pipelines and manifest.
• example/ → demo apps in Angular & React.
• stories/ → Storybook configuration & MDX docs.
• scripts/ → build/versioning helpers.
• CI files (.gitlab-ci.yml) & publishing configs (.npmrc, package.json).
README Insights
• Core packages published to npm: wcs-core, wcs-angular, wcs-formly, wcs-react.
• StencilJS builds core; wrappers are built by Angular CLI / Rollup.
• Storybook serves as live documentation.
• CI/CD via GitLab pipelines drives build, test, Storybook deploy, and npm publish.
Main Components
a. Core Web Components Package (StencilJS)
b. Angular Integration Packages (wcs-angular, wcs-formly)
c. React Integration Package (wcs-react)
d. Design-Tokens Generator (json-to-css, json-to-dtf)
e. Storybook Documentation App
f. Example Applications (Angular Standalone, React)
g. CI/CD Pipeline & NPM Registry
h. Consumers (Client Projects)
Relationships and Data Flows
• Developers edit src/, angular/, react/, design-tokens/, then run “npm run build”:
• Stencil builds core → outputs web components bundle.
• Angular CLI builds integrations → packages.
• Rollup compiles React wrappers.
• Design-tokens scripts transform JSON → CSS/DTF.
• Artifacts published to npm registry.
• Storybook reads built core + wrappers + tokens to render component library.
• Example apps install published or local builds of packages to showcase usage.
• CI/CD orchestrates build → test → deploy (Storybook hosting) → npm publish.
Architectural Patterns & Design Principles
• Monorepo with multi-package (Package per framework)
• Build pipelines per package: StencilJS for core, Angular CLI for Angular, Rollup for React
• Separation of concerns: core functionality vs. framework adapters vs. tokens vs. docs
• Publish-subscribe: packages published to registry, consumers subscribe via npm
• Core Layer:
[src/] → (Stencil Build) → [wcs-core bundle]
• Integration Layer:
[angular/projects/wcs-angular] → (ng build) → [wcs-angular package]
[angular/projects/wcs-formly] → (ng build) → [wcs-formly package]
[react/lib & rollup.config.mjs] → (rollup) → [wcs-react package]
• Design-Tokens:
[design-tokens/tokens/*.json] → (token-builder.mjs) → CSS/DTF outputs
• Documentation:
[stories/] + built packages → (Storybook) → Live Docs
• Examples:
[example/angular-standalone] & [example/react] install local builds or registry packages → run dev servers
• CI/CD Pipeline:
[.gitlab-ci.yml] → jobs: install → build core + integrations + tokens → test (unit & e2e) → deploy Storybook → npm publish
• Consumers:
Client Applications import wcs-core ± integrations via npm
Final Checklist
• Components labeled and grouped logically
• External services: GitLab CI, NPM Registry, Browsers
• Technology nodes: StencilJS, Angular CLI, Rollup, Storybook