-
Notifications
You must be signed in to change notification settings - Fork 521
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1127 from davidsemakula/ink-vscode
ink! analyzer (phase 2) - milestone 7
- Loading branch information
Showing
1 changed file
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Milestone Delivery :mailbox: | ||
|
|
||
| **The [invoice form :pencil:](https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp-hd8mhIiO0A/viewform) has been filled out correctly for this milestone and 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:** 7 | ||
|
|
||
| **Context** (optional) | ||
|
|
||
| This delivery is for a [Visual Studio Code Extension](https://github.com/ink-analyzer/ink-vscode/) that implements all the ink! language support features provided by the [Semantic Analyzer](https://github.com/ink-analyzer/ink-analyzer/tree/master/crates/analyzer) and [Language Server](https://github.com/ink-analyzer/ink-analyzer/tree/master/crates/lsp-server) that were delivered and evaluated in | ||
| [milestones 1 through 6](https://github.com/w3f/Grant-Milestone-Delivery/pulls?q=is%3Apr+author%3Adavidsemakula+ink%21+analyzer+%28phase+2%29). | ||
|
|
||
| **Deliverables** | ||
|
|
||
| | Number | Deliverable | Link | Notes | | ||
| |---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | **0a.** | License | [GPL-3.0](https://github.com/ink-analyzer/ink-vscode/blob/master/LICENSE). | | | ||
| | **0b.** | Documentation | [Visual Studio Code Extension README](https://github.com/ink-analyzer/ink-vscode/blob/master/README.md), [Development, Debugging and Automated Testing](https://github.com/ink-analyzer/ink-vscode/blob/master/DEVELOPMENT.md) and [Manual Feature Testing](https://github.com/ink-analyzer/ink-vscode/blob/master/TESTING.md) guides on GitHub, and extensive inline source documentation in the [Github repository](https://github.com/ink-analyzer/ink-vscode/). | The VS Code Extension README is published on both [GitHub](https://github.com/ink-analyzer/ink-vscode/blob/master/README.md) and [the Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=ink-analyzer.ink-analyzer). | | ||
| | **0c.** | Testing and Testing Guide | [Development, Debugging and Automated Testing](https://github.com/ink-analyzer/ink-vscode/blob/master/DEVELOPMENT.md) and [Manual Feature Testing](https://github.com/ink-analyzer/ink-vscode/blob/master/TESTING.md) guides. | Comprehensive integration tests are implemented for all the core features. Integration tests for each feature can be found in the [`src/test/suite` directory](https://github.com/ink-analyzer/ink-vscode/tree/v0.1.25/src/test/suite) (i.e [diagnostics](https://github.com/ink-analyzer/ink-vscode/blob/v0.1.25/src/test/suite/diagnostics.test.ts), [completions](https://github.com/ink-analyzer/ink-vscode/blob/v0.1.25/src/test/suite/completions.test.ts), [code/intent actions](https://github.com/ink-analyzer/ink-vscode/blob/v0.1.25/src/test/suite/actions.test.ts), [hover content](https://github.com/ink-analyzer/ink-vscode/blob/v0.1.25/src/test/suite/hover.test.ts), [inlay hints](https://github.com/ink-analyzer/ink-vscode/blob/v0.1.25/src/test/suite/inlay-hints.test.ts), [signature help](https://github.com/ink-analyzer/ink-vscode/blob/v0.1.25/src/test/suite/signature-help.test.ts) e.t.c). Additionally, test ink! smart contracts are provided in the [`test-fixtures`](https://github.com/ink-analyzer/ink-vscode/tree/v0.1.25/test-fixtures) directory as a cargo workspace that is used for both manual debugging and automated testing. Lastly, VS Code [launch configurations](https://code.visualstudio.com/docs/editor/debugging#_launch-configurations) for debugging and automated testing are also provided as described in the [Development, Debugging and Automated Testing guide](https://github.com/ink-analyzer/ink-vscode/blob/master/DEVELOPMENT.md), while instructions for manual feature testing are provided in the [Manual Feature Testing Guide](https://github.com/ink-analyzer/ink-vscode/blob/master/TESTING.md). | | ||
| | **0d.** | Docker | [Dockerfile](https://github.com/ink-analyzer/ink-vscode/blob/master/.devcontainer/devcontainer.json). | A [docker configuration](https://github.com/ink-analyzer/ink-vscode/blob/master/.devcontainer/devcontainer.json) is provided in the form of a [Dev Container](https://code.visualstudio.com/docs/devcontainers/containers) which can be used for container-based development and testing in an isolated environment. See the [Development, Debugging and Automated Testing guide](https://github.com/ink-analyzer/ink-vscode/blob/master/DEVELOPMENT.md) for details. | | ||
| | **0e.** | Article | [Article](https://analyze.ink/blog/ink-analyzer-updates). | | | ||
| | 1. | Visual Studio Code Extension: Update extension to support ink! language support features added to the semantic analyzer and language server in milestones 1, 2, 3, 4, 5 and 6 | [GitHub repository](https://github.com/ink-analyzer/ink-vscode). | The extension is also available in the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=ink-analyzer.ink-analyzer), additionally [VSIX packages](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#packaging-extensions) can be downloaded directly from the [releases page of the GitHub repo](https://github.com/ink-analyzer/ink-vscode/releases). | | ||
|
|
||
|
|
||
| **Additional Information** | ||
|
|
||
| Please use the [v0.1.25](https://github.com/ink-analyzer/ink-vscode/releases/tag/v0.1.25) tag for testing. | ||
|
|
||
| You can checkout the tag locally as follows: | ||
|
|
||
| ```shell | ||
| git fetch --all --tags | ||
| git checkout tags/v0.1.25 -b v0.1.25 | ||
| ``` |