Skip to content
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

more explanations on settings #367

Merged
merged 2 commits into from
Oct 21, 2024
Merged
Changes from 1 commit
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
32 changes: 21 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,26 +51,26 @@ be presented with a screen that resembles:

From here, you can notably configure:

- The COBOL dialect used in the project (see
- The COBOL dialect used in the project `"superbol.cobol.dialect"` (see
[here](https://get-superbol.com/gnucobol/manual/chapter2.html#configuration-options)
for a documentation on every available dialect). In SuperBOL, the
`default` dialect corresponds to GnuCOBOL's default, that supports
for a documentation on every available dialect).
In SuperBOL, the `default` dialect corresponds to GnuCOBOL's default, that supports
many features from dialects such as `COBOL2014`, `IBM`, `Micro
Focus` (`mf`), or `GCOS` for instance;

- The default reference source-format (see
- The default reference source-format `"superbol.cobol.source-format"` (see
[here](https://get-superbol.com/gnucobol/manual/chapter2.html#source-format)
for a documentation on the supported source formats). When `auto`
is selected, which is the default, SuperBOL (and GnuCOBOL) will
for a documentation on the supported source formats).
When `auto` is selected, which is the default, SuperBOL (and GnuCOBOL) will
automagically try to guess whether the source is in `free` or
`fixed` format. Other source formats need to be configured
explicitly.

- The path to copybooks. To configure this setting, you will need to
select `Edit in settings.json`. This is a list, where each entry
describes an element of the search path where your copybooks will be
looked for. Each entry must contain a directory name `dir`, and may
feature an optional `file-relative` flag. When absent or set to
- The path to copybooks `"superbol.cobol.copybooks"`.
To configure this setting, you will need to select `Edit in settings.json`. This is
a list, where each entry describes an element of the search path where your
copybooks will be looked for. Each entry must contain a directory name `dir`,
and may feature an optional `file-relative` flag. When absent or set to
`false`, the latter field indicates that the directory name is
either absolute, or relative to the root of the project's directory.
When `file-relative` is `true`, the element of the search path is
Expand All @@ -79,6 +79,13 @@ From here, you can notably configure:

![Editing copybook paths in `.vscode/settings.json`](./assets/superbol-editing-copybooks-path-in-vscode-settings.png)

- The copybook extensions `"superbol.cobol.copyexts"`.
To configure this setting, you will need to select `Edit in settings.json`. This is
a list, where each entry describes a file extension if the copybook name cannot
be found as-is (for example `COPY "mycpy.lib"`).
In SuperBOL, the `default` option does not correspond to GnuCOBOL's default, but to "cpy" and
"cbx" only.
nberth marked this conversation as resolved.
Show resolved Hide resolved
nberth marked this conversation as resolved.
Show resolved Hide resolved

## Syntax diagnostics

> [!NOTE]
Expand Down Expand Up @@ -173,6 +180,9 @@ contents of the copybook.

![Hover over `COPY`](./assets/superbol-hover-copy.png)

To ensure this works correctly, check your `"superbol.cobol.copybooks"`
and `"superbol.cobol.copyexts"` settings.

### Hover to Show Source Text Replacements

What's more? You can see the source text that results from
Expand Down