@a-company/purpose-core

Purpose file parsing, validation, and aggregation

Core library for working with .purpose files - the structured documentation format that provides AI-friendly context about your codebase.

Installation

npm install @a-company/purpose-core

Usage

import { 
  findPurposeFiles, 
  parsePurposeFile, 
  validatePurposeFile 
} from '@a-company/purpose-core';

// Find all .purpose files in a directory
const files = await findPurposeFiles('./src');

// Parse a .purpose file
const purpose = await parsePurposeFile('./src/.purpose');

// Validate a .purpose file
const result = validatePurposeFile(purpose);
if (!result.valid) {
  console.error(result.errors);
}

Purpose File Format

purpose: User authentication module
context:
  - Handles login, logout, and session management
  - Integrates with OAuth providers
features:
  - "@email-login": Email/password authentication
  - "@oauth-google": Google OAuth integration
components:
  - "#AuthProvider": React context for auth state
  - "#LoginForm": Login form component

Documentation

See the main repository for full documentation.

License

MIT