Skip to content

Makes note, warnings onliners #510

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).

### Changed

- Changed images from SVG to PNG because `vsce` does not support SVG
([#510](https://github.com/fortran-lang/vscode-fortran-support/pull/510))
- Changed need for matching begin-end scope names, in the following constructs:
Functions, Modules, Programs, Module Procedures, Subroutines, Submodules.
For a more detailed explanation as to why see the issue
Expand Down
67 changes: 38 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="assets/modern-fortran-logo.svg" width=800/>
<img src="assets/png/modern-fortran-logo.png" width=800/>
</p>

<div align="center">
Expand All @@ -12,8 +12,21 @@

</div>

<div align="center">
<a href="#key-features">Key Features</a> •
<a href="#get-started--seek-support">Get Started</a> •
<a href="#language-server-integration">LSP</a> •
<a href="#linting">Lint</a> •
<a href="#debugging">Debug</a> •
<a href="#formatting">Format</a> •
<a href="#snippets">Snippets</a> •
<a href="#support-us">Donate</a>
<br>
<br>
</div>

<p align="center">
<img src="assets/intro-demo.gif"/>
<img src="assets/gif/intro-demo.gif"/>
</p>

## Key Features
Expand All @@ -30,18 +43,18 @@

## Get Started & Seek Support

<p float="left">
<a href="https://fortran-lang.org/learn/"><img src="./assets/readme.tutorial.svg"/></a>
<a href="https://github.com/fortran-lang/vscode-fortran-support/discussions"><img src="./assets/readme.github.svg"/></a>
<a href="https://fortran-lang.discourse.group/"><img src="./assets/readme.discourse.svg"/></a>
<p float="center">
<a href="https://fortran-lang.org/learn/"><img src="assets/png/readme.tutorial.png"/></a>
<a href="https://github.com/fortran-lang/vscode-fortran-support/discussions"><img src="assets/png/readme.github.png"/></a>
<a href="https://fortran-lang.discourse.group/"><img src="assets/png/readme.discourse.png"/></a>
</p>

### Useful Tools

<p float="center">
<a href="https://gnikit.github.io/fortls"><img src="./assets/readme.fortls.svg"/></a>
<a href="https://fpm.fortran-lang.org"><img src="./assets/readme.fpm.svg"/></a>
<a href="https://github.com/fortran-lang/stdlib"><img src="./assets/readme.stdlib.svg"/></a>
<a href="https://gnikit.github.io/fortls"><img src="assets/png/readme.fortls.png"/></a>
<a href="https://fpm.fortran-lang.org"><img src="assets/png/readme.fpm.png"/></a>
<a href="https://github.com/fortran-lang/stdlib"><img src="assets/png/readme.stdlib.png"/></a>
</p>

## Language Server integration
Expand Down Expand Up @@ -70,35 +83,32 @@ without the user having to compile.

Using an invalid if expression

![alt](assets/lint-demo.gif)
![alt](assets/gif/lint-demo.gif)

Using incorrect type and rank as function argument

![alt](assets/lint-demo2.gif)
![alt](assets/gif/lint-demo2.gif)

| 📝️ Note |
| ------------------------------------------ |
| Save your file to generate linting results |
| 📝️ 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. |
| ❗️ 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 |
| ❗️ Important | If a glob pattern is used only directories matching the pattern will be included |
| ------------- | -------------------------------------------------------------------------------- |

### Additional linting options

Expand Down Expand Up @@ -140,7 +150,7 @@ you can point the extension to another linter with the `fortran.linter.compilerP

## Debugging

![alt](assets/gdb_ani.gif)
![alt](assets/gif/gdb_ani.gif)

The extension uses the debugger from Microsoft's
[C/C++ extension](https://github.com/Microsoft/vscode-cpptools)
Expand Down Expand Up @@ -203,9 +213,9 @@ installed with `pip` automatically through the extension.
<details>
<summary><b>Demo: formatters in action</b></summary>

| findent | fprettify |
| :-------------------------------: | :---------------------------------: |
| ![alt](./assets/findent-demo.gif) | ![alt](./assets/fprettify-demo.gif) |
| findent | fprettify |
| :-----------------------------------: | :-------------------------------------: |
| ![alt](./assets/gif/findent-demo.gif) | ![alt](./assets/gif/fprettify-demo.gif) |

</details>

Expand Down Expand Up @@ -234,9 +244,8 @@ If the formatter is not present in the `PATH` its location can be input with
}
```

| :memo: Note |
| ---------------------------------------------------------------------- |
| `findent` can also be used to generate dependency files for a project. |
| 📝️ Note | `findent` can also be used to generate dependency files for a project. |
| -------- | ---------------------------------------------------------------------- |

## Snippets

Expand Down Expand Up @@ -293,8 +302,8 @@ For debugging you need to have one of the following debuggers installed:

You can support further development of the extension by fiscal donations:

<a href="https://numfocus.org/donate-to-lfortran"><img src="./assets/readme.lfortran.svg" width=90></a> to our [**LFortan**](https://numfocus.org/donate-to-lfortran) project on NumFOCUS
<a href="https://numfocus.org/donate-to-lfortran"><img src="./assets/png/readme.lfortran.png"></a> to our [**LFortan**](https://numfocus.org/donate-to-lfortran) project on NumFOCUS

Or

<a href="https://github.com/fortran-lang/vscode-fortran-support"><img src="./assets/readme.github.sponsor.svg" width=120></a> directly sponsoring developers through [**GitHub Sponsors**](https://github.com/fortran-lang/vscode-fortran-support)
<a href="https://github.com/fortran-lang/vscode-fortran-support"><img src="./assets/png/readme.github.sponsor.png"></a> directly sponsoring developers through [**GitHub Sponsors**](https://github.com/fortran-lang/vscode-fortran-support)
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added assets/png/modern-fortran-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/png/readme.discourse.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/png/readme.fortls.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/png/readme.fpm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/png/readme.github.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/png/readme.github.sponsor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/png/readme.lfortran.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/png/readme.stdlib.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/png/readme.tutorial.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
56 changes: 0 additions & 56 deletions assets/readme.github.sponsor.svg

This file was deleted.

File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
60 changes: 60 additions & 0 deletions assets/svg/readme.github.sponsor.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Loading