From 06a987e4f0d1fe6c7fc0865c4ff13930a9ea9d44 Mon Sep 17 00:00:00 2001
From: Philipp Kursawe <phil.kursawe@gmail.com>
Date: Sun, 27 Oct 2019 21:27:23 +0100
Subject: [PATCH] feat: Add $schema property to schema

VS Code supports [code completion for JSON files](https://code.visualstudio.com/docs/languages/json) based on [JSON Schema](https://json-schema.org/specification.html).

Code completion in VS Code picks up a schema for any JSON file if the schema is
specified as `"$schema": "<URL to schema>"`.

It automatically picks up [certain JSON Schemas](https://code.visualstudio.com/docs/languages/json#_json-schemas-and-settings) by file name (ie: `package.json`) and you can configure your own associations via (workspace) `settings.json` like this:

```json
"json.schemas": [
  {
    "fileMatch": [
      "resume.json"
    ],
    "url": "http://json.schemastore.org/resumic-schema.json"
  }
]
```

Alternatively VS Code supports the `$schema` key in JSON files itself.

So in a `resume.json` we could add the [JSON Resumic schema](http://json.schemastore.org/resumic-schema.json) to get code completion without touching the VS Code settings:

```json
{
  "$schema": "http://json.schemastore.org/resumic-schema.json",

}
```

[XML](https://www.w3.org/TR/2008/REC-xml-20081126/) had a similar feature where you could specify an [XSD](https://www.w3.org/TR/xmlschema-0/) in the XML pre-processing tags to validate the syntax and data (to some extent) of the XML.
---
 schema.json | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/schema.json b/schema.json
index 706cd1a..536ef61 100644
--- a/schema.json
+++ b/schema.json
@@ -687,6 +687,17 @@
       },
       "type": "array"
     },
+    "$schema": {
+      "type": "string",
+      "format": "uri",
+      "title": "JSON Schema to use",
+      "default": "http://json.schemastore.org/resumic-schema.json",
+      "description": "Editors like VS Code use this schema for validation and triggering suggestions when editing resumic JSON files.",
+      "examples": [
+        "http://json.schemastore.org/resumic-schema.json",
+        "https://raw.githubusercontent.com/resumic/schema/master/schema.json"
+      ]
+    },
     "skills": {
       "description": "list of professional skill-sets",
       "items": {