diff --git a/.github/dependabot b/.github/dependabot deleted file mode 100644 index ee14e9d..0000000 --- a/.github/dependabot +++ /dev/null @@ -1,11 +0,0 @@ -version: 2 -updates: - - package-ecosystem: npm - directory: / - schedule: - interval: monthly - - - package-ecosystem: github-actions - directory: / - schedule: - interval: monthly diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..8724b09 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,37 @@ +version: 2 +updates: + - package-ecosystem: npm + directory: / + schedule: + interval: monthly + groups: + npm-root: + patterns: + - "*" + + - package-ecosystem: npm + directory: /client + schedule: + interval: monthly + groups: + npm-client: + patterns: + - "*" + + - package-ecosystem: npm + directory: /server + schedule: + interval: monthly + groups: + npm-server: + patterns: + - "*" + + - package-ecosystem: github-actions + directory: / + schedule: + interval: monthly + groups: + github-actions: + patterns: + - "*" diff --git a/README.md b/README.md index 3e8519c..8c13fac 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Modelica Language Server -[![Build](https://github.com/OpenModelica/modelica-language-server/actions/workflows/test.yml/badge.svg)](https://github.com/OpenModelica/modelica-language-server/actions/workflows/test.yml) +[![Build][badge-build]][workflow-test] A very early version of a Modelica Language Server based on -[OpenModelica/tree-sitter-modelica](https://github.com/OpenModelica/tree-sitter-modelica). +[OpenModelica/tree-sitter-modelica][tree-sitter-modelica]. For syntax highlighting install enxtension -[AnHeuermann.metamodelica](https://marketplace.visualstudio.com/items?itemName=AnHeuermann.metamodelica) +[AnHeuermann.metamodelica][ext-metamodelica] in addition. ## Functionality @@ -26,18 +26,18 @@ features: ### Via Marketplace - - [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=OpenModelica.modelica-language-server) - - [Open VSX Registry](https://open-vsx.org/extension/OpenModelica/modelica-language-server) + - [Visual Studio Marketplace][marketplace] + - [Open VSX Registry][open-vsx] ### Via VSIX File Download the latest -[modelica-language-server-0.2.0.vsix](https://github.com/OpenModelica/modelica-language-server/releases/download/v0.2.0/modelica-language-server-0.2.0.vsix) +[modelica-language-server-0.2.0.vsix][vsix-download] from the -[releases](https://github.com/OpenModelica/modelica-language-server/releases) +[releases][releases] page. -Check the [VS Code documentation](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) +Check the [VS Code documentation][vscode-install-vsix] on how to install a .vsix file. Use the `Install from VSIX` command or run @@ -54,14 +54,14 @@ language server. If you are searching for a good point to start check the -[good first issue](https://github.com/OpenModelica/modelica-language-server/labels/good%20first%20issue). +[good first issue][good-first-issue]. To see where the development is heading to check the -[Projects section](https://github.com/OpenModelica/modelica-language-server/projects?query=is%3Aopen). +[Projects section][projects]. If you need more information start a discussion over at -[OpenModelica/OpenModelica](https://github.com/OpenModelica/OpenModelica). +[OpenModelica/OpenModelica][openmodelica]. Found a bug or having issues? Open a -[new issue](https://github.com/OpenModelica/modelica-language-server/issues/new/choose). +[new issue][new-issue]. ## Structure @@ -83,12 +83,11 @@ Found a bug or having issues? Open a necessary npm modules in both the client and server folder - Open VS Code on this folder. - Press Ctrl+Shift+B to start compiling the client and server in [watch - mode](https://code.visualstudio.com/docs/editor/tasks#:~:text=The%20first%20entry%20executes,the%20HelloWorld.js%20file.). + mode][vscode-watch-mode]. - Switch to the Run and Debug View in the Sidebar (Ctrl+Shift+D). - Select `Launch Client` from the drop down (if it is not already). - Press ▷ to run the launch config (F5). - - In the [Extension Development - Host](https://code.visualstudio.com/api/get-started/your-first-extension#:~:text=Then%2C%20inside%20the%20editor%2C%20press%20F5.%20This%20will%20compile%20and%20run%20the%20extension%20in%20a%20new%20Extension%20Development%20Host%20window.) + - In the [Extension Development Host][ext-dev-host] instance of VSCode, open a document in 'modelica' language mode. - Check the console output of `Language Server Modelica` to see the parsed tree of the opened file. @@ -107,14 +106,14 @@ modelica-language-server is licensed under the OSMC Public License v1.8, see ### 3rd Party Licenses This extension is based on -[https://github.com/microsoft/vscode-extension-samples/tree/main/lsp-sample](https://github.com/microsoft/vscode-extension-samples/tree/main/lsp-sample), +[https://github.com/microsoft/vscode-extension-samples/tree/main/lsp-sample][lsp-sample], licensed under MIT license. Some parts of the source code are taken from -[bash-lsp/bash-language-server](https://github.com/bash-lsp/bash-language-server), +[bash-lsp/bash-language-server][bash-language-server], licensed under the MIT license and adapted to the Modelica language server. -[OpenModelica/tree-sitter-modelica](https://github.com/OpenModelica/tree-sitter-modelica) +[OpenModelica/tree-sitter-modelica][tree-sitter-modelica] v0.2.0 is included in this extension and is licensed under the [OSMC-PL v1.8](./server/OSMC-License.txt). @@ -122,3 +121,21 @@ v1.8](./server/OSMC-License.txt). This package was initially developed by [Hochschule Bielefeld - University of Applied Sciences and Arts](hsbi.de). + +[badge-build]: https://github.com/OpenModelica/modelica-language-server/actions/workflows/test.yml/badge.svg +[bash-language-server]: https://github.com/bash-lsp/bash-language-server +[ext-dev-host]: https://code.visualstudio.com/api/get-started/your-first-extension#:~:text=Then%2C%20inside%20the%20editor%2C%20press%20F5.%20This%20will%20compile%20and%20run%20the%20extension%20in%20a%20new%20Extension%20Development%20Host%20window. +[ext-metamodelica]: https://marketplace.visualstudio.com/items?itemName=AnHeuermann.metamodelica +[good-first-issue]: https://github.com/OpenModelica/modelica-language-server/labels/good%20first%20issue +[lsp-sample]: https://github.com/microsoft/vscode-extension-samples/tree/main/lsp-sample +[marketplace]: https://marketplace.visualstudio.com/items?itemName=OpenModelica.modelica-language-server +[new-issue]: https://github.com/OpenModelica/modelica-language-server/issues/new/choose +[open-vsx]: https://open-vsx.org/extension/OpenModelica/modelica-language-server +[openmodelica]: https://github.com/OpenModelica/OpenModelica +[projects]: https://github.com/OpenModelica/modelica-language-server/projects?query=is%3Aopen +[releases]: https://github.com/OpenModelica/modelica-language-server/releases +[tree-sitter-modelica]: https://github.com/OpenModelica/tree-sitter-modelica +[vscode-install-vsix]: https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix +[vscode-watch-mode]: https://code.visualstudio.com/docs/editor/tasks#:~:text=The%20first%20entry%20executes,the%20HelloWorld.js%20file. +[vsix-download]: https://github.com/OpenModelica/modelica-language-server/releases/download/v0.2.0/modelica-language-server-0.2.0.vsix +[workflow-test]: https://github.com/OpenModelica/modelica-language-server/actions/workflows/test.yml