@@ -2,10 +2,10 @@ GNU/Emacs modes
2
2
===============
3
3
4
4
We document two means that are available for editing COBOL files using
5
- GNU/Emacs. One makes use of a modified version of :code: ` cobol-mode `
6
- that can be found on ELPA. The other is a new mode,
7
- :code: `superbol-mode `, that simply makes use of the LSP to provide a
8
- poweful COBOL IDE.
5
+ GNU/Emacs. One makes use of a modified version of
6
+ :code: ` cobol-mode.el ` that can be found on ELPA. The other is a new
7
+ mode, :code: `superbol-mode `, that simply makes use of the LSP to
8
+ provide a powerful COBOL IDE.
9
9
10
10
Standard file :code: `cobol-mode.el `
11
11
-----------------------------------
@@ -56,58 +56,59 @@ complete).
56
56
Superbol-mode
57
57
-------------
58
58
59
- The new Superbol mode is intended to provide an IDE that makes use of
60
- the Superbol LSP to provide advanced navigation and editing facilities
61
- for COBOL projects. It can be used in combination with any of the two
62
- main LSP clients that exist within the GNU/Emacs ecosystem to interact
63
- with LSP servers: `lsp-mode ` and `eglot `.
59
+ The new Superbol mode provides an IDE that makes use of the Superbol
60
+ LSP to provide advanced navigation and editing facilities for COBOL
61
+ projects. It can be used in combination with any of the two main LSP
62
+ clients that exist within the GNU/Emacs ecosystem to interact with LSP
63
+ servers: `lsp-mode ` and `eglot `.
64
64
65
65
Superbol-mode with `lsp-mode `
66
66
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
67
67
68
- `lsp-mode `_ appears to be the most prominent at the moment. The main
69
- advantages for using it in our context is its support for `semantic
70
- tokens `_, that provide a way for LSPs to issue information about the
71
- semantics of symbols from the source code. Compared to traditional
72
- regexp-based hightligting, semantic tokens provided by LSPs can
73
- drastically improve code readability via more detailed hightligting of
74
- source code elements;
68
+ `lsp-mode `_ appears to be the most prominent at the moment. This
69
+ client benefits from a large user-base, but is also considered
70
+ "bloated" by some.
71
+
72
+ The main advantages for using it in our context is its support for
73
+ `semantic tokens `_, that provide a way for LSPs to issue information
74
+ about the semantics of symbols from the source code. Compared to
75
+ traditional regexp-based highlighting, semantic tokens-based
76
+ highlighting can drastically improve code readability of various
77
+ source code elements based on their syntactic location;
75
78
76
79
.. _lsp-mode : https://github.com/emacs-lsp/lsp-mode
77
80
.. _semantic tokens :
78
81
https://code.visualstudio.com/api/language-extensions/semantic-highlight-guide
79
82
80
- `lsp-mode ` benefits from a large user-base, but is also considered
81
- "bloated" by some.
82
83
83
84
Superbol-mode with `eglot `
84
85
~~~~~~~~~~~~~~~~~~~~~~~~~~~
85
86
86
- Another possiblity is to use `eglot `_, that is sometimes considered
87
+ Another possibility is to use `eglot `_, that is sometimes considered
87
88
easier to configure and more lightweight than `lsp-mode ` (which
88
89
notably makes it more reactive to user inputs). Being more recent, it
89
90
lacks some of the features of `lsp-mode `, among which is the support
90
91
for semantic tokens [#eglot-semtok-issue ]_. However, additionally
91
- enabling the aforementioned `cobol-mode ` provides reasonable syntax
92
+ enabling the aforementioned `cobol-mode.el ` provides reasonable syntax
92
93
highlighting.
93
94
94
95
.. _eglot : https://elpa.gnu.org/packages/eglot.html
95
96
96
97
Setup
97
98
~~~~~
98
99
99
- To ease the setup process, we first define an environment variable
100
- that indicates where the ``superbol-free `` executable can be found.
101
- We additionally define a variable that points to the root of the
102
- source directory for the extension:
100
+ Let us first define an environment variable that indicates where the
101
+ ``superbol-free `` executable can be found. Additionally, define a
102
+ variable that points to the root of the source directory for the
103
+ extension:
103
104
104
105
.. code-block :: shell
105
106
106
107
export SUPERBOL_DIR=" <directory where superbol-free can be found>" ;
107
108
export SUPERBOL_VSCODE_PLATFORM_DIR=" $PWD " ;
108
109
109
- Then , the following command launches a GNU/Emacs instance with an
110
- `lsp-mode `-based client configured for COBOL files:
110
+ After this , the following command launches a GNU/Emacs instance with
111
+ an `lsp-mode `-based client configured for COBOL files:
111
112
112
113
.. code-block :: shell
113
114
0 commit comments