Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fortran-lang/vscode-fortran-support
Fortran language support for Visual Studio Code
https://github.com/fortran-lang/vscode-fortran-support
debugger formatting fortls fortran language-server-client linter snippets syntax-highlighter vscode-extension
Last synced: 10 days ago
JSON representation
Fortran language support for Visual Studio Code
- Host: GitHub
- URL: https://github.com/fortran-lang/vscode-fortran-support
- Owner: fortran-lang
- License: mit
- Created: 2017-05-27T14:08:50.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T01:26:11.000Z (6 months ago)
- Last Synced: 2024-05-01T16:52:10.751Z (6 months ago)
- Topics: debugger, formatting, fortls, fortran, language-server-client, linter, snippets, syntax-highlighter, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=fortran-lang.linter-gfortran
- Size: 65.3 MB
- Stars: 186
- Watchers: 8
- Forks: 30
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
## Key Features
- Syntax highlighting (Free and Fixed forms)
- Hover support, Signature help and Auto-completion
- GoTo/Peek implementation and Find/Peek references
- Project-wide and Document symbol detection and Renaming
- [Native Language Server integration](#language-server-integration) with [`fortls`](https://fortls.fortran-lang.org)
- [Linting support](#linting): GNU's [`gfortran`](https://gcc.gnu.org/wiki/GFortran), Intel's [`ifort`](https://www.intel.com/content/www/us/en/developer/tools/oneapi/fortran-compiler.html), `ifx`, NAG's [`nagfor`](https://www.nag.co.uk/nagfor/)
- [Interactive Debugger with UI](#debugging)
- [Formatting](#formatting) with [findent](https://github.com/gnikit/findent-pypi) or [fprettify](https://github.com/pseewald/fprettify)
- [Code snippets](#snippets) (more can be defined by the user [see](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_create-your-own-snippets))
## Get Started & Seek Support
### Useful Tools
## Language Server integration
The Fortran Language Server [`fortls`](https://fortls.fortran-lang.org) is responsible
for providing a lot of the higher level, IDE functionality. By default,
`Modern Fortran` will attempt to use it for hover, autocompletion, symbols and Go to & Peeking into definitions.
Allow for `fortls` to be automatically installed with `pip` or `Anaconda` and
if the location where `fortls` is installed is not in your `PATH` point VS Code
to the `fortls` location by setting
```json
{
"fortran.fortls.path": "/custom/path/to/fortls"
}
```
For more about the Language Server's capabilities please refer to the
[documentation](https://fortls.fortran-lang.org/) of `fortls`.
## Linting
Linting allows for compiler error and warning detection while coding
without the user having to compile.
| Vendor | Compiler |
| --------------------------------------------------------------------------------------------- | -------------- |
| [GNU](https://gcc.gnu.org/wiki/GFortran) | `gfortran` |
| [Intel](https://www.intel.com/content/www/us/en/developer/tools/oneapi/fortran-compiler.html) | `ifort`, `ifx` |
| [NAG](https://www.nag.com/) | `nagfor` |
Using an invalid if expression
Using incorrect type and rank as function argument
| 📝️ Note | Save your file to generate linting results |
| -------- | ------------------------------------------ |
Linting results can be improved by providing additional options to the compiler.
### Including directories
You can control the include paths to be used by the linter with the `fortran.linter.includePaths` option.
| ❗️ Important | For the best linting results `linter.includePaths` should match the included paths for your project's compilation. |
| ------------ | ------------------------------------------------------------------------------------------------------------------ |
```json
{
"fortran.linter.includePaths": ["/usr/include/**", "${workspaceFolder}/include/**"]
}
```
| ❗️ Important | If a glob pattern is used only directories matching the pattern will be included |
| ------------ | -------------------------------------------------------------------------------- |
### Additional linting options
More options can be passed to the linter via
```json
{
"fortran.linter.extraArgs": [
"-fdefault-real-8",
"-fdefault-double-8",
"-Wunused-variable",
"-Wunused-dummy-argument"
]
}
```
Default value is `-Wall` (or `-warn all` for ifort).
### Changing linting compiler
By default, the linter used is `gfortran`, Intel's `ifort` and Intel's LLVM based compiler `ifx` are also supported.
One can use a different linter compiler via the option
```jsonc
{
"fortran.linter.compiler": "ifort" | "gfortran" | "ifx" | "Disabled"
}
```
The linter executable is assumed to be found in the `PATH`.
In order to use a different executable or if the executable can't be found in the `PATH`
you can point the extension to another linter with the `fortran.linter.compilerPath` option.
```json
{
"fortran.linter.compilerPath": "/opt/oneapi/compiler/2022.0.2/linux/bin/intel64/ifort"
}
```
## Debugging
The extension uses the debugger from Microsoft's
[C/C++ extension](https://github.com/Microsoft/vscode-cpptools)
for Visual Studio Code. This allows this extension to use the full functionality
of the C/C++ extension for debugging applications:
(un)conditional breaking points, expression evaluation, multithreaded debugging,
call stack, stepping, watch window.
A minimal `launch.json` script, responsible for controlling the debugger, is
provided below. However, Visual Studio Code is also capable of autogenerating
a `launch.json` file and the configurations inside the file.
More details about how to set up the debugger can be found in Microsoft's website:
- General information about debugging in VS Code:
- C/C++ extension debugger information:
- Build tasks for easy compiling:
Example: Launch.json
```jsonc
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "(gdb) Fortran",
"type": "cppdbg",
"request": "launch",
"program": "${workspaceFolder}/a.out",
"args": [], // Possible input args for a.out
"stopAtEntry": false,
"cwd": "${workspaceFolder}",
"environment": [],
"externalConsole": false,
"MIMode": "gdb",
"setupCommands": [
{
"description": "Enable pretty-printing for gdb",
"text": "-enable-pretty-printing",
"ignoreFailures": true,
},
],
},
],
}
```
## Formatting
Two formatters are supported [`findent`](https://github.com/gnikit/findent-pypi)
and [`fprettify`](https://github.com/pseewald/fprettify). Both of them can be
installed with `pip` automatically through the extension.
Demo: formatters in action
| findent | fprettify |
| :-----------------------------------: | :-------------------------------------: |
|  |  |
The formatter is controlled by the user option
```jsonc
{
"fortran.formatting.formatter": "findent" | "fprettify" | "Disabled"
}
```
Additional arguments to the formatter can be input using
```json
{
"fortran.formatting.findentArgs": ["-Cn", "-Rr"],
"fortran.formatting.fprettifyArgs": ["--whitespace-comma", "--enable-decl"]
}
```
To check all available arguments to formatters try `findent -h` or `fprettify -h`
in a terminal.
If the formatter is not present in the `PATH` its location can be input with
```json
{
"fortran.formatting.path": "./custom/path/venv/bin"
}
```
| 📝️ Note | `findent` can also be used to generate dependency files for a project. |
| -------- | ---------------------------------------------------------------------- |
## Fortran Package Manager
### Validation of `fpm.toml`
Autocompletion and options validation for `fpm.toml` files are provided by the
**installing the [Even Better TOML](https://marketplace.visualstudio.com/items?itemName=tamasfe.even-better-toml) Visual Studio Code extension**.
## Snippets
Snippets are included by both `fortls` Language Server and the Modern Fortran VS Code extension.
Some available snippets can be seen below. Users can define their own snippets
by following these VS Code [instructions](https://code.visualstudio.com/docs/editor/userdefinedsnippets).
If you think a snippet should be shipped by with the extension feel free to
submit a [feature request](https://github.com/fortran-lang/vscode-fortran-support/issues/new?assignees=&labels=feature-request&template=feature_request.md&title=)
Demo: snippets in action
## Advanced options
To show the symbols in the file outline enable `provide.symbols`. Symbols can be
served by the fortls, the built-in, both or none. By default
`fortls` is used.
```jsonc
{
"fortran.provide.symbols": "fortls" | "Built-in" | "Both" | "Disable"
}
```
You can also configure the case for fortran intrinsics auto-complete by using
```jsonc
{
"fortran.preferredCase": "lowercase" | "uppercase"
}
```
## Requirements
For debugging you need to have one of the following debuggers installed:
- **Linux**: GDB
- **macOS**: GDB or LLDB
- **Windows**: GDB or Visual Studio Windows Debugger
## Contributing
- [Guidelines](https://github.com/fortran-lang/vscode-fortran-support/blob/master/CONTRIBUTING.md)
- [Code of conduct: Contributor Covenant](https://github.com/fortran-lang/.github/blob/main/CODE_OF_CONDUCT.md)
- [License](https://github.com/fortran-lang/vscode-fortran-support/blob/master/LICENSE)
## Support Us
You can support further development of the extension by fiscal donations:
to our [**LFortan**](https://numfocus.org/donate-to-lfortran) project on NumFOCUS
Or
directly sponsoring developers through [**GitHub Sponsors**](https://github.com/fortran-lang/vscode-fortran-support)