-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathide-extensions.html
70 lines (68 loc) · 4.97 KB
/
ide-extensions.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>Metafacture – IDE Extensions</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
</style>
<link rel="stylesheet" href="../github-pandoc.css" />
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
<link rel="Metafacture Icon" type="image/x-icon" href="./img/metafacture-icon.png">
</head>
<body>
<img src="./img/metafacture.png" alt="Metafacture" style="max-width:100%"/>
<center>
<b>
<a href="./index.html">Home</a>
 | 
<a href="./getting-started.html">Getting started</a>
 | 
<a href="https://metafacture.github.io/metafacture-documentation/">Documentation</a>
 | 
<a href="./ide-extensions.html">IDE Extensions</a>
 | 
<a href="https://blog.metafacture.org">Blog</a>
 | 
<a href="https://metafacture.org/playground">Playground</a>
  
</br>
<a href='https://openbiblio.social/@metafacture'><img src='./img/Mastodon.png'/></a>
<a href='https://github.com/metafacture'><img src='./img/GitHub.png'/></a>
</b>
</center>
<header id="title-block-header">
<h1 class="title">IDE Extensions</h1>
</header>
<h2 id="overview">Overview</h2>
<p>Here you will find different IDE extensions and plugins related to the <a href="https://metafacture.org">Metafacture project</a> in order to support working with the framework. At the current state we provide VS Code / Codium Extensions for the Fix language and the Flux language. Both IDE extensions are aiming to support working with Fix and Flux by syntax highlighting, simple auto completion and validation of the Flux/Fix language. As IDE extensions are based on the <a href="https://microsoft.github.io/language-server-protocol/">Language Server Protocol (LSP)</a>, extensions and plugins for other IDEs than VS Code / Codium can easily be added in the future.</p>
<h2 id="setup-a-vs-code-codium-extension">Setup a VS Code / Codium extension</h2>
<p>There are different ways to install extensions for VS Code / Codium.</p>
<ol type="1">
<li><p>The first one is to install from a marketplace. If you use VS Code, the default marketplace is <a href="https://marketplace.visualstudio.com/vscode">Visual Studio Marketplace</a>, for VS Codium it’s <a href="https://open-vsx.org/">Open VSX Registry</a>. All extensions which are presented here are published to both marketplaces. Use the <strong>Search Extensions in Marketplace</strong> search box to search for <strong>metafacture</strong> in the Extensions view.</p></li>
<li><p>The second way to install is to download a VSIX file and install from it. You can download the latest version of the VSIX files for <a href="https://www.metafacture.org/ide-extensions/fix.vsix">Fix</a> and <a href="https://www.metafacture.org/ide-extensions/flux.vsix">Flux</a>. Use the <strong>Install from VSIX</strong> command in the Extensions view drop-down menu and point to the downloaded VSIX.</p></li>
</ol>
<h2 id="usage">Usage</h2>
<h3 id="flux">Flux</h3>
<p>After installing the IDE extension to VS Code / Codium open a Flux file, for example <a href="https://gitlab.com/oersi/oersi-etl/-/blob/master/data/production/digill/digill-to-oersi.flux">this one</a>. It should look like this:</p>
<p><img src="./img/digill-to-oersi_flux.JPG" alt="Flux editor" style="max-width:100%"/></p>
<p>If you delete for example a necessary bracket you will see in the Problems section that the extension detects problems with the Flux file:</p>
<p><img src="./img/digill-to-oersi_flux_problem.JPG" alt="Flux editor with problems" style="max-width:100%"/></p>
<h3 id="fix">Fix</h3>
<p>After installing the IDE extension to VS Code / Codium open a Flux file, for example <a href="https://gitlab.com/oersi/oersi-etl/-/blob/master/data/production/digill/digill.fix">this one</a>. It should look like this:</p>
<p><img src="./img/digill_fix.JPG" alt="Fix editor" style="max-width:100%"/></p>
<p>If you remove a closing <code>end</code> you will see in the Problems section that the extension detects the missing <code>end</code>:</p>
<p><img src="./img/digill_fix_problem.JPG" alt="Fix editor with problems" style="max-width:100%"/></p>
<h2 id="github">GitHub</h2>
<p>To report issues, see the code, and contribute to the projects, visit: <a href="https://github.com/metafacture/metafacture-fix">Fix Repository</a>, <a href="https://github.com/metafacture/metafacture-flux">Flux Repository</a>.</p>
</body>
</html>