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.
14 lines
739 B
Markdown
14 lines
739 B
Markdown
# Collections
|
|
|
|
This directory contains the **collection files**, which are the central source of truth for scripts and categories within privacy.sexy.
|
|
|
|
In addition to the collection files, this folder contains two special files:
|
|
|
|
- [`.schema.yaml`](./.schema.yaml): Provides the schema definition for collection files.
|
|
- [`collection.yaml.d.ts`](./collection.yaml.d.ts): Defines TypeScript typings for the collection files.
|
|
|
|
## Additional documentation
|
|
|
|
- Refer to [`collection-files.md`](./../../../docs/collection-files.md) for details on the structure of these files.
|
|
- To validate these files, use the `validate-collections-yaml` script. For instructions, see its [`README.md`](./../../../scripts/validate-collections-yaml/README.md).
|