Skip to content

Only include necessary files in the lldb-dap VSIX #124986

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

Merged
merged 1 commit into from
Jan 30, 2025

Conversation

matthewbastien
Copy link
Contributor

@matthewbastien matthewbastien commented Jan 29, 2025

The published VSIX for the LLDB DAP extension contains a bunch of unnecessary files:

❯ tar tf llvm-vs-code-extensions.lldb-dap-0.2.8.vsix

extension.vsixmanifest
[Content_Types].xml
extension/.github/workflows/auto_publish.yml
extension/.github/workflows/integrate_llvmproject.yml
extension/.gitignore
extension/.vscode/launch.json
extension/.vscode/tasks.json
extension/LICENSE.TXT
extension/out/debug-adapter-factory.js
extension/out/debug-adapter-factory.js.map
extension/out/disposable-context.js
extension/out/disposable-context.js.map
extension/out/extension.js
extension/out/extension.js.map
extension/out/types.js
extension/out/types.js.map
extension/package.json
extension/README.md
extension/src-ts/debug-adapter-factory.ts
extension/src-ts/disposable-context.ts
extension/src-ts/extension.ts
extension/src-ts/types.ts
extension/syntaxes/arm.disasm
extension/syntaxes/arm64.disasm
extension/syntaxes/disassembly.json
extension/syntaxes/x86.disasm
extension/tsconfig.json

All that's really needed is the package.json, license, README, syntaxes folder, and compiled sources. This PR adds a .vscodeignore file that requires files and directories to be explicitly added to the VSIX.

Contents of the VSIX after applying this change and running npm run package:

❯ tar tf out/lldb-dap.vsix

extension.vsixmanifest
[Content_Types].xml
extension/LICENSE.TXT
extension/out/debug-adapter-factory.js
extension/out/debug-adapter-factory.js.map
extension/out/disposable-context.js
extension/out/disposable-context.js.map
extension/out/extension.js
extension/out/extension.js.map
extension/package.json
extension/README.md
extension/syntaxes/arm.disasm
extension/syntaxes/arm64.disasm
extension/syntaxes/disassembly.json
extension/syntaxes/x86.disasm

I did a very basic sanity check of installing the packaged extension and debugging a simple swift application in VS Code to make sure the extension was still functional.

Copy link

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

Copy link
Member

@JDevlieghere JDevlieghere left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice cleanup. Thank you!

@JDevlieghere JDevlieghere merged commit 0d46657 into llvm:main Jan 30, 2025
9 checks passed
Copy link

@matthewbastien Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!

@matthewbastien matthewbastien deleted the lldb-dap-vscodeignore branch January 30, 2025 20:20
JDevlieghere added a commit that referenced this pull request Jan 31, 2025
Bump the version to 0.2.9 to publish #124986 in the Marketplace.
SquallATF pushed a commit to SquallATF/llvm-project that referenced this pull request Mar 8, 2025
Bump the version to 0.2.9 to publish llvm#124986 in the Marketplace.
SquallATF pushed a commit to SquallATF/llvm-project that referenced this pull request Mar 20, 2025
Bump the version to 0.2.9 to publish llvm#124986 in the Marketplace.
SquallATF pushed a commit to SquallATF/llvm-project that referenced this pull request Apr 2, 2025
Bump the version to 0.2.9 to publish llvm#124986 in the Marketplace.
SquallATF pushed a commit to SquallATF/llvm-project that referenced this pull request Apr 17, 2025
Bump the version to 0.2.9 to publish llvm#124986 in the Marketplace.
SquallATF pushed a commit to SquallATF/llvm-project that referenced this pull request Apr 30, 2025
Bump the version to 0.2.9 to publish llvm#124986 in the Marketplace.
SquallATF pushed a commit to SquallATF/llvm-project that referenced this pull request May 15, 2025
Bump the version to 0.2.9 to publish llvm#124986 in the Marketplace.
SquallATF pushed a commit to SquallATF/llvm-project that referenced this pull request May 29, 2025
Bump the version to 0.2.9 to publish llvm#124986 in the Marketplace.
SquallATF pushed a commit to SquallATF/llvm-project that referenced this pull request Jun 13, 2025
Bump the version to 0.2.9 to publish llvm#124986 in the Marketplace.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants