vscode-objectscript icon indicating copy to clipboard operation
vscode-objectscript copied to clipboard

Document how to enable VS Code's proposed APIs for server-side searching

Open gjsjohnmurray opened this issue 3 years ago • 5 comments

See https://github.com/intersystems-community/vscode-objectscript/issues/126#issuecomment-674089387

We currently implement FileSearchProvider and TextSearchProvider when --enable-proposed-api is set as a launch argument.

gjsjohnmurray avatar Oct 15 '20 18:10 gjsjohnmurray

Added to 1.0.5 README in PR #475

Still needs to be added to main docs.

gjsjohnmurray avatar Nov 05 '20 00:11 gjsjohnmurray

@gjsjohnmurray maybe, you want to add a hint to the docs that "enable-proposed-api" is available in beta versions of the extension only?

copperschnack avatar Nov 06 '20 09:11 copperschnack

@copperschnack see #478

gjsjohnmurray avatar Nov 06 '20 09:11 gjsjohnmurray

Questions in my mind include: what exactly is a 'proposed' api, and what's going on with "maybe, you want to add a hint to the docs that "enable-proposed-api" is available in beta versions of the extension only?" If this is a pre-release feature, it should probably be discussed in the README until it has achieved released status.

jstetson10 avatar Jul 08 '21 23:07 jstetson10

@gjsjohnmurray I tend to agree with @jstetson10 that it may be confusing to cover features not available in the Marketplace version in the main documentation. How about a separate document -- something like BETAFEATURES.md -- and a reference to it from the README?

isc-rsingh avatar Jul 09 '21 03:07 isc-rsingh