Skip to content

Commit 60eb71d

Browse files
committed
fix #478 update README to cover downloading of beta VSIX for proposed API usage
1 parent 5bd7071 commit 60eb71d

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,23 +37,32 @@ Or install from the ObjectScript extension page on [Visual Studio Marketplace](h
3737

3838
## Enable Proposed APIs
3939

40-
This extension is able to to take advantage of some VS Code APIs that have not yet been finalized. To permit this:
40+
This extension is able to to take advantage of some VS Code APIs that have not yet been finalized.
4141

42-
1. From [Command Palette](https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_command-palette) choose `Preferences: Configure Runtime Arguments`.
43-
2. In the argv.json file that opens, add this line:
42+
The additional features (and the APIs used) are:
43+
- Server-side [searching across files](https://code.visualstudio.com/docs/editor/codebasics#_search-across-files) being accessed using isfs (TextSearchProvider)
44+
- [Quick Open](https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_quick-open) of isfs files (FileSearchProvider).
45+
- Improved labels (tabs, file lists, tooltips) for server-side files (ResourceLabelFormatter)
46+
47+
To unlock these features:
48+
49+
1. Marketplace does not allow publication of extensions that use proposed APIs. Download and install a beta version from GitHub.
50+
- Go to https://github.com/intersystems-community/vscode-objectscript/releases
51+
- Locate the beta immediately above the release you installed from Marketplace. For instance, if you installed `1.0.5`, look for `1.0.6-beta.1`. This will be functionally identical to the Marketplace version apart from being able to use proposed APIs.
52+
- Download the VSIX file (for example `vscode-objectscript-1.0.6-beta.1.vsix`) and install it. One way to install a VSIX is to drag it from your download folder and drop it onto the list of extensions in the Extensions view of VS Code.
53+
54+
2. From [Command Palette](https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_command-palette) choose `Preferences: Configure Runtime Arguments`.
55+
3. In the argv.json file that opens, add this line:
4456
```json
4557
"enable-proposed-api": ["intersystems-community.vscode-objectscript"]
4658
```
47-
3. Restart VS Code.
48-
4. Verify that the ObjectScript channel of the Output panel reports this:
59+
4. Restart VS Code.
60+
5. Verify that the ObjectScript channel of the Output panel reports this:
4961
```
50-
intersystems-community.vscode-objectscript version X.X.X activating with proposed APIs available.
62+
intersystems-community.vscode-objectscript version X.Y.Z-beta.1 activating with proposed APIs available.
5163
```
5264

53-
The enabled features (and the APIs used) are:
54-
- Server-side [searching across files](https://code.visualstudio.com/docs/editor/codebasics#_search-across-files) being accessed using isfs (TextSearchProvider)
55-
- [Quick Open](https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_quick-open) of isfs files (FileSearchProvider).
56-
- Improved labels (tabs, file lists, tooltips) for server-side files (ResourceLabelFormatter)
65+
After a subsequent update of the extension from Marketplace you will need to download and install the new `-beta.1` VSIX. None of the other steps above will need to be repeated.
5766

5867
## Configure Connection
5968

0 commit comments

Comments
 (0)