From 845b490871cac5a879aeac26ec6f5d11e58fcd57 Mon Sep 17 00:00:00 2001 From: gnikit Date: Fri, 10 May 2024 13:04:57 +0100 Subject: [PATCH 01/10] chore: moved future plans after installation and setup instructions --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index a5af329d..94a26db0 100644 --- a/README.md +++ b/README.md @@ -65,23 +65,6 @@ and [Emacs](https://fortls.fortran-lang.org/editor_integration.html#emacs). - Signature help and hover does not handle elegantly overloaded functions i.e. interfaces -## Future plans - -`fortls` has reached a point where it is feature complete and stable enough to be used in many modern Fortran projects without any issues. -It does however still have fundamental limitations, -namely its ability to understand all Fortran syntax and semantics that has been used throughout the 65+ years of the language. **The good news is that we have a plan to address this issue!** - -We are excited to announce that we are working on creating a new Fortran Language Server -based on the actively developed [LFortran](https://lfortran.org/) compiler 🎉. -The new Language Server will be able to understand all Fortran syntax, be faster, -and give more accurate autocompletion, hover and diagnostic information. That means we plan on investing any future funding on creating our new language server and ultimately creating a better user experience for everyone. - - - -### What about `fortls`? - -Not to worry, `fortls` will continue to be here. We will keep `fortls` in maintenance mode with bug fixes and new features from volunteer contributors, but otherwise we will be focusing our efforts into making the new LFortran language server a reality. - ## Installation ### PyPi @@ -162,6 +145,23 @@ An example for a Configuration file is given below | `textDocument/didChange` | Document synchronisation upon changes to the document | | `textDocument/codeAction` | **Experimental** Generate code | +## Future plans + +`fortls` has reached a point where it is feature complete and stable enough to be used in many modern Fortran projects without any issues. +It does however still have fundamental limitations, +namely its ability to understand all Fortran syntax and semantics that has been used throughout the 65+ years of the language. **The good news is that we have a plan to address this issue!** + +We are excited to announce that we are working on creating a new Fortran Language Server +based on the actively developed [LFortran](https://lfortran.org/) compiler 🎉. +The new Language Server will be able to understand all Fortran syntax, be faster, +and give more accurate autocompletion, hover and diagnostic information. That means we plan on investing any future funding on creating our new language server and ultimately creating a better user experience for everyone. + + + +### What about `fortls`? + +Not to worry, `fortls` will continue to be here. We will keep `fortls` in maintenance mode with bug fixes and new features from volunteer contributors, but otherwise we will be focusing our efforts into making the new LFortran language server a reality. + ## `fortls` vs `fortran-language-server` This project was originally based on `fortran-language-server` LSP implementation, but the two projects have since diverged. From a89c389050132a96d2aca42bdf4f82e2d0b5a86e Mon Sep 17 00:00:00 2001 From: gnikit Date: Fri, 10 May 2024 13:09:59 +0100 Subject: [PATCH 02/10] chore: added explicit docs section and link --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 94a26db0..f9b1030f 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,11 @@ and [Emacs](https://fortls.fortran-lang.org/editor_integration.html#emacs). - Signature help and hover does not handle elegantly overloaded functions i.e. interfaces +## Documentation + +The full documentation for `fortls` can be found at +[fortls.fortran-lang.org](https://fortls.fortran-lang.org/). + ## Installation ### PyPi From 99de3bda9b0eb875d14b55c92d2f4c9f39d49256 Mon Sep 17 00:00:00 2001 From: gnikit Date: Fri, 10 May 2024 13:13:15 +0100 Subject: [PATCH 03/10] chore: added active to indicate non-archive mode --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f9b1030f..faa0971a 100644 --- a/README.md +++ b/README.md @@ -165,7 +165,7 @@ and give more accurate autocompletion, hover and diagnostic information. That me ### What about `fortls`? -Not to worry, `fortls` will continue to be here. We will keep `fortls` in maintenance mode with bug fixes and new features from volunteer contributors, but otherwise we will be focusing our efforts into making the new LFortran language server a reality. +Not to worry, `fortls` will continue to be here. We will keep `fortls` in active maintenance mode with bug fixes and new features from volunteer contributors, but otherwise we will be focusing our efforts into making the new language server using LFortran's parser a reality. ## `fortls` vs `fortran-language-server` From 7c836de18ac451a10661cf76990af72bcfcf7dd4 Mon Sep 17 00:00:00 2001 From: gnikit Date: Fri, 10 May 2024 13:17:18 +0100 Subject: [PATCH 04/10] ci: remove deprecated action in favour of explicit compilation --- .github/workflows/docs.yml | 9 ++++++--- .github/workflows/docs_preview.yml | 9 ++++++--- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 94fddb5d..79522ab4 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -6,10 +6,13 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: sphinx-toolbox/sphinx-action@master + - uses: actions/setup-python@v5 with: - pre-build-command: "pip install .[docs]" - docs-folder: "docs/" + python-version: "3.11" + - name: Build docs + run: | + pip install .[docs] + make -C docs html - name: Deploy uses: peaceiris/actions-gh-pages@v4 if: github.ref == 'refs/heads/master' diff --git a/.github/workflows/docs_preview.yml b/.github/workflows/docs_preview.yml index 1ce4c77b..5bfc3362 100644 --- a/.github/workflows/docs_preview.yml +++ b/.github/workflows/docs_preview.yml @@ -23,10 +23,13 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: sphinx-toolbox/sphinx-action@master + - uses: actions/setup-python@v5 with: - pre-build-command: "pip install .[docs]" - docs-folder: "docs/" + python-version: "3.11" + - name: Build docs + run: | + pip install .[docs] + make -C docs html - name: Deploy Preview uses: rossjrw/pr-preview-action@v1.4.7 with: From d837c97cf14ae81823ec6dcc9b97d76e8b262a82 Mon Sep 17 00:00:00 2001 From: gnikit Date: Fri, 10 May 2024 13:24:15 +0100 Subject: [PATCH 05/10] docs: financial contributing instructinos --- docs/contributing.rst | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index d16c56df..91e4a254 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -7,16 +7,11 @@ There are a few ways you can support the ``fortls`` project. Financial Support ------------------ -.. You can support us financially by becoming a **GitHub Sponsor** or by -.. making a **PayPal Donation**. +You can fiscally support Fortran-lang by donating to the project, see +`Fortran-lang - NumFOCUS`_. -.. note:: - We are in the process of restructuring our Sponsorship structure. - In the meantime, please get in contact with ``gnikit`` via email at - ``gnikit [@] duck [.] com`` or any other `Administrator of Fortran-lang`_ - for instructions to financially back the project. +.. _Fortran-lang - NumFOCUS: https://numfocus.org/donate-for-fortran-lang -.. _Administrator of Fortran-lang: https://github.com/orgs/fortran-lang/teams/admins/members .. .. grid:: 2 .. :gutter: 0 From 6f765398876e7bd7ab30d8c68a024f7b7d4a0e8b Mon Sep 17 00:00:00 2001 From: gnikit Date: Fri, 10 May 2024 13:29:06 +0100 Subject: [PATCH 06/10] docs: updated Support section --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index faa0971a..2788b662 100644 --- a/README.md +++ b/README.md @@ -186,12 +186,10 @@ change in the future. This project would not have been possible without the original work of [@hansec](https://github.com/hansec/) in [`fortran-language-server`](https://github.com/hansec/fortran-language-server) - +You can support Fortran-lang as a whole by donating at +[Fortran-lang - NumFOCUS](https://numfocus.org/donate-for-fortran-lang). ## Bug reports From 53eae5c2e719b72163c1d08a3dba8a310be068b6 Mon Sep 17 00:00:00 2001 From: gnikit Date: Fri, 10 May 2024 13:56:21 +0100 Subject: [PATCH 07/10] docs: added Zenodo rolling release badge --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 2788b662..75e4514a 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ ![Codecov](https://img.shields.io/codecov/c/github/fortran-lang/fortls?style=flat-square) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black) ![GitHub Repo stars](https://img.shields.io/github/stars/fortran-lang/fortls?color=yellow&style=flat-square) +[![DOI](https://zenodo.org/badge/412392321.svg?style=flat-square)](https://zenodo.org/badge/latestdoi/412392321) From d353e01f855bcda8ab1ca6e7f3477eb952db974c Mon Sep 17 00:00:00 2001 From: gnikit Date: Fri, 10 May 2024 14:04:09 +0100 Subject: [PATCH 08/10] ci: fix installation --- .github/workflows/docs.yml | 2 +- .github/workflows/docs_preview.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 79522ab4..7c68730f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -11,7 +11,7 @@ jobs: python-version: "3.11" - name: Build docs run: | - pip install .[docs] + pip install -e .[dev,docs] make -C docs html - name: Deploy uses: peaceiris/actions-gh-pages@v4 diff --git a/.github/workflows/docs_preview.yml b/.github/workflows/docs_preview.yml index 5bfc3362..7bdac0ee 100644 --- a/.github/workflows/docs_preview.yml +++ b/.github/workflows/docs_preview.yml @@ -28,7 +28,7 @@ jobs: python-version: "3.11" - name: Build docs run: | - pip install .[docs] + pip install -e .[dev,docs] make -C docs html - name: Deploy Preview uses: rossjrw/pr-preview-action@v1.4.7 From 46fe37e1eb1260ffcc89defce81183e1fb372aee Mon Sep 17 00:00:00 2001 From: gnikit Date: Fri, 10 May 2024 14:15:16 +0100 Subject: [PATCH 09/10] ci: provide custom-url for preview deployments --- .github/workflows/docs_preview.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs_preview.yml b/.github/workflows/docs_preview.yml index 7bdac0ee..9a0d99e6 100644 --- a/.github/workflows/docs_preview.yml +++ b/.github/workflows/docs_preview.yml @@ -35,3 +35,4 @@ jobs: with: source-dir: docs/_build/html preview-branch: gh-pages + custom-url: https://fortls.fortran-lang.org From 882f0206634fab3813136ab454ebb22a6c378107 Mon Sep 17 00:00:00 2001 From: gnikit Date: Fri, 10 May 2024 14:18:57 +0100 Subject: [PATCH 10/10] ci: remove https --- .github/workflows/docs_preview.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs_preview.yml b/.github/workflows/docs_preview.yml index 9a0d99e6..c15e8248 100644 --- a/.github/workflows/docs_preview.yml +++ b/.github/workflows/docs_preview.yml @@ -35,4 +35,4 @@ jobs: with: source-dir: docs/_build/html preview-branch: gh-pages - custom-url: https://fortls.fortran-lang.org + custom-url: fortls.fortran-lang.org