Skip to content

Commit

Permalink
disambiguate actions
Browse files Browse the repository at this point in the history
  • Loading branch information
@davidsemakula
davidsemakula committed Nov 3, 2023
1 parent 6eb682d commit 20bac3d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion deliveries/ink-analyzer-phase-2-milestone-5.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Please see the [README](https://github.com/ink-analyzer/ink-analyzer#readme) for
| **0b.** | Documentation | [Project README](https://github.com/ink-analyzer/ink-analyzer#readme), [language server (ink-lsp-server) crate README](https://github.com/ink-analyzer/ink-analyzer/tree/master/crates/lsp-server#readme) on GitHub (and [crates.io](https://crates.io/crates/ink-lsp-server)), [language server (ink-lsp-server) crate rustdoc](https://docs.rs/ink-lsp-server/latest/ink_lsp_server/) library documentation on docs.rs and extensive inline source documentation. | The language server's README is published on both [GitHub](https://github.com/ink-analyzer/ink-analyzer/tree/master/crates/lsp-server#readme) and [crates.io](https://crates.io/crates/ink-lsp-server). It contains instructions for installation and usage, and links to crate's associated library documentation on docs.rs. |
| **0c.** | Testing and Testing Guide | [Testing guide](https://github.com/ink-analyzer/ink-analyzer#testing). | Unit tests are defined in the [dispatch/handlers/request](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/src/dispatch/handlers/request.rs#L286-L542) module, while integration tests are found in the [tests directory of the language server (ink-lsp-server) crate](https://github.com/ink-analyzer/ink-analyzer/tree/master/crates/lsp-server/tests) (e.g. [tests/inlay_hints](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/tests/inlay_hints.rs), [tests/signature_help](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/tests/signature_help.rs), [tests/commands](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/tests/commands.rs) e.t.c) with related fixtures (where applicable) found in [test-utils/fixtures](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/test-utils/src/fixtures.rs). Checking out the [parse_offset_at](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/test-utils/src/lib.rs#L55-L86) utility may be useful as it is extensively used in both the unit and integration tests. All features in this milestone can also be manually tested using the latest version of the [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=ink-analyzer.ink-analyzer). For instructions for manual feature testing, please refer to the [VS Code extension's "Manual Feature Testing Guide"](https://github.com/ink-analyzer/ink-vscode/blob/master/TESTING.md). |
| **0d.** | Docker | [Dockerfile](https://github.com/ink-analyzer/ink-analyzer/blob/master/Dockerfile). | |
| 1. | Language Server: Rust binary crate: ink! Language Server updates for semantic analyzer features from milestones 1 and 2 | [GitHub repository](https://github.com/ink-analyzer/ink-analyzer), [Language server crate (ink-lsp-server)](https://crates.io/crates/ink-lsp-server). | At the highest level, features are implemented as actions (e.g. [diagnostics](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/src/dispatch/actions.rs)) or request handlers (e.g. [actions, completions, inlay hints, signature help e.t.c](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/src/dispatch/handlers/request.rs)) under the [dispatch](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/src/dispatch.rs) module, which implements the main loop for dispatching LSP requests and notifications and handling responses. Server initialization logic and setting/negotiating of capabilities is implemented in the [initialize](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/src/initialize.rs) module, while translation between analyzer and LSP types is implemented in the [translator](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/src/translator.rs) module. NOTE: Quickfixes are returned by the [code actions handler](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/src/dispatch/handlers/request.rs#L99-L135) as they're a [code action kind](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#codeActionKind) in LSP. |
| 1. | Language Server: Rust binary crate: ink! Language Server updates for semantic analyzer features from milestones 1 and 2 | [GitHub repository](https://github.com/ink-analyzer/ink-analyzer), [Language server crate (ink-lsp-server)](https://crates.io/crates/ink-lsp-server). | At the highest level, features are implemented as dispatch actions (e.g. [diagnostics](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/src/dispatch/actions.rs)) or request handlers (e.g. [code actions, completions, inlay hints, signature help, commands e.t.c](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/src/dispatch/handlers/request.rs)) under the [dispatch](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/src/dispatch.rs) module, which implements the main loop for dispatching LSP requests and notifications and handling responses. Server initialization logic and setting/negotiating of capabilities is implemented in the [initialize](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/src/initialize.rs) module, while translation between analyzer and LSP types is implemented in the [translator](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/src/translator.rs) module. NOTE: Quickfixes are returned by the [code actions handler](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/src/dispatch/handlers/request.rs#L99-L135) as they're a [code action kind](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#codeActionKind) in LSP. |

**Additional Information**

Expand Down

0 comments on commit 20bac3d

Please sign in to comment.