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 warning when .vsceignore is missing or misconfigured #1000

Closed
isidorn opened this issue Jun 12, 2024 · 4 comments
Closed

Print warning when .vsceignore is missing or misconfigured #1000

isidorn opened this issue Jun 12, 2024 · 4 comments
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 12, 2024

@timheuer makes some good points

"Without knowledge that you should be using .vscodeignore (maybe I'm not using vscode), nor tooling that creates that for me, nor warnings or anything, vsce
is packaging whatever is in the folder where I run the command. docs, tests, pipelines, etc. -- transparency is one thing (the issue I saw that's a start), how can we strive for better.
I personally hit this a few times (and even our C# Dev Kit in initial releases) that probably should be better tooling."

The open question is how to detect this case. Should we warn when .vscodeignore is not there. So that the user has to at least confirm the publish. Or can we see if .vscodeignore still has the default value. We do the same when looking at the readme.md

@isidorn isidorn added the under-discussion Issue is under discussion for relevance, priority, approach label Jun 12, 2024
@benibenj benibenj assigned benibenj and unassigned joaomoreno Jun 12, 2024
@benibenj
Copy link
Contributor

I agree we should do something to make sure the user is aware of .vscodeignore. I think we should print a warning when we do not detect a .vscodeignore file. We could also request the user to confirm that he wants to proceed without .vscodeignore file, however I fear we would break some pipelines with that.

Also printing what is being packaged is a great idea as mentioned here #995 and we could even provide a command to just print what would be packaged if the user runs vsce package or vsce publish so the user can see it without actually having to package the extension.

@isidorn
Copy link
Contributor Author

isidorn commented Jun 13, 2024

Good ideas. I suggest to discuss with Joao in your next sync, since he also has thoughts on this topic.

@benibenj
Copy link
Contributor

benibenj commented Jul 17, 2024

Building on the work completed in #995, we have added a warning for users who are not using either a .vscodeignore file or the "files" property in package.json. Additionally, we have made several minor enhancements to improve the overall experience for users packaging their extensions. These changes aim to ensure that extensions are packaged as expected.

@benibenj benibenj added this to the July 2024 milestone Jul 17, 2024
@isidorn
Copy link
Contributor Author

isidorn commented Jul 23, 2024

Works great -> verified
For a missing license file we ask the user to confirm with a Y. But for a missing .vscodeignore we just print a warning, and do not prompt the user. Should we prompt?

Image

@isidorn isidorn added feature-request Request for new features or functionality verification-needed Verification of issue is requested verified Verification succeeded and removed under-discussion Issue is under discussion for relevance, priority, approach labels Jul 23, 2024
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

No branches or pull requests

3 participants