@o-zone/scorer-core

Orienteering scoring core library with modular exports for server, race, and competition management.

Installation

pnpm add @o-zone/scorer-core

Usage

Server Module

import { Scorer } from '@o-zone/scorer-core/server';

Race Module

import { ... } from '@o-zone/scorer-core/race';

Competition Module

import { ... } from '@o-zone/scorer-core/competition';

Development

Setup

pnpm install

Build

pnpm run build              # Compile TypeScript → dist/
pnpm run build:watch        # Watch mode for development

Quality Checks

pnpm run check:types         # TypeScript type checking
pnpm run lint               # Code quality with Biome
pnpm run lint:fix           # Auto-fix lint issues
pnpm run format             # Code formatting

Publishing

This package uses Changesets for automated version management and npm publishing.

Workflow

1. Make code changes
2. Run pnpm changeset add to document changes
3. Push to main branch
4. GitHub Actions automatically:
   • Creates a Release PR (bumps version, updates changelog)
   • Publishes to npm when PR is merged

Documentation

• Quick Reference - One-page reference

Package Structure

src/
├── server.ts          # Server module
├── race/index.ts      # Race module
└── competition/       # Competition module

dist/                  # Built output (published to npm)

Scripts

| Command | Purpose | |---------|---------| | pnpm run build | Build TypeScript to dist/ | | pnpm run build:watch | Watch mode build | | pnpm run check:types | Type check without emit | | pnpm run lint | Lint code | | pnpm run lint:fix | Auto-fix lint issues | | pnpm run format | Format code | | pnpm changeset add | Create a changeset | | pnpm run publish | Build and publish |

Technologies

• Language: TypeScript 5.3+
• Runtime: pnpm 1.3.5+
• Package Manager: pnpm
• Linter: Biome
• Release Management: Changesets
• CI/CD: GitHub Actions
• Module Format: ES Modules (ESM)

License

MIT

Contributing

1. Create a feature branch
2. Make your changes
3. Run pnpm run lint:fix to format
4. Create a changeset: pnpm changes
5. Push and create a pull request