Skip to content

Commit

Permalink
Merge pull request #112 from nberth/fix-README.md
Browse files Browse the repository at this point in the history
Fix minor typos in README.md and the VSCode extension manifest
  • Loading branch information
nberth authored Nov 6, 2023
2 parents b703f74 + a291781 commit 012ff84
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 32 deletions.
32 changes: 14 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,40 +21,36 @@
## 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.

[^releases]: Available soon.

### 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

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).
Expand All @@ -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:

Expand All @@ -83,15 +79,15 @@ 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
npm install yarn
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
Expand Down
10 changes: 5 additions & 5 deletions package.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions sphinx/installing-superbol-vsix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 2 additions & 0 deletions sphinx/vscode-extension.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
13 changes: 7 additions & 6 deletions src/lsp/superbol_free_lib/project.ml
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down Expand Up @@ -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"
Expand All @@ -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
Expand Down Expand Up @@ -235,7 +236,7 @@ let contributes =
Manifest.command ()
~command:"superbol.server.restart"
~title:"Restart Language Server"
~category:"Superbol"
~category:"superbol"
]

let manifest =
Expand Down

0 comments on commit 012ff84

Please sign in to comment.