Skip to content

Commit

Permalink
Update the release notes for v12.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
sungshik committed Nov 13, 2024
1 parent 5aa4442 commit cb50af7
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 18 deletions.
21 changes: 3 additions & 18 deletions rascal-lsp/RELEASE-NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,9 @@

Note that rascal-lsp releases are bundled with VS Code releases, however due to historic reasons, their versions do not align. Until they do we'll denote both the VS Code and the rascal LSP release next to each other.

## Release ???

* ???
* We are starting the deprecation process for an odd special case in the
semantic highlighter (i.e., the categories of `syntax` non-terminals are
sometimes ignored):
* The present release adds a configuration parameter to enable/disable the
special case in language servers. The default is "enabled" (i.e., fully
backward-compatible). Grammars that rely on the special case *could* be
updated, and the parameter can be explicitly set to "disabled" (encouraged).
* A future release sets the default to "disabled". Grammars that rely on the
special case *should* be updated, or the parameter can be explicitly set to
"enabled" (discouraged).
* Another future release removes the configuration parameter (i.e., the
special case ceases to exist). Grammars that rely on the special case *must*
be updated.
See the documentation of ADT `LanguageService` in module
`util::LanguageServer` for details.
## Release ??? (VS Code: 0.12.0)

???

## Release 2.20.2 (VS Code: 0.11.2)

Expand Down
31 changes: 31 additions & 0 deletions rascal-vscode-extension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,37 @@ For other things we are working on have a look here:

## Release Notes

### 0.12.0

* New feature: The "Rename Symbol" command (default: `F2`) is now supported for all identifiers in Rascal modules. Renaming is safe, so the semantics of Rascal code before/after renaming is the same.

* New feature: Code Actions (default: `CTRL+.`) are now supported in Rascal modules to analyze and transform code (e.g.: visualization of import graphs; simplification of functions). Code actions can also be defined for DSLs; see the changes to module `util::LanguageServer` below.

* New feature: Keywords, numbers, strings (single-line), regular expressions, comments, and tags are now highlighted in Rascal modules even in the presence of parse errors. This feature uses a TextMate grammar for Rascal, generated using [`rascal-textmate`](https://github.com/SWAT-engineering/rascal-textmate).

* Upgrade to Rascal ???:
* ???

* Changes to module `util::LanguageServer`:
* Code Actions can be defined using constructor `action` of type `CodeAction`, and registered using constructor `codeAction` of type `LanguageService`.
* Constructors in type `LanguageService` are renamed to align them with the corresponding requests in LSP. Usage of the old names is now deprecated.
* Keyword parameter `useSpecialCaseHighlighting` is introduced on constructor `parsing` of type `LanguageService` (default: `true`). It is used to control whether or not the semantic highlighter should apply an odd special case (i.e., categories of `syntax` non-terminals are sometimes ignored); the semantic highlighter has been applying this special case for several releases. Usage of the special case is now deprecated.
* Constructor `codeLens` of type `LanguageService` has a function parameter with return type `lrel` instead of `rel` as before. Usage of return type `rel` for this function parameter is now deprecated.
* Type `Focus` is introduced. It is used to declare the parameters of on-demand services (`hover`, `definition`, `referenes`, `implementation`) instead of `loc`-`Tree`-`Tree` triples as before. Usage of such triples is now deprecated.

For each deprecated item:
* In the present release, support has not yet been removed for backward-compatibility, but existing code *should* be updated.
* In a future release, support will be removed, and existing code *must* be updated. (In the case of keyword parameter `useSpecialCaseHighlighting`, the default will first become `false` before it is removed.)

See module `util::LanguageServer` for details, and module `demo::lang::pico::LanguageServer` for examples.

* Small improvements:
* New feature: When the Rascal LSP server crashes, VS Code will now report the crash in a notification, including a button to open a GitHub issue.
* New feature: The default names of Rascal terminals can now be configured via setting `Rascal > Terminal > Name: Origin Format`.
* New feature: Project setups are now checked for common errors.
* Fixed "Start Rascal Terminal and Import this module" command
* Fixed problem with order of multiple code lenses on the same line

### 0.11.2

* bumping to rascal 0.34.2:
Expand Down

0 comments on commit cb50af7

Please sign in to comment.