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

Optimized .vscodeignore #2475

Merged
merged 2 commits into from
Jul 25, 2024

Conversation

okineadev
Copy link
Member

@okineadev okineadev commented Jul 25, 2024

Description

I used a "leave what is necessary" strategy, instead of adding a large list of files that do not need to be added to the extension package (which increases the high probability of unwanted files getting into the package), I wrote down the files that just need to be left, this is a safer practice and in addition, .vscodeignore is now clearer

Here is the file tree in the finished package:

INFO  Files included in the VSIX:
material-icon-theme-5.7.0.vsix
├─ [Content_Types].xml 
├─ extension.vsixmanifest 
└─ extension/
   ├─ .npmignore [0.08 KB]
   ├─ CHANGELOG.md [172.13 KB]
   ├─ LICENSE.md [1.05 KB]
   ├─ README.md [12.38 KB]
   ├─ logo.png [17.32 KB]
   ├─ package.json [10.77 KB]
   ├─ package.nls.cs.json [2.28 KB]
   ├─ package.nls.de.json [2.32 KB]
   ├─ package.nls.es.json [3.28 KB]
   ├─ package.nls.fr.json [2.17 KB]
   ├─ package.nls.ja.json [2.77 KB]
   ├─ package.nls.ko.json [2.33 KB]
   ├─ package.nls.nl.json [2.14 KB]
   ├─ package.nls.pl.json [2.11 KB]
   ├─ package.nls.pt-BR.json [2.11 KB]
   ├─ package.nls.pt-PT.json [2.17 KB]
   ├─ package.nls.ru.json [2.65 KB]
   ├─ package.nls.zh-CN.json [1.9 KB]
   ├─ package.nls.zh-TW.json [1.9 KB]
   ├─ dist/ (4 files) [773.03 KB]
   └─ icons/ (943 files) [844.37 KB]

And another question, is the .npmignore file really necessary?

Contribution Guidelines

.vscodeignore Outdated Show resolved Hide resolved
.vscodeignore Outdated Show resolved Hide resolved
@PKief
Copy link
Member

PKief commented Jul 25, 2024

@okineadev .npmignore is necessary as this project is also published as npm package on the npm registry with different files: https://www.npmjs.com/package/material-icon-theme. You can test it with the command npm pack. It will create a local archive with all the files needed for the npm package.

@okineadev
Copy link
Member Author

@okineadev .npmignore is necessary as this project is also published as npm package on the npm registry with different files: npmjs.com/package/material-icon-theme. You can test it with the command npm pack. It will create a local archive with all the files needed for the npm package.

We are now talking about the files that are necessary for the vscode extension

@PKief
Copy link
Member

PKief commented Jul 25, 2024

@okineadev .npmignore is necessary as this project is also published as npm package on the npm registry with different files: npmjs.com/package/material-icon-theme. You can test it with the command npm pack. It will create a local archive with all the files needed for the npm package.

We are now talking about the files that are necessary for the vscode extension

Yep, I've misunderstood your question. For the vscode extension it's not needed.

@PKief PKief merged commit 88c3c85 into material-extensions:main Jul 25, 2024
1 check passed
Copy link

Merge Successful

Thanks for your contribution! 🎉

The changes will be part of the upcoming update on the marketplace.

@okineadev okineadev deleted the optimized-vscodeignore branch July 25, 2024 15:29
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.

2 participants