Update the api.ts for the getActiveFolderPath method. #3528
Conversation
This will need to also update and pull down the 1.1 version of the API. Changes coming.
|
Make sure to update the api version in the class. |
|
Npm package was updated for the API, as well as the dependency here, so this is ready to review. I confirmed that the API works by using the VS Code API Explorer (@benmcmorran) |
|
@benmcmorran @snehara99 ping. Thanks! |
| @@ -12,7 +12,7 @@ import { assertNever } from '@cmt/util'; | |||
| export class CMakeToolsApiImpl implements api.CMakeToolsApi { | |||
| constructor(private readonly manager: ExtensionManager) {} | |||
|
|
|||
| version: api.Version = api.Version.v1; | |||
| version: api.Version = api.Version.v2; | |||
There was a problem hiding this comment.
It's not a huge deal given what I expect is pretty low usage of the API, but we can do better by dynamically selecting which version of the API this claims to be based on the version that was requested from getApi() call.
As is, the extension will always return a v2 API object, even if the caller requested v1. Because v2 is backwards-compatible with v1, there should be no harm in simply overriding the API version in the returned object to be v1 when v1 is requested. That will allow any existing exact match queries for the v1 version of the API to continue to succeed even after the 1.17 release.
There was a problem hiding this comment.
I like this, good idea, I'll modify.
There was a problem hiding this comment.
Made the changes, let me know if you think I should do it in a different way @benmcmorran . Thanks!
There was a problem hiding this comment.
@benmcmorran Ping.
This will need to also update and pull down the 1.1 version of the API, so this is pending on a new version being published of https://www.npmjs.com/package/vscode-cmake-tools?activeTab=readme.
These changes are thanks to @Kemaweyan, who started this idea here: #3520. This makes the changes in our formal API.
We add the API method implementation and we update the dependency on the public API interface.
See the API PR here: microsoft/vscode-cmake-tools-api#3