VSCode - Revision history

Jrwrigh at 17:15, 18 September 2022

2022-09-18T17:15:38Z

Jrwrigh at 16:09, 12 February 2020

2020-02-12T16:09:48Z

Jrwrigh: Add asterisk for pseudo footnote

2019-12-18T21:20:40Z

Add asterisk for pseudo footnote

Jrwrigh: Add fortran and general access information

2019-12-18T21:19:43Z

Add fortran and general access information

New page

This goes over usage of VSCode on the viz nodes.

== Accessing VSCode in VNC ==
To access VSCode, you first need to add it via <code>soft add +vscode</code>. Then to run VSCode, simply run <code>code</code> in your terminal.

== Fortran Language Server setup ==

Language servers are programs based on the open-source [https://microsoft.github.io/language-server-protocol/ Language Server Protocol] that intelligently parses code (including seperate files in the same code base). This allows a user to see the definition of another function, rename a variable across multiple instances/files, and see associated inline documentation.

=== Setting Up ===

====== Install <code>fortls</code> ======

The [https://github.com/hansec/fortran-language-server fortran-language-server] is implemented in Python, so it can be installed simply using <code>pip3</code> (note that <code>pip</code> is not available on the viz nodes for whatever reason). This must be installed locally, so we must use the <code>--user</code> flag.

<nowiki>
$ pip3 install -U setuptools
$ pip3 install --user fortran-language-server </nowiki>

This will place the <code>fortls</code> executable into <code>~/.local/bin</code>. So this must be added to your path.

====== Add <code>.local/bin</code> to <code>$PATH</code> ======

Add <code>export PATH=$PATH:$HOME/.local/bin</code> to your <code>.bashrc</code> file. This will ensure that VSCode can access the <code>fortls</code> executable.

====== Add extensions to VSCode ======

To leverage the language server in VSCode, you need to install extensions that will call it. These are [https://marketplace.visualstudio.com/items?itemName=hansec.fortran-ls FORTRAN Intellisense] and [https://marketplace.visualstudio.com/items?itemName=krvajalm.linter-gfortran Modern Fortran]. Note that ''both'' of these extensions must be installed to work correctly. Also note that you may also use the [https://marketplace.visualstudio.com/items?itemName=Gimly81.fortran fortran] extension instead of Modern Fortran.

Note that for <code>fortls</code> to use inline documentation settings, the inline documentation must be in either Doxygen format or FORD. See [https://github.com/hansec/fortran-language-server#language-server-features Document Parsing here].

← Older revision		Revision as of 17:15, 18 September 2022
Line 1:		Line 1:
−	~~[[Category:Software]]~~
−
	This goes over usage of VSCode on the viz nodes.		This goes over usage of VSCode on the viz nodes.

Line 35:		Line 33:

	\*Note that for <code>fortls</code> to use inline documentation settings, the inline documentation must be in either Doxygen format or FORD. See [https://github.com/hansec/fortran-language-server#language-server-features Document Parsing here].		\*Note that for <code>fortls</code> to use inline documentation settings, the inline documentation must be in either Doxygen format or FORD. See [https://github.com/hansec/fortran-language-server#language-server-features Document Parsing here].
		+
		+	[[Category:Software]]

← Older revision		Revision as of 16:09, 12 February 2020
Line 1:		Line 1:
		+	[[Category:Software]]
		+
	This goes over usage of VSCode on the viz nodes.		This goes over usage of VSCode on the viz nodes.

@@ Line 7: / Line 7: @@
 == Fortran Language Server setup ==
-Language servers are programs based on the open-source [https://microsoft.github.io/language-server-protocol/ Language Server Protocol] that intelligently parses code (including seperate files in the same code base). This allows a user to see the definition of another function, rename a variable across multiple instances/files, and see associated inline documentation.
+Language servers are programs based on the open-source [https://microsoft.github.io/language-server-protocol/ Language Server Protocol] that intelligently parses code (including seperate files in the same code base). This allows a user to see the definition of another function, rename a variable across multiple instances/files, and see associated inline documentation*.
 === Setting Up ===
@@ Line 32: / Line 32: @@
-Note that for <code>fortls</code> to use inline documentation settings, the inline documentation must be in either Doxygen format or FORD. See [https://github.com/hansec/fortran-language-server#language-server-features Document Parsing here].
+\*Note that for <code>fortls</code> to use inline documentation settings, the inline documentation must be in either Doxygen format or FORD. See [https://github.com/hansec/fortran-language-server#language-server-features Document Parsing here].