Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

👻 Enable use of a proposed api in dev mode #222

Merged
merged 2 commits into from
Feb 10, 2025

Conversation

sjd78
Copy link
Member

@sjd78 sjd78 commented Jan 20, 2025

In development mode, to avoid errors being displayed about proposed API use:

  • Add the proposed API to the extension's package.json so it can be activated from the vscode cli
  • Add the cli switch to the dev launcher.json config

Note: According to [1], an extension using a proposed api cannot be published. More exploration is needed to see how we can support using the proposed api via .vsix install but also create a package that can be published to the extension store.

[1] - https://code.visualstudio.com/api/advanced-topics/using-proposed-api

@sjd78 sjd78 requested a review from a team as a code owner January 20, 2025 19:24
@rszwajko
Copy link
Contributor

@jwmatthews @sjd78

  1. I could not find a date/plan for publishing the API needed for diff editor to be fully functional - my question in the November Iteration Plan was not answered (as all others)
  2. there is also vscode.workspace.applyEdit opens a duplicated editor for left-side edits in diff editor microsoft/vscode#234097 - a bug that impacts usability of diff editor. I've submitted and provided an example to reproduce the problem but there is also no clear fix date.

Considering the above - perhaps we should switch to merge editor as the default?

@sjd78
Copy link
Member Author

sjd78 commented Jan 21, 2025

@jwmatthews @sjd78

  1. I could not find a date/plan for publishing the API needed for diff editor to be fully functional - my question in the November Iteration Plan was not answered (as all others)

  2. there is also vscode.workspace.applyEdit opens a duplicated editor for left-side edits in diff editor microsoft/vscode#234097 - a bug that impacts usability of diff editor. I've submitted and provided an example to reproduce the problem but there is also no clear fix date.

Considering the above - perhaps we should switch to merge editor as the default?

Probably best so the extension can be published... We'll probably needs some processing in the copy scripts to filter out commands that hook the proposed APIs so the built extension is "clean".

@sjd78 sjd78 force-pushed the proposed-api-config branch from 3a89e9e to 7e8d643 Compare January 22, 2025 22:38
In development mode, to avoid errors being displayed
about proposed API use:
  - Add the proposed API to the extension's `package.json`
    so it can be activated from the vscode cli
  - Add the cli switch to the dev launcher.json config

Note: According to [1], an extension using a proposed api
cannot be published.  More exploration is needed to see how
we can support using the proposed api via `.vsix` install
but also create a package that can be published to the
extension store.

[1] - https://code.visualstudio.com/api/advanced-topics/using-proposed-api

Signed-off-by: Scott J Dickerson <[email protected]>
@sjd78 sjd78 force-pushed the proposed-api-config branch from 7e8d643 to d151aa0 Compare January 29, 2025 22:59
sjd78 added a commit to sjd78/editor-extensions that referenced this pull request Jan 30, 2025
The `diff` view requires use of proposed APIs. Swap
the default to the one that will both work without
special measures and will let the extension be
published to the extension markplace.

Ref: konveyor#222

Signed-off-by: Scott J Dickerson <[email protected]>
sjd78 added a commit that referenced this pull request Jan 30, 2025
The `diff` view requires use of proposed APIs. Swap the default to the
one that will both work without special measures and will let the
extension be published to the extension markplace.

Ref: #222

Note: This change does not remove the proposed api use warnings vscode
shows at startup.

Signed-off-by: Scott J Dickerson <[email protected]>
@sjd78
Copy link
Member Author

sjd78 commented Feb 7, 2025

@konveyor/kai-ide-reviewers -- We should put this in regardless and deal with publishability to a marketplace in the future. This PR will just make life a little nicer for us right now.

@sjd78 sjd78 merged commit ef15d67 into konveyor:main Feb 10, 2025
9 checks passed
@sjd78 sjd78 deleted the proposed-api-config branch February 10, 2025 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants