Skip to content

Commit 0b84d10

Browse files
committed
Add proposed API enablement info to README
1 parent 351ee7e commit 0b84d10

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,26 @@ Or install from the ObjectScript extension page on [Visual Studio Marketplace](h
3535

3636
![installation](https://raw.githubusercontent.com/intersystems-community/vscode-objectscript/master/images/installation.gif)
3737

38+
## Enable Proposed APIs
39+
40+
This extension is able to to take advantage of some VS Code APIs that have not yet been finalized. To permit this:
41+
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:
44+
```json
45+
"enable-proposed-api": ["intersystems-community.vscode-objectscript"]
46+
```
47+
3. Restart VS Code.
48+
4. Verify that the ObjectScript channel of the Output panel reports this:
49+
```
50+
intersystems-community.vscode-objectscript version X.X.X activating with proposed APIs available.
51+
```
52+
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)
57+
3858
## Configure Connection
3959

4060
To be able to use many features you first need to configure the connection to your IRIS/Caché/Ensemble server(s) in your [VS Code settings](https://code.visualstudio.com/docs/getstarted/settings). If you are unfamiliar with how settings work and how they are edited, use that link.

0 commit comments

Comments
 (0)