From d5c1685585c5321e220057bcca6406360d620eba Mon Sep 17 00:00:00 2001 From: davidsemakula Date: Sat, 28 Oct 2023 23:08:34 +0300 Subject: [PATCH 1/5] ink! analyzer (phase 2) - milestone 5 --- .../ink-analyzer-phase-2-milestone-5.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 deliveries/ink-analyzer-phase-2-milestone-5.md diff --git a/deliveries/ink-analyzer-phase-2-milestone-5.md b/deliveries/ink-analyzer-phase-2-milestone-5.md new file mode 100644 index 000000000..cffbf5da4 --- /dev/null +++ b/deliveries/ink-analyzer-phase-2-milestone-5.md @@ -0,0 +1,28 @@ +# Milestone Delivery :mailbox: + +**The delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/milestone-deliverables-guidelines.md).** + +* **Application Document:** [ink! Analyzer (Phase 2)](https://github.com/w3f/Grants-Program/blob/master/applications/ink-analyzer-phase-2.md) +* **Milestone Number:** 5 + +**Context** (optional) + +This delivery is for the [LSP (Language Server Protocol) implementation](https://github.com/ink-analyzer/ink-analyzer/tree/master/crates/lsp-server) of [semantic analyzer](https://github.com/ink-analyzer/ink-analyzer/tree/master/crates/analyzer) features that were delivered and evaluated in milestones 1 ([PR](https://github.com/w3f/Grant-Milestone-Delivery/pull/1004), [delivery](https://github.com/w3f/Grant-Milestone-Delivery/blob/master/deliveries/ink-analyzer-phase-2-milestone-1.md) and [evaluation](https://github.com/w3f/Grant-Milestone-Delivery/blob/master/evaluations/ink-analyzer-phase-2_1_dsm-w3f.md)) and 2 ([PR](https://github.com/w3f/Grant-Milestone-Delivery/pull/1025), [delivery](https://github.com/w3f/Grant-Milestone-Delivery/blob/master/deliveries/ink-analyzer-phase-2-milestone-2.md) and [evaluation](https://github.com/w3f/Grant-Milestone-Delivery/blob/master/evaluations/ink-analyzer-phase-2_m_2_nikw3f.md)). + +**NOTE:** While milestones 3 and 4 (for the semantic analyzer) are still in development, this language server deliverable (milestone 5) only relies on semantic analyzer features that were already delivered in milestones 1 and 2. + +Please see the [README](https://github.com/ink-analyzer/ink-analyzer#readme) for additional architectural details. + +**Deliverables** + +| Number | Deliverable | Link | Notes | +|---------|-------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **0a.** | License | [MIT](https://github.com/ink-analyzer/ink-analyzer/blob/master/LICENSE-MIT) or [Apache 2.0](https://github.com/ink-analyzer/ink-analyzer/blob/master/LICENSE-APACHE). | Dual-licensed under either of MIT or Apache 2.0 licenses at the downstream user's option. | +| **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), [create_project_command](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/tests/create_project_command.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). | | + +**Additional Information** + +Please use the [master branch](https://github.com/ink-analyzer/ink-analyzer/tree/master) for testing, another branch will be used for continued work until the completion of the review. From e6aa8d43d256e2510ed920f6b6eb09baf8d53da0 Mon Sep 17 00:00:00 2001 From: davidsemakula Date: Tue, 31 Oct 2023 20:32:19 +0300 Subject: [PATCH 2/5] ink! analyzer (phase 2) - milestone 5 - add tag checkout instructions --- deliveries/ink-analyzer-phase-2-milestone-5.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/deliveries/ink-analyzer-phase-2-milestone-5.md b/deliveries/ink-analyzer-phase-2-milestone-5.md index cffbf5da4..fcf92e452 100644 --- a/deliveries/ink-analyzer-phase-2-milestone-5.md +++ b/deliveries/ink-analyzer-phase-2-milestone-5.md @@ -25,4 +25,10 @@ Please see the [README](https://github.com/ink-analyzer/ink-analyzer#readme) for **Additional Information** -Please use the [master branch](https://github.com/ink-analyzer/ink-analyzer/tree/master) for testing, another branch will be used for continued work until the completion of the review. +Please use the [lsp-server-v0.2.11](https://github.com/ink-analyzer/ink-analyzer/releases/tag/lsp-server-v0.2.11) tag for testing. + +You can checkout the tag locally as follows: +```shell +git fetch --all --tags +git checkout tags/lsp-server-v0.2.11 -b lsp-server-v0.2.11 +``` \ No newline at end of file From e958693ca8585052b759aa0187928eaf510ca6d3 Mon Sep 17 00:00:00 2001 From: davidsemakula Date: Thu, 2 Nov 2023 20:31:12 +0300 Subject: [PATCH 3/5] update deliverable notes and recommended tag for testing --- deliveries/ink-analyzer-phase-2-milestone-5.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/deliveries/ink-analyzer-phase-2-milestone-5.md b/deliveries/ink-analyzer-phase-2-milestone-5.md index fcf92e452..d8be6d67d 100644 --- a/deliveries/ink-analyzer-phase-2-milestone-5.md +++ b/deliveries/ink-analyzer-phase-2-milestone-5.md @@ -15,20 +15,20 @@ Please see the [README](https://github.com/ink-analyzer/ink-analyzer#readme) for **Deliverables** -| Number | Deliverable | Link | Notes | -|---------|-------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **0a.** | License | [MIT](https://github.com/ink-analyzer/ink-analyzer/blob/master/LICENSE-MIT) or [Apache 2.0](https://github.com/ink-analyzer/ink-analyzer/blob/master/LICENSE-APACHE). | Dual-licensed under either of MIT or Apache 2.0 licenses at the downstream user's option. | -| **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), [create_project_command](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/lsp-server/tests/create_project_command.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). | | +| Number | Deliverable | Link | Notes | +|---------|-------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **0a.** | License | [MIT](https://github.com/ink-analyzer/ink-analyzer/blob/master/LICENSE-MIT) or [Apache 2.0](https://github.com/ink-analyzer/ink-analyzer/blob/master/LICENSE-APACHE). | Dual-licensed under either of MIT or Apache 2.0 licenses at the downstream user's option. | +| **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 dispatching LSP requests, notifications and handling responses. Server initialization logic and setting 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 in 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** -Please use the [lsp-server-v0.2.11](https://github.com/ink-analyzer/ink-analyzer/releases/tag/lsp-server-v0.2.11) tag for testing. +Please use the [lsp-server-v0.2.12](https://github.com/ink-analyzer/ink-analyzer/releases/tag/lsp-server-v0.2.12) tag for testing. You can checkout the tag locally as follows: ```shell git fetch --all --tags -git checkout tags/lsp-server-v0.2.11 -b lsp-server-v0.2.11 +git checkout tags/lsp-server-v0.2.12 -b lsp-server-v0.2.12 ``` \ No newline at end of file From 6eb682d151e9960c9f69f3c0e41f894e60bd4b6f Mon Sep 17 00:00:00 2001 From: davidsemakula Date: Thu, 2 Nov 2023 20:47:34 +0300 Subject: [PATCH 4/5] fix typos --- deliveries/ink-analyzer-phase-2-milestone-5.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deliveries/ink-analyzer-phase-2-milestone-5.md b/deliveries/ink-analyzer-phase-2-milestone-5.md index d8be6d67d..fc16d61b2 100644 --- a/deliveries/ink-analyzer-phase-2-milestone-5.md +++ b/deliveries/ink-analyzer-phase-2-milestone-5.md @@ -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 dispatching LSP requests, notifications and handling responses. Server initialization logic and setting 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 in 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 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. | **Additional Information** From 20bac3d0c3fbbfe7ec727289969a4ae026adde9e Mon Sep 17 00:00:00 2001 From: davidsemakula Date: Fri, 3 Nov 2023 09:05:39 +0300 Subject: [PATCH 5/5] disambiguate actions --- deliveries/ink-analyzer-phase-2-milestone-5.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deliveries/ink-analyzer-phase-2-milestone-5.md b/deliveries/ink-analyzer-phase-2-milestone-5.md index fc16d61b2..51cf01832 100644 --- a/deliveries/ink-analyzer-phase-2-milestone-5.md +++ b/deliveries/ink-analyzer-phase-2-milestone-5.md @@ -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**