redhat-developer/yaml-language-server
Yaml Language Server
The YAML Language Server is a backend service that provides intelligent editing support for YAML files by implementing the Language Server Protocol. It functions as a validation and analysis engine, enabling code editors to offer real-time diagnostics, structural feedback, and automated assistance for configuration-heavy development workflows.
The project distinguishes itself through its schema-driven approach to data integrity, utilizing a JSON Schema validation engine to verify document structure against formal definitions. It supports complex configuration management by allowing developers to associate files with specific schemas via glob patterns, and it extends its parsing capabilities to handle custom YAML tags, ensuring that non-standard data types are correctly recognized and validated.
Beyond core validation, the server provides a suite of productivity tools including intelligent code completion, contextual documentation via hover tooltips, and automated document formatting. It also generates hierarchical symbols for document outlining, facilitating navigation within large or complex configuration files. The service processes documents incrementally to provide immediate feedback during the editing process.
Features
- Language Server Protocol Implementations - Communicates with code editors using a standardized JSON-RPC interface to provide real-time diagnostics and intelligent code assistance.
- General YAML Syntax Validators - Checks files for structural errors and adherence to schema definitions to provide real-time feedback and prevent configuration issues during editing.
- Infrastructure Configuration Validations - Supports writing and maintaining complex configuration files by providing real-time validation, intelligent autocompletion, and schema-based guidance for developers.
- Data Schema Validation - Ensures that structured data files adhere to predefined schemas and business rules to maintain data integrity across software projects.
- JSON Schema Validation - Evaluates document structure against formal data definitions to identify type mismatches and missing required properties during editing.
- YAML Format Modifiers - Standardizes document layout by applying consistent indentation, spacing, and wrapping rules to improve readability and maintainability of configuration files.
- Kubernetes Manifest Editors - Enables creating and editing Kubernetes resource files with automated schema validation to ensure compliance with cluster requirements and prevent deployment errors.
- Development Tools & Productivity - Enhances the code editing experience by providing contextual documentation, document navigation, and automated formatting for configuration-heavy development workflows.
- Code Intelligence Snippets - Provides intelligent autocompletion for keys and values based on associated data schemas, including default values for scalar nodes.
- Document Structure Navigators - Generates hierarchical symbols for data nodes to enable quick navigation and outline views within an editor for complex configuration files.
- Glob-Based File Location - Matches configuration files to specific validation rules by evaluating file paths against defined pattern rules at runtime.
- IDE Language Plugins - Provides a protocol-based service that enables advanced editing features like document outlining and symbol navigation for structured data formats.
- Integrated Development Environment Plugins - Integrates with code editors as a backend service to provide real-time feedback, documentation, and navigation for configuration files.
- Abstract Syntax Tree Parsing - Converts raw YAML text into a hierarchical node structure to enable efficient document navigation and precise location of syntax errors.
- YAML Tag Customization - Allows the parser to recognize and validate non-standard data types by registering specialized handlers for application-specific YAML tags.
- Informative Tooltips - Shows schema descriptions, anchor details, and source information in hover tooltips to help users understand the underlying structure of complex data files.
- Incremental Parse Feedback - Processes only modified sections of a file to provide immediate feedback without re-parsing the entire document on every keystroke.
