diff --git a/README.md b/README.md index 89b119c13..4c6db2b07 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,13 @@ ## VSCode Extension The VSCode extension is bundled in a VSIX file, and makes use of the -LSP server `superbol-fee`. The latter is an executable that needs to -be available to use the extension. +LSP server `superbol-free`. The latter is an executable file that +needs to be downloaded separately and made available on the system to +use the extension. ### Downloading binary releases -You can download both the `superbol-fee` executable and the VSIX file +You can download both the `superbol-free` executable and the VSIX file from the releases page[^releases]. Save the former in a directory that is already in the `PATH` so the extension works out of the box. @@ -34,13 +35,12 @@ that is already in the `PATH` so the extension works out of the box. ### Adding the extension to VSCode -Open VSCode and open the extensions view. +To install the extension from its VSIX file, open VSCode and go to the +the "`Extensions`" view. In the sidebar, click on the three dots (`⋅⋅⋅`) on the top right-hand -side (just above "`search`"). - -Select "`Install from VSIX…`" and pick -`superbol-vscode-platform.vsix`. +side (just above "`search`"), select "`Install from VSIX…`". Pick the +`superbol-vscode-platform.vsix` file to install it. ### Configuring the extension @@ -48,13 +48,9 @@ If you have installed the `superbol-free` executable in a directory that is already in `PATH`, then you have nothing to do, the extension will work out of the box. -Otherwise get the path to the `superbol` executable and copy it. - -Go to your VSCode settings and in the extension submenu select -`Superbol COBOL`. - -In the `superbol` field, past the path to the `superbol-free` -executable. +Go to your VSCode settings and in the extensions submenu, select +`SuperBOL Studio OSS`, and then `Extension Settings`. Fill in the +`superbol` field with the path to the `superbol-free` executable. You can check the documentation on using the extension on [this page](https://ocamlpro.github.io/superbol-studio-oss/sphinx). @@ -73,7 +69,7 @@ server and the VSCode extension from sources. 1. First, you need to install and initialize [opam](https://opam.ocaml.org/); -1. Then you need a recent version[^drom-version] of our build tool +2. Then you need a recent version[^drom-version] of our build tool [drom](https://ocamlpro.github.io/drom/). The easiest way to have it running is via the following command: @@ -83,7 +79,7 @@ server and the VSCode extension from sources. [^drom-version]: Current version is 0.9.2~dev3 (commit 63a5770). -1. To build the VSCode extension, you also need to have +3. To build the VSCode extension, you also need to have [node.js](https://nodejs.org/), and install `yarn` via: ```bash @@ -91,7 +87,7 @@ server and the VSCode extension from sources. yarn install ``` -1. You can then install all remaining dependencies, and compile the +4. You can then install all remaining dependencies, and compile the LSP server along with the VSCode extension: ```bash diff --git a/package.json b/package.json index a53c41724..b4035bb2b 100644 --- a/package.json +++ b/package.json @@ -16,11 +16,11 @@ { "command": "superbol.server.restart", "title": "Restart Language Server", - "category": "Superbol" + "category": "superbol" } ], "configuration": { - "title": "Superbol COBOL", + "title": "SuperBOL COBOL", "properties": { "superbol.globalFormatTakesSelection": { "type": "boolean", @@ -30,7 +30,7 @@ "superbol.path": { "type": "string", "default": "superbol-free", - "description": "Name of the `superbol` executable if available in PATH; otherwise may be an absolute path." + "description": "Name of the `superbol-free` executable if available in PATH; may be an absolute path otherwise." } } }, @@ -204,8 +204,8 @@ ] }, "name": "superbol", - "displayName": "Superbol Studio OSS", - "description": "Provides a COBOL mode in VSCode, based on SuperBOL Language Server Protocol for COBOL", + "displayName": "SuperBOL Studio OSS", + "description": "Provides a COBOL mode in VSCode, based on the SuperBOL LSP server for COBOL", "license": "MIT", "version": "0.1.0", "repository": { diff --git a/sphinx/installing-superbol-vsix.rst b/sphinx/installing-superbol-vsix.rst index eeafb8008..727d3f88a 100644 --- a/sphinx/installing-superbol-vsix.rst +++ b/sphinx/installing-superbol-vsix.rst @@ -11,10 +11,10 @@ TODO From :code:`.vsix` files ------------------------ -To install the extension from its VSIX file, open VSCode and go the +To install the extension from its VSIX file, open VSCode and go to the the :code:`Extensions` view. -Click on the :code:`⋅⋅⋅` at the top right of the left pane and select -:code:`Install from VSIX…`. +Click on the :code:`⋅⋅⋅` at the top right-hand side of the left pane +and select :code:`Install from VSIX…`. Select the :code:`superbol-vscode-platform.vsix` file to install it. diff --git a/sphinx/vscode-extension.rst b/sphinx/vscode-extension.rst index ac9f1f6d2..28032ae82 100644 --- a/sphinx/vscode-extension.rst +++ b/sphinx/vscode-extension.rst @@ -3,6 +3,8 @@ SuperBOL VSCode Extension ========================= +**TODO:** Update this Section if still relevant; remove it otherwise. + This VSCode extension is used to interface VSCode with the SuperBOL LSP Server and provides building tasks for your COBOL projects. diff --git a/src/lsp/superbol_free_lib/project.ml b/src/lsp/superbol_free_lib/project.ml index a201bee50..c364a3223 100644 --- a/src/lsp/superbol_free_lib/project.ml +++ b/src/lsp/superbol_free_lib/project.ml @@ -31,8 +31,9 @@ let marketplace = Manifest.marketplace let package = Manifest.package "superbol" - ~displayName: "Superbol Studio OSS" - ~description: "Provides a COBOL mode in VSCode, based on SuperBOL Language Server Protocol for COBOL" + ~displayName: "SuperBOL Studio OSS" + ~description: "Provides a COBOL mode in VSCode, based on the SuperBOL LSP \ + server for COBOL" ~license: "MIT" ~version: "0.1.0" ~repository: { @@ -135,7 +136,7 @@ let contributes = ] ~breakpoints: [ Manifest.breakpoint "COBOL" ] ~configuration: - ( Manifest.configuration ~title:"Superbol COBOL" + ( Manifest.configuration ~title:"SuperBOL COBOL" [ Manifest.PROPERTY.bool "superbol.globalFormatTakesSelection" @@ -146,8 +147,8 @@ let contributes = Manifest.PROPERTY.string "superbol.path" ~default:"superbol-free" ~description: - "Name of the `superbol` executable if available in PATH; \ - otherwise may be an absolute path." + "Name of the `superbol-free` executable if available in PATH; \ + may be an absolute path otherwise." ] ) ~taskDefinitions: [ Manifest.taskDefinition @@ -235,7 +236,7 @@ let contributes = Manifest.command () ~command:"superbol.server.restart" ~title:"Restart Language Server" - ~category:"Superbol" + ~category:"superbol" ] let manifest =