coulomb/markitect-main
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
markitect-main/markitect
History
tegwick 14108533fb feat: implement schema filename validation (Phase 1 complete) 
Implements filename convention enforcement for schema files as part of
the schema-of-schemas implementation. All schemas must now follow the
naming pattern: {domain}-schema-v{major}.{minor}.md

## Phase 1 Deliverables

### Schema Naming Module
**File:** `markitect/schema_naming.py` (380 lines)

**Functions:**
- `validate_schema_filename()` - Validate filename against pattern
- `suggest_schema_filename()` - Generate valid filename from domain/version
- `extract_schema_metadata()` - Extract domain and version from filename
- `get_validation_errors()` - Detailed error messages for invalid filenames
- `is_valid_schema_filename()` - Simple boolean validation
- `format_validation_message()` - User-friendly error formatting

**Features:**
- Regex-based pattern matching
- Automatic normalization (spaces → hyphens, lowercase)
- Detailed error reporting
- Domain validation (must start with letter)
- Version validation (major.minor format)

### Comprehensive Test Suite
**File:** `tests/test_schema_naming.py` (500+ lines, 50 tests)

**Test Coverage:**
- ✅ Valid filename variations (simple, hyphenated, with numbers)
- ✅ Invalid filenames (wrong extension, missing components, wrong case)
- ✅ Filename suggestion with normalization
- ✅ Metadata extraction
- ✅ Error message generation
- ✅ Edge cases (long names, many hyphens, large versions)
- ✅ Pattern regex validation

**Results:** 50/50 tests passing (100%)

### Specification Document
**File:** `roadmap/schema-of-schemas/SCHEMA_NAMING_SPEC.md`

**Contents:**
- Formal specification of naming convention
- Regular expression pattern with explanation
- Valid and invalid examples
- Version numbering guidelines
- Domain naming best practices
- Normalization rules
- Migration strategy from legacy naming
- Implementation guide

## Naming Convention

### Format
```
{domain}-schema-v{major}.{minor}.md
```

### Examples
```
✓ manpage-schema-v1.0.md
✓ api-documentation-schema-v1.0.md
✓ terminology-schema-v1.0.md
✓ arc42-schema-v2.1.md

✗ manpage.json (wrong extension)
✗ ManPage-schema-v1.0.md (uppercase)
✗ manpage-v1.0.md (missing 'schema')
✗ manpage-schema-v1.md (missing minor version)
```

### Components
- **domain**: Lowercase, hyphen-separated, starts with letter
- **schema**: Literal keyword
- **version**: v{major}.{minor} (SemVer simplified)
- **extension**: .md (markdown)

## Implementation Highlights

### Automatic Normalization
```python
suggest_schema_filename("API Documentation", "2.1")
# → "api-documentation-schema-v2.1.md"

suggest_schema_filename("My_Custom Type", "1.0")
# → "my-custom-type-schema-v1.0.md"
```

### Detailed Error Reporting
```python
format_validation_message("invalid.json")
# → Detailed error list + suggested fix
```

### Metadata Extraction
```python
extract_schema_metadata("manpage-schema-v1.0.md")
# → {'domain': 'manpage', 'version': '1.0', 'major': 1, 'minor': 0}
```

## Migration Plan

Current schemas will be renamed:
```
Old                           → New
────────────────────────────────────────────────────────
terminology-schema.json       → terminology-schema-v1.0.md
api-documentation             → api-documentation-schema-v1.0.md
enhanced-manpage              → manpage-schema-v2.0.md
markdown-manpage              → DELETE (duplicate)
markdown-manpage-schema.json  → DELETE (duplicate)
```

## Phase 1 Status: ✅ COMPLETE

### Completed
- [x] Schema naming module implementation
- [x] Comprehensive test suite (50 tests, 100% passing)
- [x] Specification document
- [x] TODO.md updated

### Next: Phase 2
- [ ] Update CLI schema-ingest with validation
- [ ] Implement markdown schema loader
- [ ] Parse frontmatter and JSON code blocks
- [ ] Update SchemaValidator for .md support

## Testing

```bash
# Run tests
pytest tests/test_schema_naming.py -v
# → 50 passed in 0.48s

# Test interactively
python -c "
from markitect.schema_naming import validate_schema_filename
print(validate_schema_filename('manpage-schema-v1.0.md'))
"
# → (True, {'domain': 'manpage', 'version': '1.0', ...})
```

## Files Changed

