Files

undergroundwires dc03bff324 Add schema validation for collection files #369

This commit improves collection file editing and error detection
directly in the IDE. It adds YAML schema, IDE configuration and
automatic tests to validate it.

- Introduce a YAML schema for collection file.
- Use `yaml-language-server` for enhanced YAML support in VSCode.
- Add telemetry disabling in `configure_vscode.py` to respect user
  privacy.
- Add automated checks to validate YAML file structure against the
  schema.
- Remove unused properties and do not allow them in compiler.

2024-06-17 14:01:07 +02:00

1.1 KiB

Raw Blame History

validate-collections-yaml

This script validates YAML collection files against a predefined schema to ensure their integrity.

Prerequisites

Python 3.x installed on your system.

Running in a Virtual Environment (Recommended)

Using a virtual environment isolates dependencies and prevents conflicts.

Create a virtual environment:

python3 -m venv ./scripts/validate-collections-yaml/.venv

Activate the virtual environment:

source ./scripts/validate-collections-yaml/.venv/bin/activate

Install dependencies:

python3 -m pip install -r ./scripts/validate-collections-yaml/requirements.txt

Run the script:

python3 ./scripts/validate-collections-yaml

Running Globally

Running the script globally is less recommended due to potential dependency conflicts.