Skip to content

schema.md

Latest commit

 

History

History
37 lines (29 loc) · 903 Bytes

schema.md

File metadata and controls

37 lines (29 loc) · 903 Bytes
Raw

Schema & Data Models

While ForgeTS is primarily a CLI/scaffolding tool, it uses schemas to validate configuration and user inputs.

Project Configuration

When generating a project, ForgeTS may use a configuration file (e.g., forge.config.json or forgets.json in the future) to persist settings.

Scaffolding Spec

The generator input often follows a schema like:

interface ProjectOptions {
  name: string;
  template: 'react-vite' | 'node-api';
  language: 'typescript';
  packageManager: 'pnpm' | 'npm' | 'yarn';
  features: string[]; // e.g., ['auth', 'database']
}

Internal Data Structures

Template Manifest

Each template may include a manifest.json describing its capabilities:

{
  "name": "react-vite-template",
  "version": "1.0.0",
  "description": "React + Vite + TypeScript starter",
  "variables": [
    "APP_NAME",
    "API_URL"
  ]
}