|
106 | 106 | </ul> |
107 | 107 | </li> |
108 | 108 | <li class="toctree-l2"><a class="reference internal" href="#yaml-file-format">YAML File Format</a><ul> |
| 109 | +<li class="toctree-l3"><a class="reference internal" href="#json-schema">JSON Schema</a></li> |
109 | 110 | <li class="toctree-l3"><a class="reference internal" href="#package-definition">Package Definition</a><ul> |
110 | 111 | <li class="toctree-l4"><a class="reference internal" href="#package-definition">Package Definition</a></li> |
111 | 112 | </ul> |
@@ -1027,6 +1028,25 @@ <h3>GITHUB_TOKEN<a class="headerlink" href="#github-token" title="Link to this h |
1027 | 1028 | </section> |
1028 | 1029 | <section id="yaml-file-format"> |
1029 | 1030 | <h2>YAML File Format<a class="headerlink" href="#yaml-file-format" title="Link to this heading"></a></h2> |
| 1031 | +<section id="json-schema"> |
| 1032 | +<h3>JSON Schema<a class="headerlink" href="#json-schema" title="Link to this heading"></a></h3> |
| 1033 | +<p>IVPM provides a JSON Schema for <code class="docutils literal notranslate"><span class="pre">ivpm.yaml</span></code> files that enables IDE autocompletion |
| 1034 | +and validation. To use it, add a <code class="docutils literal notranslate"><span class="pre">$schema</span></code> reference at the top of your file:</p> |
| 1035 | +<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">$schema</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://fvutils.github.io/ivpm/ivpm.schema.json</span> |
| 1036 | + |
| 1037 | +<span class="nt">package</span><span class="p">:</span> |
| 1038 | +<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-project</span> |
| 1039 | +<span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">"0.1.0"</span> |
| 1040 | +</pre></div> |
| 1041 | +</div> |
| 1042 | +<p>The schema is available at:</p> |
| 1043 | +<ul class="simple"> |
| 1044 | +<li><p><strong>Primary:</strong> <a class="reference external" href="https://fvutils.github.io/ivpm/ivpm.schema.json">https://fvutils.github.io/ivpm/ivpm.schema.json</a></p></li> |
| 1045 | +<li><p><strong>Legacy (backwards compatibility):</strong> <a class="reference external" href="https://fvutils.github.io/ivpm/ivpm.json">https://fvutils.github.io/ivpm/ivpm.json</a></p></li> |
| 1046 | +</ul> |
| 1047 | +<p>Most modern editors (VS Code, IntelliJ, Vim with LSP) will automatically provide |
| 1048 | +validation and autocompletion when the <code class="docutils literal notranslate"><span class="pre">$schema</span></code> field is present.</p> |
| 1049 | +</section> |
1030 | 1050 | <section id="package-definition"> |
1031 | 1051 | <h3>Package Definition<a class="headerlink" href="#package-definition" title="Link to this heading"></a></h3> |
1032 | 1052 | <section id="package-definition"> |
|
0 commit comments