Updates to SPC Build process

fergusbissetnhs · fergusbissetnhs · commit 9e562d85ddc6 · 2025-11-10T21:23:17.000Z
diff --git a/.github/workflows/spc-publish.yml b/.github/workflows/spc-publish.yml
@@ -1,4 +1,4 @@
-name: Publish @nhs-fdp/spc
+name: Publish @nhsdigital/spc
 
 on:
   push:
@@ -23,7 +23,7 @@ jobs:
         with:
           node-version: 22.x
           registry-url: 'https://npm.pkg.github.com'
-          scope: '@fergusbisset'
+          scope: '@nhsdigital'
 
       - name: Install dependencies
         run: npm ci
@@ -43,7 +43,7 @@ jobs:
         run: npm run build
         working-directory: packages/nhs-fdp-spc
 
-      - name: Publish @nhs-fdp/spc to GitHub Packages (alpha tag)
+  - name: Publish @nhsdigital/spc to GitHub Packages (alpha tag)
         run: npm publish --tag alpha
         working-directory: packages/nhs-fdp-spc
         env:
diff --git a/packages/nhs-fdp-spc/.github/workflows/ci.yml b/packages/nhs-fdp-spc/.github/workflows/ci.yml
@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Use Node.js 22.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Exports check
+        run: npm run exports:check
+
+      - name: Build
+        run: npm run build
+
+      - name: Dry-run pack
+        run: npm pack --dry-run
diff --git a/packages/nhs-fdp-spc/.github/workflows/publish.yml b/packages/nhs-fdp-spc/.github/workflows/publish.yml
@@ -0,0 +1,44 @@
+name: Publish @nhsdigital/spc
+
+on:
+  push:
+    tags:
+      - 'spc-v*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Use Node.js 22.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+          registry-url: 'https://npm.pkg.github.com'
+          scope: '@nhsdigital'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Verify tag matches package version
+        run: |
+          PKG_VERSION=$(node -p "require('./package.json').version")
+          TAG_VERSION=${GITHUB_REF_NAME#spc-v}
+          echo "Package version: $PKG_VERSION"
+          echo "Tag version: $TAG_VERSION"
+          test "$PKG_VERSION" = "$TAG_VERSION"
+
+      - name: Build SPC package
+        run: npm run build
+
+      - name: Publish @nhsdigital/spc (alpha tag)
+        run: npm publish --tag alpha
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/packages/nhs-fdp-spc/config/vite.spc.config.ts b/packages/nhs-fdp-spc/config/vite.spc.config.ts
@@ -0,0 +1,62 @@
+import { defineConfig, Plugin } from 'vite';
+import react from '@vitejs/plugin-react';
+import { resolve } from 'path';
+import { existsSync } from 'fs';
+import dts from 'vite-plugin-dts';
+
+// Ignore SCSS during JS lib build
+const ignoreScssPlugin = (): Plugin => ({
+  name: 'spc-ignore-scss',
+  load(id) {
+    if (id.endsWith('.scss')) return { code: '' };
+  }
+});
+
+// Resolve '@' alias: in monorepo use root src; in split use local src
+const monorepoSrc = resolve(__dirname, '../../../src');
+const localSrc = resolve(__dirname, '../src');
+const atAlias = existsSync(monorepoSrc) ? monorepoSrc : localSrc;
+
+export default defineConfig({
+  plugins: [
+    ignoreScssPlugin(),
+    react({ jsxRuntime: 'classic' }),
+    dts({
+      entryRoot: resolve(__dirname, '../src'),
+      outDir: resolve(__dirname, '../dist'),
+      tsconfigPath: resolve(__dirname, '../tsconfig.json'),
+      copyDtsFiles: true
+    })
+  ],
+  resolve: {
+    alias: {
+      '@': atAlias
+    }
+  },
+  build: {
+    lib: {
+      entry: {
+        index: resolve(__dirname, '../src/index.ts'),
+        engine: resolve(__dirname, '../src/engine/index.ts'),
+        icons: resolve(__dirname, '../src/icons/index.ts')
+      },
+      formats: ['es'],
+      fileName: (_format, entryName) => {
+        if (entryName === 'index') return 'index.esm.js';
+        return `${entryName}/index.js`;
+      }
+    },
+    rollupOptions: {
+      external: [
+        'react',
+        'react-dom',
+        'react/jsx-runtime',
+        'react/jsx-dev-runtime'
+      ]
+    },
+    sourcemap: true,
+    copyPublicDir: false,
+    outDir: resolve(__dirname, '../dist'),
+    emptyOutDir: true
+  }
+});
diff --git a/packages/nhs-fdp-spc/config/vite.spc.css.config.ts b/packages/nhs-fdp-spc/config/vite.spc.css.config.ts
@@ -0,0 +1,26 @@
+import { defineConfig } from 'vite';
+import { resolve } from 'path';
+
+export default defineConfig({
+  build: {
+    lib: {
+      entry: resolve(__dirname, '../src/styles/spc.scss'),
+      formats: ['es'],
+      fileName: () => 'spc'
+    },
+    rollupOptions: {
+      output: {
+        assetFileNames: (assetInfo) => {
+          if (assetInfo.name && assetInfo.name.endsWith('.css')) return 'spc.css';
+          return assetInfo.name || '[name]';
+        }
+      }
+    },
+    sourcemap: true,
+    copyPublicDir: false,
+    outDir: resolve(__dirname, '../dist'),
+    emptyOutDir: false,
+    cssCodeSplit: false,
+    minify: false
+  }
+});
diff --git a/packages/nhs-fdp-spc/dist/engine/index.d.ts b/packages/nhs-fdp-spc/dist/engine/index.d.ts
@@ -0,0 +1,2 @@
+/** Engine entry for @nhs-fdp/spc/engine */
+export * from '../../../../src/components/DataVisualisation/charts/SPC/engine';
diff --git a/packages/nhs-fdp-spc/dist/icons/index.d.ts b/packages/nhs-fdp-spc/dist/icons/index.d.ts
@@ -0,0 +1,2 @@
+/** Icons entry for @nhs-fdp/spc/icons */
+export * from '../../../../src/components/DataVisualisation/charts/SPC/icons';
diff --git a/packages/nhs-fdp-spc/dist/index.d.ts b/packages/nhs-fdp-spc/dist/index.d.ts
@@ -0,0 +1,5 @@
+/**
+ * Public entry for @nhsdigital/spc.
+ * Re-exports the existing SPC barrel from the monorepo source (not yet vendored).
+ */
+export * from '../../../src/components/DataVisualisation/charts/SPC';
diff --git a/packages/nhs-fdp-spc/dist/types/shims.d.ts b/packages/nhs-fdp-spc/dist/types/shims.d.ts
@@ -0,0 +1,4 @@
+// Temporary module shims to allow cross-package re-exports during subrepo setup.
+declare module '@ds/components/DataVisualisation/charts/SPC';
+declare module '@ds/components/DataVisualisation/charts/SPC/engine';
+declare module '@ds/components/DataVisualisation/charts/SPC/icons';
diff --git a/packages/nhs-fdp-spc/package.json b/packages/nhs-fdp-spc/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@fergusbisset/spc",
+  "name": "@nhsdigital/spc",
   "version": "0.0.1-alpha.0",
   "description": "Statistical Process Control (SPC) components and engine for the NHS FDP Design System",
   "type": "module",
@@ -43,8 +43,8 @@
   },
   "dependencies": {},
   "scripts": {
-    "build": "vite build --config ../../config/vite.spc.config.ts && vite build --config ../../config/vite.spc.css.config.ts",
-    "exports:check": "node ../../scripts/spc-export-check.cjs",
+    "build": "node ./scripts/build-spc.mjs",
+    "exports:check": "node ./scripts/spc-export-check.cjs",
     "prepublishOnly": "npm run exports:check && npm run build",
     "test": "vitest run --dir ./tests"
   }
