MetaDSL

A powerful TypeScript library for defining schemas, validating YAML configuration files, and providing IntelliSense features (completions, hover documentation) for structured data.

Links

• Demo page
• Full documentation

Features

• Schema Definition: Define structured schemas with type safety using TypeScript types
• YAML Validation: Validate YAML configuration files against defined schemas
• IntelliSense Support: Provide auto-completions and hover documentation for configuration files
• Advanced Validation: Support for synchronous and asynchronous validation functions
• Complex Relationships: Define field dependencies (with, without, or conditions)
• Enum Support: Enumerated values with conditional logic
• Numeric Types: Strict numeric type validation (int8-128, uint8-128, float16-64, etc.)
• Custom Metadata: Add documentation, deprecation notices, and details for fields

Best Practices

1. Define Complete Schemas: Always provide default values and metadata for better IntelliSense
2. Use Strict Numeric Types: When dealing with binary protocols or specific ranges
3. Leverage Async Validation: For checks that require I/O (database, network, file system)
4. Provide Documentation: Use metadata fields to help users understand configuration options
5. Test Validation: Test both valid and invalid configurations to ensure proper error messages

Integration with VS Code

MetaDSL can be integrated with VS Code extensions to provide IntelliSense for custom configuration formats. Use getCompletions and getHoverItem methods to implement language server features.

License

MIT - See LICENSE file for details.