Skip to content

Commit 5f78387

Browse files
committed
Deploying to gh-pages from @ 24d8942 🚀
1 parent 28cec40 commit 5f78387

File tree

5 files changed

+69
-2
lines changed

5 files changed

+69
-2
lines changed

_sources/getting_started.rst.txt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,27 @@ This creates a basic ``ivpm.yaml`` file:
107107
name: my-project
108108
version: "0.1.0"
109109
110+
**JSON Schema Support**
111+
112+
For IDE autocompletion and validation, add a ``$schema`` reference at the top of your ``ivpm.yaml``:
113+
114+
.. code-block:: yaml
115+
116+
$schema: https://fvutils.github.io/ivpm/ivpm.schema.json
117+
118+
package:
119+
name: my-project
120+
version: "0.1.0"
121+
110122
Step 2: Add Dependency Sets
111123
----------------------------
112124

113125
Edit ``ivpm.yaml`` to add your dependencies:
114126

115127
.. code-block:: yaml
116128
129+
$schema: https://fvutils.github.io/ivpm/ivpm.schema.json
130+
117131
package:
118132
name: my-project
119133
version: "0.1.0"

_sources/reference.rst.txt

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -609,6 +609,28 @@ Useful for GitHub Releases and API queries.
609609
YAML File Format
610610
================
611611

612+
JSON Schema
613+
-----------
614+
615+
IVPM provides a JSON Schema for ``ivpm.yaml`` files that enables IDE autocompletion
616+
and validation. To use it, add a ``$schema`` reference at the top of your file:
617+
618+
.. code-block:: yaml
619+
620+
$schema: https://fvutils.github.io/ivpm/ivpm.schema.json
621+
622+
package:
623+
name: my-project
624+
version: "0.1.0"
625+
626+
The schema is available at:
627+
628+
- **Primary:** https://fvutils.github.io/ivpm/ivpm.schema.json
629+
- **Legacy (backwards compatibility):** https://fvutils.github.io/ivpm/ivpm.json
630+
631+
Most modern editors (VS Code, IntelliJ, Vim with LSP) will automatically provide
632+
validation and autocompletion when the ``$schema`` field is present.
633+
612634
Package Definition
613635
------------------
614636

getting_started.html

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,11 +215,22 @@ <h3>Step 1: Initialize the Project<a class="headerlink" href="#step-1-initialize
215215
<span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;0.1.0&quot;</span>
216216
</pre></div>
217217
</div>
218+
<p><strong>JSON Schema Support</strong></p>
219+
<p>For IDE autocompletion and validation, add a <code class="docutils literal notranslate"><span class="pre">$schema</span></code> reference at the top of your <code class="docutils literal notranslate"><span class="pre">ivpm.yaml</span></code>:</p>
220+
<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>
221+
222+
<span class="nt">package</span><span class="p">:</span>
223+
<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>
224+
<span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;0.1.0&quot;</span>
225+
</pre></div>
226+
</div>
218227
</section>
219228
<section id="step-2-add-dependency-sets">
220229
<h3>Step 2: Add Dependency Sets<a class="headerlink" href="#step-2-add-dependency-sets" title="Link to this heading"></a></h3>
221230
<p>Edit <code class="docutils literal notranslate"><span class="pre">ivpm.yaml</span></code> to add your dependencies:</p>
222-
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">package</span><span class="p">:</span>
231+
<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>
232+
233+
<span class="nt">package</span><span class="p">:</span>
223234
<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>
224235
<span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;0.1.0&quot;</span>
225236
<span class="w"> </span><span class="nt">default-dep-set</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default-dev</span>

reference.html

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@
106106
</ul>
107107
</li>
108108
<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>
109110
<li class="toctree-l3"><a class="reference internal" href="#package-definition">Package Definition</a><ul>
110111
<li class="toctree-l4"><a class="reference internal" href="#package-definition">Package Definition</a></li>
111112
</ul>
@@ -1027,6 +1028,25 @@ <h3>GITHUB_TOKEN<a class="headerlink" href="#github-token" title="Link to this h
10271028
</section>
10281029
<section id="yaml-file-format">
10291030
<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">&quot;0.1.0&quot;</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>
10301050
<section id="package-definition">
10311051
<h3>Package Definition<a class="headerlink" href="#package-definition" title="Link to this heading"></a></h3>
10321052
<section id="package-definition">

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)