diff --git a/packages/nhs-fdp-spc/scripts/build-spc.mjs b/packages/nhs-fdp-spc/scripts/build-spc.mjs
@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+/**
+ * Flexible build script that works both inside the monorepo and after subtree split.
+ * It detects available Vite config locations and runs both JS & CSS builds.
+ */
+import { existsSync } from 'fs';
+import { resolve, dirname } from 'path';
+import { fileURLToPath } from 'url';
+import { spawnSync } from 'child_process';
+
+const here = dirname(fileURLToPath(import.meta.url));
+const root = resolve(here, '..');
+
+const candidates = [
+  // Local (post-split) copies
+  resolve(root, 'config/vite.spc.config.ts'),
+  // Monorepo root copies
+  resolve(root, '../../config/vite.spc.config.ts')
+];
+
+const cssCandidates = [
+  resolve(root, 'config/vite.spc.css.config.ts'),
+  resolve(root, '../../config/vite.spc.css.config.ts')
+];
+
+function pick(paths) {
+  for (const p of paths) if (existsSync(p)) return p;
+  console.error('No valid config found among:', paths);
+  process.exit(1);
+}
+
+const jsConfig = pick(candidates);
+const cssConfig = pick(cssCandidates);
+
+function run(cmd, args) {
+  const r = spawnSync(cmd, args, { stdio: 'inherit' });
+  if (r.status !== 0) process.exit(r.status);
+}
+
+console.log('[spc-build] Using JS config:', jsConfig);
+run('vite', ['build', '--config', jsConfig]);
+console.log('[spc-build] Using CSS config:', cssConfig);
+run('vite', ['build', '--config', cssConfig]);
+console.log('[spc-build] Completed.');
diff --git a/packages/nhs-fdp-spc/scripts/spc-export-check.cjs b/packages/nhs-fdp-spc/scripts/spc-export-check.cjs
@@ -0,0 +1,60 @@
+#!/usr/bin/env node
+/**
+ * Compare current SPC export surface to snapshot.
+ * Works both in monorepo and in a split repo.
+ */
+const { Project } = require('ts-morph');
+const { readFileSync, existsSync } = require('fs');
+const path = require('path');
+
+function gatherExports(sourceFile) {
+  const names = new Set();
+  sourceFile.getExportedDeclarations().forEach((_decls, name) => names.add(name));
+  return Array.from(names).sort();
+}
+
+function resolvePath(p) {
+  const local = path.resolve(__dirname, '..', p);
+  if (existsSync(local)) return local;
+  const mono = path.resolve(__dirname, '..', '..', p);
+  return mono;
+}
+
+function main() {
+  const snapshotPath = path.resolve(__dirname, '../.exports-snapshot.json');
+  let snapshot;
+  try {
+    snapshot = JSON.parse(readFileSync(snapshotPath, 'utf-8'));
+  } catch (e) {
+    console.log('No snapshot found; create one with npm run spc:exports:snapshot');
+    return;
+  }
+  const tsConfigCandidates = [
+    resolvePath('tsconfig.build.json'),
+    path.resolve(__dirname, '../../tsconfig.build.json')
+  ];
+  const tsConfig = tsConfigCandidates.find((p) => existsSync(p));
+  const project = new Project({ tsConfigFilePath: tsConfig });
+  const files = Object.keys(snapshot);
+  const breaking = [];
+  for (const rel of files) {
+    const abs = resolvePath(rel);
+    const sf = project.addSourceFileAtPathIfExists(abs);
+    if (!sf) continue;
+    const current = gatherExports(sf);
+    const previous = snapshot[rel] || [];
+    const missing = previous.filter((p) => !current.includes(p));
+    if (missing.length) breaking.push({ file: rel, missing });
+  }
+  if (breaking.length) {
+    console.error(
+      'Breaking export changes detected:\n' +
+        breaking.map((b) => `${b.file}: ${b.missing.join(', ')}`).join('\n')
+    );
+    process.exit(1);
+  } else {
+    console.log('Export surface consistent with snapshot.');
+  }
+}
+
+main();
diff --git a/packages/nhs-fdp-spc/src/index.ts b/packages/nhs-fdp-spc/src/index.ts
@@ -1,7 +1,6 @@
 /**
- * Public entry for @nhs-fdp/spc.
- * Re-exports the existing SPC barrel from the monorepo source.
+ * Public entry for @nhsdigital/spc.
+ * Re-exports the existing SPC barrel from the monorepo source (not yet vendored).
  */
-// Re-export SPC barrel from root design system source via root alias
 export * from '@/components/DataVisualisation/charts/SPC';
 
diff --git a/packages/nhs-fdp-spc/tsconfig.json b/packages/nhs-fdp-spc/tsconfig.json
@@ -4,7 +4,7 @@
     "declaration": true,
     "emitDeclarationOnly": false,
     "outDir": "./dist",
-    "rootDir": "./src"
+    
   },
   "include": [
     "./src/**/*",
diff --git a/scripts/spc-subtree-sync.sh b/scripts/spc-subtree-sync.sh

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+/** Engine entry for @nhs-fdp/spc/engine */`
	`2`	`+export * from '../../../../src/components/DataVisualisation/charts/SPC/engine';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+/** Icons entry for @nhs-fdp/spc/icons */`
	`2`	`+export * from '../../../../src/components/DataVisualisation/charts/SPC/icons';`