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

Print packaged extension contents on package/publish #995

Closed
isidorn opened this issue Jun 11, 2024 · 5 comments · Fixed by #1013
Closed

Print packaged extension contents on package/publish #995

isidorn opened this issue Jun 11, 2024 · 5 comments · Fixed by #1013
Assignees
Labels
feature-request Request for new features or functionality verification-needed Verification of issue is requested verified Verification succeeded
Milestone

Comments

@isidorn
Copy link
Contributor

isidorn commented Jun 11, 2024

Let's be inspired by esbuild and print out what is actually being packaged.
This should be printed out both on vsce package and vsce publish. We could even have a nice ⚠ on items that are larger than some limit. Only top level files/folders can be printed.

The goal is to make it easier for extensions authors to figure out what is actually being packaged as part of their extension. So they can avoid accidentally packaging something.

Image

fyi @joaomoreno

@joaomoreno joaomoreno changed the title Transparency about what is being packaged Print packaged extension contents on package/publish Jun 11, 2024
@joaomoreno joaomoreno added the feature-request Request for new features or functionality label Jun 11, 2024
@joaomoreno joaomoreno added this to the July 2024 milestone Jun 11, 2024
@kiddio
Copy link

kiddio commented Jun 11, 2024

To add to this, by default the packageCommand function inside package.ts defaults to process.cwd and it isn't documented that the user can configure this path or that it's the default behaviour.

The option is a part of the options object for the package commend here.

Yet in main.ts there is no mention of this being configurable nor is it passed down to the packageCommand function inside package.ts. So, with the change you mention, a user utilising the CLI won't know what is being packaged until after they have run the command.

It might also be worth adding that in as part of this so that a user can be doubly sure that what they are packaging is what they intended?

@joaomoreno
Copy link
Member

Addition to the idea: we should also print out which inclusion/exclusion rules were used or missing during file collection (ie .vscodeignore, files prop).

@benibenj benibenj added verification-needed Verification of issue is requested and removed verification-needed Verification of issue is requested labels Jul 19, 2024
@benibenj
Copy link
Contributor

benibenj commented Jul 19, 2024

Image

@benibenj
Copy link
Contributor

verification steps

  • Install newest @vscode/vsce version
  • Run vsce package => It should print the packaged files, it won't print all of them if there are many
  • Run vsce ls --tree => Show all files which would be added to the package

@isidorn isidorn added the verified Verification succeeded label Jul 23, 2024
@isidorn
Copy link
Contributor Author

isidorn commented Jul 23, 2024

Works great, thanks a lot for this!

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request Request for new features or functionality verification-needed Verification of issue is requested verified Verification succeeded
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants