<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>vscode-extension/vsc-extension-quickstart.md - fork/numbat @ v1.6.3</title>
<meta name="description" content="vscode-extension/vsc-extension-quickstart.md in fork/numbat at v1.6.3.">
<meta property="og:title" content="vscode-extension/vsc-extension-quickstart.md - fork/numbat @ v1.6.3">
<meta property="og:description" content="vscode-extension/vsc-extension-quickstart.md in fork/numbat at v1.6.3.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="v1.6.3" data-tip="52bc0d26a5b7aeb998746750385871b44749f8f4">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/numbat</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/numbat</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">David Peter</span><span class="commit-message" data-commit="ae7be9b3e4fca8b947539aba9558e40c00143199">Rename project to Numbat</span><span class="snapshot-sha sha" data-commit="ae7be9b3e4fca8b947539aba9558e40c00143199">ae7be9b</span><time datetime="2023-03-01T08:30:05+01:00" title="2023-03-01 08:30:05 +0100">2023-03-01</time></p>
<header class="topbar"><details class="switcher"><summary>v1.6.3</summary><div class="menu"><strong>branches</strong><a href="/fork/numbat/ref/master/">master</a><strong>tags</strong><a href="/fork/numbat/ref/v1.6.0/">v1.6.0</a><a href="/fork/numbat/ref/v1.6.1/">v1.6.1</a><a href="/fork/numbat/ref/v1.6.2/">v1.6.2</a><a class="current" href="/fork/numbat/ref/v1.6.3/">v1.6.3</a><a href="/fork/numbat/ref/v1.7.0/">v1.7.0</a><a href="/fork/numbat/ref/v1.8.0/">v1.8.0</a><a class="all" href="/fork/numbat/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/numbat/">numbat</a> / <a href="/fork/numbat/ref/v1.6.3/tree/vscode-extension/">vscode-extension</a> / <span class="cur">vsc-extension-quickstart.md</span></nav>
<span class="view-stats"><span>1.6 KiB</span><span>29 lines</span></span><span class="actions"><a class="raw" href="/fork/numbat/raw/e4c59f0cfe6e7b8c687ebab4c9b5330f3ad5af39/vscode-extension/vsc-extension-quickstart.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Welcome to your VS Code Extension</h1>
<h2>What's in the folder</h2>
<ul>
<li>This folder contains all of the files necessary for your extension.</li>
<li><code>package.json</code> - this is the manifest file in which you declare your language support and define the location of the grammar file that has been copied into your extension.</li>
<li><code>syntaxes/numbat.tmLanguage.json</code> - this is the Text mate grammar file that is used for tokenization.</li>
<li><code>language-configuration.json</code> - this is the language configuration, defining the tokens that are used for comments and brackets.</li>
</ul>
<h2>Get up and running straight away</h2>
<ul>
<li>Make sure the language configuration settings in <code>language-configuration.json</code> are accurate.</li>
<li>Press <code>F5</code> to open a new window with your extension loaded.</li>
<li>Create a new file with a file name suffix matching your language.</li>
<li>Verify that syntax highlighting works and that the language configuration settings are working.</li>
</ul>
<h2>Make changes</h2>
<ul>
<li>You can relaunch the extension from the debug toolbar after making changes to the files listed above.</li>
<li>You can also reload (<code>Ctrl+R</code> or <code>Cmd+R</code> on Mac) the VS Code window with your extension to load your changes.</li>
</ul>
<h2>Add more language features</h2>
<ul>
<li>To add features such as intellisense, hovers and validators check out the VS Code extenders documentation at https://code.visualstudio.com/docs</li>
</ul>
<h2>Install your extension</h2>
<ul>
<li>To start using your extension with Visual Studio Code copy it into the <code>&lt;user home&gt;/.vscode/extensions</code> folder and restart Code.</li>
<li>To share your extension with the world, read on https://code.visualstudio.com/docs about publishing an extension.</li>
</ul>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Welcome to your VS Code Extension</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>##</a-p> <a-tt>What&#39;s in the folder</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>* </a-p>This folder contains all of the files necessary for your extension.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>* </a-p>`package.json` - this is the manifest file in which you declare your language support and define the location of the grammar file that has been copied into your extension.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>* </a-p>`syntaxes/numbat.tmLanguage.json` - this is the Text mate grammar file that is used for tokenization.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>* </a-p>`language-configuration.json` - this is the language configuration, defining the tokens that are used for comments and brackets.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>## </a-p><a-tt>Get up and running straight away</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>* Make sure the language configuration settings in `language-configuration.json` are accurate.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>* Press `F5` to open a new window with your extension loaded.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>* Create a new file with a file name suffix matching your language.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>* Verify that syntax highlighting works and that the language configuration settings are working.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>## </a-p><a-tt>Make changes</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>* You can relaunch the extension from the debug toolbar after making changes to the files listed above.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>* You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>## </a-p><a-tt>Add more language features</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>* To add features such as intellisense, hovers and validators check out the VS Code extenders documentation at https://code.visualstudio.com/docs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>## </a-p><a-tt>Install your extension</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>* To start using your extension with Visual Studio Code copy it into the `&lt;user home&gt;/.vscode/extensions` folder and restart Code.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>* </a-p>To share your extension with the world, read on https://code.visualstudio.com/docs about publishing an extension.</span></span></pre></div></div>
</main>
</body>
</html>