- markitect/schema_naming.py (NEW, 380 lines)
- tests/test_schema_naming.py (NEW, 500+ lines)
- roadmap/schema-of-schemas/SCHEMA_NAMING_SPEC.md (NEW)
- TODO.md (updated progress tracking)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-04 23:51:29 +01:00
..
assets refactor: failed attempt at edit mode recovery and robustness implementation 2025-11-12 00:19:03 +01:00
explode_variants feat: complete Issue #150 - Advanced Packaging Features (.mdz, .mdt) 2025-10-13 23:09:18 +02:00
finance feat: reorganize tests by capability with separate test targets 2025-10-25 02:37:45 +02:00
graphql feat: reorganize tests by capability with separate test targets 2025-10-25 02:37:45 +02:00
legacy feat: Complete Issue #39 - Database CLI Reorganization with Comprehensive Legacy Compatibility System 2025-09-30 17:28:39 +02:00
matter_contentmatter feat: Complete Issue #38 - Full MarkdownMatters CLI implementation with TDD8 methodology 2025-10-02 09:14:24 +02:00
matter_frontmatter feat: implement comprehensive front matter preservation and unicode handling 2025-10-13 20:26:08 +02:00
matter_tailmatter feat: Complete Issue #38 - Full MarkdownMatters CLI implementation with TDD8 methodology 2025-10-02 09:14:24 +02:00
packaging feat: complete Issue #150 - Advanced Packaging Features (.mdz, .mdt) 2025-10-13 23:09:18 +02:00
plugins feat: consolidate testdrive-jsui to capabilities and implement plugin self-declaration 2025-12-15 23:42:54 +01:00
production feat: complete Issue #145 - Phase 4: Production Readiness and Release 2025-10-14 18:15:26 +02:00
profile feat: implement comprehensive User Profile Management System (issue #107) 2025-10-04 01:53:31 +02:00
query_paradigms feat: reorganize tests by capability with separate test targets 2025-10-25 02:37:45 +02:00
schemas feat: add terminology schema example and improve schema-list command 2026-01-04 23:07:36 +01:00
static/css feat: Complete Phase 4 - Remove legacy JavaScript files 2025-12-16 10:27:05 +01:00
template feat: Complete Issue #65 Template Engine Foundation + Fix CLI Regression 2025-10-02 15:33:32 +02:00
templates fix: CSS injection and theme application bugs 2025-12-17 12:02:42 +01:00
themes feat: implement modular theme system with file-based theme organization 2025-11-10 11:43:25 +01:00
__init__.py chore: gitignore and repo cleanup 2025-09-16 03:04:18 +02:00
__version__.py refactor: delegate version management to release-management capability 2025-11-09 10:41:28 +01:00
asset_commands.py feat: implement Issue #143 - CLI integration and user experience for asset management 2025-10-14 13:46:34 +02:00
associated_files.py feat: Complete Issue #40 - Associated Files Management with Interactive vs Automation Mode System 2025-09-30 13:09:37 +02:00
ast_cache.py feat: Strategic pivot to CLI implementation with comprehensive foundation 2025-09-24 01:14:27 +02:00
ast_service.py fix: Improve AST display content visibility for Issue #15 2025-09-27 09:31:47 +02:00
batch_processor.py feat: implement batch processing and recursive operations (issue #17) 2025-10-03 10:45:43 +02:00
cache_service.py feat: Complete logging standardization with context-aware system 2025-09-27 08:28:10 +02:00
clean_document_manager.py fix: CSS injection and theme application bugs 2025-12-17 12:02:42 +01:00
cli.py feat: add terminology schema example and improve schema-list command 2026-01-04 23:07:36 +01:00
cli_utils.py feat: implement Issue #143 - CLI integration and user experience for asset management 2025-10-14 13:46:34 +02:00
config_manager.py feat: optimize code quality with pylint analysis and critical fixes - Issue #130 2025-10-06 03:03:38 +02:00
database.py feat: optimize code quality with pylint analysis and critical fixes - Issue #130 2025-10-06 03:03:38 +02:00
document_manager.py feat: complete clean editor implementation with comprehensive UI framework 2025-10-28 03:50:21 +01:00
draft_generator.py refactor: enhance draft generator documentation and code quality 2025-10-03 10:35:16 +02:00
exceptions.py feat: optimize code quality with pylint analysis and critical fixes - Issue #130 2025-10-06 03:03:38 +02:00
frontmatter.py feat: optimize code quality with pylint analysis and critical fixes - Issue #130 2025-10-06 03:03:38 +02:00
legacy_compat.py feat: optimize code quality with pylint analysis and critical fixes - Issue #130 2025-10-06 03:03:38 +02:00
legacy_integration_example.py feat: Complete Issue #39 - Database CLI Reorganization with Comprehensive Legacy Compatibility System 2025-09-30 17:28:39 +02:00
metaschema.py feat: implement Phase 1 - Enhanced Schema Format with Classifications 2026-01-04 21:02:51 +01:00
parser.py feat: Complete Issue #8 - Detailed Validation Error Reporting and CLI Enhancements 2025-09-29 21:21:21 +02:00
performance_tracker.py feat: optimize code quality with pylint analysis and critical fixes - Issue #130 2025-10-06 03:03:38 +02:00
schema_analyzer.py feat: add Phase 2 schema refinement tools (schema-analyze and schema-refine) 2026-01-04 21:29:08 +01:00
schema_generator.py feat: optimize code quality with pylint analysis and critical fixes - Issue #130 2025-10-06 03:03:38 +02:00
schema_naming.py feat: implement schema filename validation (Phase 1 complete) 2026-01-04 23:51:29 +01:00
schema_refiner.py feat: add interactive mode to schema-refine command 2026-01-04 21:30:55 +01:00
schema_validator.py feat: optimize code quality with pylint analysis and critical fixes - Issue #130 2025-10-06 03:03:38 +02:00
serializer.py feat: optimize code quality with pylint analysis and critical fixes - Issue #130 2025-10-06 03:03:38 +02:00
stub_generator.py feat: optimize code quality with pylint analysis and critical fixes - Issue #130 2025-10-06 03:03:38 +02:00
validation_error.py feat: Complete Issue #8 - Detailed Validation Error Reporting and CLI Enhancements 2025-09-29 21:21:21 +02:00
workspace.py feat: complete Issue #144 - Phase 3: Advanced Features and Performance 2025-10-14 17:53:47 +02:00