{"id":13942388,"url":"https://github.com/ajmarkow/espanso-schema-json","last_synced_at":"2025-07-20T06:31:09.204Z","repository":{"id":194696560,"uuid":"691387396","full_name":"ajmarkow/espanso-schema-json","owner":"ajmarkow","description":"A schema definition following the JSON Schema specification. It describes the requirements and options for YAML objects for the configuration files of the text expander program Espanso (https://espanso.org).","archived":false,"fork":false,"pushed_at":"2023-10-16T01:49:42.000Z","size":174,"stargazers_count":5,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-27T12:36:41.379Z","etag":null,"topics":["espanso","json-schema"],"latest_commit_sha":null,"homepage":"https://ajm.codes/Espanso_Matches_File_Schema.json","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ajmarkow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-14T04:40:54.000Z","updated_at":"2024-06-27T15:05:17.000Z","dependencies_parsed_at":"2023-09-14T18:53:29.253Z","dependency_job_id":"7d8ea5ea-9b79-4906-84d9-f28239a0808e","html_url":"https://github.com/ajmarkow/espanso-schema-json","commit_stats":null,"previous_names":["ajmarkow/espanso-schema-json"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ajmarkow/espanso-schema-json","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajmarkow%2Fespanso-schema-json","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajmarkow%2Fespanso-schema-json/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajmarkow%2Fespanso-schema-json/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajmarkow%2Fespanso-schema-json/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ajmarkow","download_url":"https://codeload.github.com/ajmarkow/espanso-schema-json/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajmarkow%2Fespanso-schema-json/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266076350,"owners_count":23872741,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["espanso","json-schema"],"created_at":"2024-08-08T02:01:50.476Z","updated_at":"2025-07-20T06:31:08.945Z","avatar_url":"https://github.com/ajmarkow.png","language":null,"funding_links":[],"categories":["Others"],"sub_categories":[],"readme":"# Espanso JSON Schemas\n\n- [About](#about)\n- [Schemas](#schemas)\n- [Usage](#usage)\n\n## About\n\nThese are JSON Schema Specification compliant Schemas, which describe the requirements and options for YAML configuration and match files for the program Espanso. Based upon the documentation at \u003chttps://espanso.org\u003e.\n\n## Schemas\n\nThis repository includes 3 schemas. The links below are updated to the most recent version with each update:\n\n- [Espanso_Matches_File_Schema.json](https://ajm.codes/Espanso_Matches_File_Schema.json) ← A schema for a match file, either the base file, or an application specific file.\n- [Espanso_Match_Schema.json](https://ajm.codes/Espanso_Match_Schema.json) ← A schema for individual matches within a match file.\n- [Espanso_Config_File_Schema.json](https://ajm.codes/Espanso_Config_File_Schema.json) ← A schema for espanso configuration files, either the base file, or application specific configurations.\n\n## Usage\n\n1. **Prerequisites**:\n\n    - Before using this schema to validate your Espanso .yml files in VS Code, make sure you have the YAML extension installed in VS Code.\n    - You can find the extension [here](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml).\n    - Clone the schemas folder to your computer.\n\n2. **Configuration**: To enable validation, add the following line to any Espanso match files where you want validation:\n\n    ```yaml\n    # yaml-language-server: $schema=(PATH)\n    ```\n\n    - Replace `(PATH)` with the actual path to the `Espanso_Matches_File_Schema.json` file, located in the schemas folder on your system.\n    - Ensure that both `Espanso_Matches_File_Schema.json` and `Espanso_Match_Schema.json` are downloaded and kept in the same directory.\n    - Note that `Espanso_Matches_File_Schema.json` depends on `Espanso_Match_Schema.json`.\n\n3. **Validation and Completion**: After configuration, any errors will be displayed in the problems pane of VS Code. You can also take advantage of IntelliSense completions while manually editing your configuration files, like `base.yml`.\n\n4. **Integration**: This schema is also utilized for validation in the [total_rewrite_of_snippet_cli_gem](https://github.com/ajmarkow/total_rewrite_of_snippet_cli_gem) project.\n\n### TODO ↓\n\n- Implement conditions on any remaining invalid form property combinations. By refactoring lines 105-154\n\n## Resources\n\n- Good tool to check schema/json doc for compliance with spec: \u003chttps://www.jeremydorn.com/json-editor\u003e\n- Tools for working with YAML \u0026 JSON from [JSON Formatter](https://jsonformatter.org/#:~:text=SOAP%20Formatter-,YAML,-YAML%20Validator).\n- Build a react UI from a JSON Schema using [react-jsonschema-form](https://github.com/rjsf-team/react-jsonschema-form).\n\n## License\n\n- This software is licensed under the [GNU GENERAL PUBLIC LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) V3.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajmarkow%2Fespanso-schema-json","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fajmarkow%2Fespanso-schema-json","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajmarkow%2Fespanso-schema-json/lists"}