CS1 Specifications

NPM package containing all CS1 project specifications and documentation.

Description

This package provides programmatic access to the CS1 project specification documents, including process forms, models, user stories, and implementation tasks. It's designed to be consumed by the CS1 frontend application for the Development Tracker dashboard.

Installation

npm install @shadowgames/cs1-specifications

Usage

import {
  specifications,
  documentTree,
  getDocument,
  getPipelineStatus,
  getFilteredDocumentTree
} from '@shadowgames/cs1-specifications';

// Get all specifications as an object
console.log(specifications);

// Get the document tree structure
const tree = getFilteredDocumentTree();

// Get a specific document
const content = getDocument('PIPELINE-STATUS.md');

// Get pipeline status
const status = getPipelineStatus();

Development

Building the Package

The package automatically builds when installing dependencies:

npm install

To manually rebuild:

npm run build

This will:

1. Compile TypeScript files
2. Read all specification files from ../.specifications/
3. Generate dist/specifications-data.js with all content
4. Copy specification files to specifications/ directory

Publishing Updates

When specifications change:

# Increment version
npm version patch  # or minor/major

# Build and publish
npm run build
npm publish

Included Content

All directories and files from .specifications/ are included in the package:

• 0_unstructured - Original specifications
• 1_structured - Structured process forms
• 2_models - Data models
• 3_stories - User stories
• 4_tasks - Implementation tasks
• 5_implemented - Completed implementations
• _archive - Archived documents
• dev-tracker - Development tracker specifications
• examples - Example files and templates
• scripts - Utility scripts

Structure

cs1-specifications/
├── src/
│   └── index.ts          # Main TypeScript source
├── scripts/
│   └── build-specifications.js  # Build script
├── dist/                 # Compiled output (git ignored)
│   ├── index.js
│   ├── index.d.ts
│   └── specifications-data.js
└── specifications/       # Copy of spec files (git ignored)

API

Types

• DocumentNode - Tree node structure for documents
• PipelineStatus - Pipeline status information

Functions

• getDocument(path: string): string | undefined - Get document content by path
• getPipelineStatus(): PipelineStatus - Get current pipeline status
• getFilteredDocumentTree(): DocumentNode[] - Get filtered document tree

Exports

• specifications: Record<string, string> - All specification files
• documentTree: DocumentNode[] - Complete document tree structure

License

UNLICENSED - Private package for CAMA UNITED GmbH

Author

CAMA UNITED GmbH