prvng_kcl/REFERENCE.md

56 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2025-10-07 11:17:54 +01:00
# KCL Schemas Reference
This directory contains references to existing KCL schema implementations.
## Current Implementation Locations
### Settings Schema
- **Current**: `/Users/Akasha/repo-cnz/src/provisioning/kcl/settings.k`
- **New Reference**: `settings.k` (placeholder created)
### Provider Schemas
- **Current**: Various files in `/Users/Akasha/repo-cnz/src/provisioning/providers/*/kcl/`
- **New Reference**: `providers.k` (to be created)
### Workflow Schemas
- **Current**: Distributed across workflow implementations
- **New Reference**: `workflows.k` (to be created)
## Migration Strategy
### Phase 1: Analysis
- Inventory all existing KCL schemas
- Identify common patterns and duplications
- Document schema relationships
### Phase 2: Consolidation
- Create unified schema files
- Preserve backward compatibility
- Update import paths gradually
### Phase 3: Optimization
- Improve type safety
- Add comprehensive validation
- Enhance documentation
## Benefits of Consolidation
1. **Single Source of Truth**: Unified schema definitions
2. **Type Safety**: Compile-time validation across entire system
3. **Consistency**: Standardized configuration patterns
4. **Maintainability**: Easier schema evolution and updates
## Current Status
- **Reference Files**: Created with placeholders
- **Original Schemas**: Fully functional in existing locations
- **Migration**: Planned for future phase
## Integration
Consolidated schemas will be used by:
- Core provisioning engine
- Code generators
- Configuration validators
- Documentation systems
- IDE integrations (syntax highlighting, autocompletion)