Buckets:
| """Generation of the JSON schema for ``calkit.yaml``. | |
| The schema is derived from the ``ProjectInfo`` Pydantic model, so the models | |
| stay the single source of truth. It is published so editors can validate and | |
| autocomplete ``calkit.yaml``, e.g., with the YAML extension for VS Code. | |
| """ | |
| from __future__ import annotations | |
| import json | |
| import os | |
| # The URL at which the schema is published, used as its ``$id`` and in the | |
| # modeline written into new projects' calkit.yaml files | |
| SCHEMA_URL = "https://docs.calkit.org/schemas/calkit.json" | |
| # Paths of the checked-in copies, relative to the repo root. The first is | |
| # served at SCHEMA_URL by MkDocs; the second is bundled into the VS Code | |
| # extension so it works offline, via its yamlValidation contribution point. | |
| SCHEMA_REPO_PATHS = [ | |
| "docs/schemas/calkit.json", | |
| "vscode-ext/schemas/calkit.json", | |
| ] | |
| MODELINE = f"# yaml-language-server: $schema={SCHEMA_URL}" | |
| def generate() -> dict: | |
| """Generate the JSON schema for ``calkit.yaml``.""" | |
| from calkit.models import ProjectInfo | |
| schema = ProjectInfo.model_json_schema() | |
| return { | |
| # Pydantic emits 2020-12 but doesn't declare the dialect, which some | |
| # validators need in order to pick the right one | |
| "$schema": "https://json-schema.org/draft/2020-12/schema", | |
| "$id": SCHEMA_URL, | |
| **schema, | |
| # These override what Pydantic derives from the model's name and | |
| # docstring, since they're shown to users in editors and catalogs | |
| "title": "Calkit project information", | |
| "description": ( | |
| "Metadata for a Calkit project, describing its environments, " | |
| "pipeline, and artifacts. See https://docs.calkit.org/calkit-yaml" | |
| ), | |
| } | |
| def generate_json() -> str: | |
| """Generate the JSON schema as formatted JSON text.""" | |
| return json.dumps(generate(), indent=2, sort_keys=True) + "\n" | |
| def ensure_modeline(fpath: str = "calkit.yaml") -> None: | |
| """Add the schema modeline to a ``calkit.yaml`` file if it lacks one. | |
| This is what makes editors validate and autocomplete the file without any | |
| per-user configuration. It's only added to newly created files, since | |
| ``ruamel.yaml`` preserves it on subsequent reads and writes. | |
| A file that already declares a schema anywhere is left alone rather than | |
| given a second, conflicting modeline, so this prepends only when there is | |
| none at all. | |
| """ | |
| if os.path.isfile(fpath): | |
| with open(fpath, encoding="utf-8") as f: | |
| txt = f.read() | |
| else: | |
| txt = "" | |
| if "yaml-language-server: $schema=" in txt: | |
| return | |
| with open(fpath, "w", encoding="utf-8") as f: | |
| f.write(MODELINE + "\n" + txt) | |
Xet Storage Details
- Size:
- 2.7 kB
- Xet hash:
- 8934b464510302332fbe1760906042d3414e3430d134299066172513bfa838d0
·
Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.