Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
221 lines (155 loc) · 8.13 KB

DEVELOPMENT.md

File metadata and controls

221 lines (155 loc) · 8.13 KB

Development

This document contains development-related documentation including build setup, testing, CI/CD, and deployment.

Monorepo Structure

This is an npm workspaces monorepo managed by Lerna. It contains:

Package npm Description
packages/stencil-library @kit-data-manager/pid-component Core Stencil web component library
packages/react-library @kit-data-manager/react-pid-component React wrapper (auto-generated proxies)
packages/vue-library @kit-data-manager/vue-pid-component Vue 3 wrapper (auto-generated proxies)
packages/angular-library @kit-data-manager/angular-pid-component Angular standalone wrapper (auto-generated proxies)
packages/nextjs-app (private) Next.js demo app with React (SSR) Storybook

The framework wrappers are thin proxy layers generated by Stencil's output targets during the stencil-library build. They forward props and events to the underlying web components.

Prerequisites

  • Node.js 22+
  • npm (this project uses npm exclusively; do not use yarn or pnpm)

Setup

git clone https://github.com/kit-data-manager/pid-component.git
cd pid-component
npm ci

Building

Build all packages in dependency order:

npm run build

This runs npx lerna run build, which:

  1. Builds stencil-library first (stencil build --docs), generating the web components, the dist/ and hydrate/ outputs, plus the auto-generated framework proxy code in the sibling wrapper packages.
  2. Builds react-library, vue-library, and angular-library (each runs tsc to compile their generated proxy code).

To rebuild the Stencil library in watch mode during development:

cd packages/stencil-library
npm run buildWatch

Running Storybook

Storybook is configured at the repository root (.storybook/) and serves stories from packages/stencil-library/src/. It requires the Stencil library to be built first.

Main Storybook (Web Components):

npm run build                 # build all packages first
npm run storybook             # starts on http://localhost:6006

Composed Storybook (all frameworks):

The project uses Storybook Composition to display framework-specific stories from the React, Vue, Angular, and Next.js wrapper packages alongside the main Web Components stories. To run the full composed Storybook locally:

npm run storybook:all

This uses concurrently + wait-on to:

  1. Start the React (Vite) sub-Storybook on port 6007
  2. Start the Vue sub-Storybook on port 6008
  3. Start the Angular sub-Storybook on port 6009
  4. Start the React (Next.js) sub-Storybook on port 6010
  5. Wait for all four, then start the main composed Storybook on port 6006

You can kill all storybooks with lsof -tiTCP:6006-6010 -sTCP:LISTEN | xargs kill.

You can also run just the main Storybook (npm run storybook) without the framework sub-Storybooks; the composed refs will simply show as unavailable.

Build a static Storybook:

npm run build-storybook

This builds the main Storybook and all framework sub-Storybooks into storybook-static/, with the sub-Storybooks placed in subdirectories (react-vite/, vue/, angular/, react-nextjs/).

Testing

This project uses Vitest for all testing:

Running Tests

npm test                      # runs ALL tests with coverage

This runs three test suites in sequence:

  1. Stencil spec tests -- unit and component tests in a mock-DOM environment
  2. Stencil E2E tests -- component tests in a real Chromium browser via Playwright
  3. Storybook tests (vitest run --project=storybook) -- renders every story in headless Chromium and runs play() functions and accessibility audits

From packages/stencil-library you can also run subsets:

npm run test:spec             # spec tests only (node DOM)
npm run test:e2e              # E2E tests only (real browser)
npm run test:watch            # watch mode (no coverage)

A V8 coverage report is generated automatically on every test run (except in watch mode). Coverage output is available as text in the terminal and as HTML in packages/stencil-library/coverage/.

Storybook tests require Playwright with Chromium. Install with: npx playwright install --with-deps chromium

Writing Tests

Spec tests (*.spec.ts / *.spec.tsx) test pure logic and component rendering in a node DOM:

import { render, h } from '@stencil/vitest';
import { describe, it, expect } from 'vitest';

describe('my-component', () => {
  it('renders with value', async () => {
    const { root } = await render(<my-component value="test" />);
    expect(root).toBeTruthy();
    expect(root.value).toBe('test');
  });
});

E2E tests (*.e2e.tsx) run in a real browser:

import { render, h } from '@stencil/vitest';
import { describe, it, expect } from 'vitest';

describe('my-component e2e', () => {
  it('renders and hydrates', async () => {
    const { root } = await render(<my-component value="test" />);
    expect(root).toHaveClass('hydrated');
  });
});

Continuous Integration

npm-ci.yml

Runs on every push and pull request. Tests against Node.js 22 (LTS) and 24 (current):

  1. npm ci -- install dependencies
  2. npx playwright install --with-deps chromium -- install browser for E2E and Storybook tests
  3. npx lerna run build -- build all packages
  4. npx lerna run lint -- ESLint
  5. npx lerna run format:check -- Prettier
  6. npm run build-storybook -- build static Storybook
  7. npm test -- runs all tests (Stencil spec + E2E + Storybook) with coverage

On pull requests, a coverage summary is posted as a comment. On pushes to main, a coverage badge is updated automatically.

deploy-storybook.yml

Runs on pushes to main. Builds all packages and the composed Storybook, then deploys the static output to GitHub Pages.

chromatic.yml

Runs on every push and pull request. Uploads the main Web Components Storybook to Chromatic for visual regression testing. Changes on main are auto-accepted.

Deployment

Storybook

The production Storybook is deployed to GitHub Pages at https://kit-data-manager.github.io/pid-component/. It is rebuilt and redeployed automatically on every push to main via the deploy-storybook.yml workflow.

The deployed Storybook includes the main Web Components stories plus the composed React (Vite), React (Next.js), Vue, and Angular sub-Storybooks (accessible via the sidebar).

npm Packages

The npm packages are published independently (Lerna independent versioning). To publish:

npx lerna publish

Chromatic

Chromatic provides visual regression testing and a hosted Storybook preview for each PR. It runs automatically via chromatic.yml on every push and pull request.