@a-little-world/little-world-design-system-core

Core design tokens, utilities, and shared types for the Little World Design System.

Installation

pnpm add @a-little-world/little-world-design-system-core

Usage

import { colors, spacing, typography } from '@a-little-world/little-world-design-system-core';

// Use design tokens
const styles = {
  backgroundColor: colors.primary,
  padding: spacing.medium,
  fontSize: typography.body.fontSize,
};

Design Tokens

The core package provides:

• Colors - Primary, secondary, and semantic color palettes
• Typography - Font families, sizes, weights, and line heights
• Spacing - Consistent spacing scale
• Breakpoints - Responsive design breakpoints
• Shadows - Elevation and shadow definitions
• Border Radius - Consistent border radius values

Fonts

Font binaries live in src/fonts/ and are exported from src/fonts/index.ts. TypeScript compilation does not copy .ttf files into dist/; a separate copy step runs at the end of the build so published packages include the font files next to the compiled JS.

Build pipeline

The build script runs, in order:

1. clean — removes dist/ and generated .d.ts files under src/
2. preprocess-svgs — processes SVG assets (unrelated to fonts)
3. build:esm / build:cjs — compiles TypeScript to dist/esm and dist/cjs (including fonts/index.js, but not the .ttf binaries)
4. copy-fonts — copies font files into both output trees

copy-fonts uses cpy-cli with --flat, so each file lands directly in dist/esm/fonts/ and dist/cjs/fonts/ (no nested source paths):

copy-fonts:esm  → dist/esm/fonts/
copy-fonts:cjs  → dist/cjs/fonts/

Copied files (must match filenames in src/fonts/):

• SignikaNegative-Variable.ttf
• SignikaNegative-Bold.ttf
• DMSans-Variable.ttf

If you add or rename a font file, update copy-fonts:esm and copy-fonts:cjs in package.json and the paths in src/fonts/index.ts.

Runtime exports (src/fonts/index.ts)

The fonts module is re-exported from the package entry (export * from './fonts').

Native apps should guard usage:

import { fontFiles } from '@a-little-world/little-world-design-system-core';

if (fontFiles) {
  await Font.loadAsync(fontFiles);
}

Local Development

⚠️ Important: Build from Root

Always build and publish from the root of the monorepo, never from individual package directories.

✅ Correct (from root):

pnpm build:core
pnpm --filter=@a-little-world/little-world-design-system-core publish

❌ Incorrect (from package directory):

cd packages/core
pnpm run build
pnpm publish  # This will break workspace dependencies!

Building

# From root of monorepo
pnpm build:core

# Or from the core package directory
cd packages/core
pnpm run build

Testing with Native Package

The core package is automatically built and tested when you run the native testApp:

# This will build both core and native packages
pnpm native:setup

Development Workflow

1. Make changes to design tokens or utilities
2. Build core - pnpm build:core
3. Test in native - pnpm native:setup-and-start (rebuilds and tests)
4. Test in web - pnpm storybook:web (if web components use core tokens)

Publishing

Automated Releases (Recommended)

Releases should ideally be automated and handled via merging into the main branch of the repo.

See the Versioning and Releases section in the root README for detailed information about the automated release process using Changesets.

The automated workflow will:

• Detect version changes in package.json
• Publish to GitHub Packages registry
• Create GitHub releases with changelog information
• Handle all publishing steps automatically

Manual Publishing (Fallback)

If you need to publish manually (not recommended):

# Ensure you're authenticated to GitHub Packages
pnpm login --registry=https://npm.pkg.github.com

# Build the package
pnpm build:core

# Publish from the core package directory
cd packages/core
pnpm publish --access restricted

Note: Manual publishing bypasses the automated changelog generation and release management. Use the automated process whenever possible.

TypeScript

The package includes TypeScript definitions for all design tokens and utilities:

import type { ColorToken, SpacingToken } from '@a-little-world/little-world-design-system-core';

// Type-safe usage
const color: ColorToken = 'primary'; // ✅ Valid
const invalidColor: ColorToken = 'invalid'; // ❌ TypeScript error

Dependencies

This package has minimal dependencies to avoid conflicts:

• typescript - For type definitions
• No runtime dependencies (pure design tokens and utilities)