dc03bff324
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.
52 lines
1.1 KiB
Markdown
52 lines
1.1 KiB
Markdown
# 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.
|
|
|
|
1. **Create a virtual environment:**
|
|
|
|
```bash
|
|
python3 -m venv ./scripts/validate-collections-yaml/.venv
|
|
```
|
|
|
|
2. **Activate the virtual environment:**
|
|
|
|
```bash
|
|
source ./scripts/validate-collections-yaml/.venv/bin/activate
|
|
```
|
|
|
|
3. **Install dependencies:**
|
|
|
|
```bash
|
|
python3 -m pip install -r ./scripts/validate-collections-yaml/requirements.txt
|
|
```
|
|
|
|
4. **Run the script:**
|
|
|
|
```bash
|
|
python3 ./scripts/validate-collections-yaml
|
|
```
|
|
|
|
## Running Globally
|
|
|
|
Running the script globally is less recommended due to potential dependency conflicts.
|
|
|
|
1. **Install dependencies:**
|
|
|
|
```bash
|
|
python3 -m pip install -r ./scripts/validate-collections-yaml/requirements.txt
|
|
```
|
|
|
|
2. **Run the script:**
|
|
|
|
```bash
|
|
python3 ./scripts/validate-collections-yaml
|
|
```
|