poc-api-design-system

Organizational API design system library for TypeSpec. Ensures all APIs across the organization follow the same design standards and patterns.

Installation

npm install poc-api-design-system

Configuration

1. Create or update your tspconfig.yaml:

linter:
  extends:
    - poc-api-design-system/recommended

2. Import the library in your TypeSpec files:

import "poc-api-design-system";

using PocApiDesignSystem;

@alternateName("myOp")
op myOperation(): void;

Features

• Custom Decorators: Add organizational metadata to your APIs
• Linting Rules: Enforce design standards automatically
• Emitters: Generate consistent output across all APIs

Development

See WARP.md for development instructions.

Running Tests

# Run all tests
npm test

# Run only linter rule tests (recommended for CI)
npm run test:rules

Known Issues

• Decorator tests are currently failing after TypeSpec 1.5 upgrade. The decorator registration mechanism has changed in TypeSpec 1.x. Linter rules and emitters work correctly.

Available Rulesets

• recommended: Recommended rules for most projects
• all: All available rules enabled

License

ISC