vscode-icons

Bring icons to your Visual Studio Code (minimum supported version: 1.8.1)

A little bit of history about this extension

As you all know, VSCode currently supports File and Folder icons but this was not like this from the beginning. Read this great article by @chrisdias: "Rebellion. Mutiny. Revolt. Uprising." if you want to learn the history about this plugin and how finally icons landed in VSCode.

During the summer of 2016, I had great support from the community and the VSCode team. It's also worth mentioning the tremendous help that I received from @aeschli (VSCode Team) and especially from @jens1o (community member), which turned out to be a 14-year-old amazing coder!

Later on, until the present moment, @JimiC entered the scene and I have to say that he's been a real revolution to this project. With his incredible insight, precision and determination, he's improving this extension way beyond it was initially intended.

I'm very happy to be part of this team, along with @jens1o and @JimiC. It's really a gift to work with you guys. Most of the credits of this extension are theirs. It's also community's. And remember that if you want to be a contributor or even become a regular of our team, you are more than welcome to join! :D

Main Contributors

This project has gone far beyond it's main purpose, which was to provide icons for VSCode when the platform didn't still support them, and now it tries to provide the most complete set of icons you can find. I began this journey alone but this wouldn't have been possible without the help of many of you. Some members of the community have been strongly committed to the project and now they are part of the core team of mantainers.

Please, meet the team behind this extension:

• @jens1o
• @JimiC
• @robertohuertasm

If you're willing to collaborate with us feel free to join our Github repository. ;)

---

State of the extension

@JimiC has brought most of 7.11.0 which comes with some brand new icons and a really new cool feature, the ability to customize the custom icons folder path. With this, you will be able to ship your own custom icons along your repository and share them with your team. Or even store them in the cloud and have them available everywhere. If you want to know more about how it works, just read the custom icons section.

With the release of 7.10.0, we improved the way the extension is handling your manual changes to a presets or associations configuration. By default, every time you change any of the aforementioned configurations, you will be presented with the message to Restart the editor, for the changes to take effect. Of course, you can always disable this behavior. See the Configuration section for more details.

As from release 7.7.0, the project detection feature has become smarter and is totally unobtrusive. If you have it disabled, because you found it annoying for any reason, we urge you to re-enable it and check out its new functionality.

We're talking about a major improvement over this feature. It will help you to enable and disable your Angular icons whenever you switch different projects without messing around with your workspace settings. Forget about having to deal with your source control every time the workspace setting was changed. @JimiC has done a really good work and we're pretty sure that you're going to love it! As usual, any feedback will be more than welcome. ;)

We support localization of the extension, too! We intend to expand the supported languages as the Visual Studio Code adds them. Take a look at the translation's section if you want to know more or contribute.

We also keep supporting the ability for users to customize the icons without having to inject anything into the Visual Studio Code's code.

This was a huge step to allow the users to fully customize how the icons looked like and how they could be associated to any extension at will.

Custom Icon association is still not supported by VSCode API but we thought that it was a very demanded feature and thought of a way to make it work for you. Remember that there's still an open issue in VSCode's repo talking about how they could provide official support for this feature. Provide a +1 if you want the VSCode team to support it out of the box. More information in #328.

Thank you all for your kind support. We will continue to try to improve the extension to make it more user friendly :D

---

Installation

Some people have reported that they cannot find the extension when they insert the installation command:

ext install vscode-icons

If you're in the same position try this:

ext install icons
# or
ext install "vscode-icons"

Enable the extension

Go to File > Preferences > File Icon Theme > VSCode Icons.

(Note on OSX it is Code > Preferences > File Icon Theme > VSCode Icons.)

List of supported icons

The list is slowly growing. If you want to check what icons are currently supported take a look here. If you feel that there's some icon missing please let me know through the issues section of the Github's repo.

If you're a designer and you're willing to collaborate by showing your icons to the world you're more than welcome!! Currently, we don't have icons for the light template, so any help will be really appreciated and credit will be given to you ;D

List of supported folder icons

If you want to check which folder icons are currently supported take a look here. As usual, if you want to add an icon submit a PR or raise a Github issue.

Configuration

If you don't want to see the new version message every time the extension updates, then set this configuration setting:

{
  "vsicons.dontShowNewVersionMessage": true
}

If you don't want to see the Restart message every time you manually change the extension's presets and associations configurations, then set this configuration setting:

{
  "vsicons.dontShowConfigManuallyChangedMessage": true
}

Customizing the extension

The extension gives you the ability to change how the icons look or even what icons are associated to each extension.

We have exposed the internal API that we are using to build the icon manifest so you can also use it in your vscode settings and generate it at runtime. This will allow you to customize all the icons, add new ones and so on.

Although you now have this power, we're encouraging everyone to raise an issue in the issues section of the Github's repo in case you find any of your customizations valuable to the rest of the community so we can implement them out of the box.

But, how does this work?

The extension now provides some specific commands for you to use. Let's talk first about the presets and then we're going to talk about how you can fine tune the extension.

Presets

There are several different presets:

• vsicons.presets.angular (false by default)
• vsicons.presets.jsOfficial (false by default)
• vsicons.presets.tsOfficial (false by default)
• vsicons.presets.jsonOfficial (false by default)
• vsicons.presets.hideFolders (false by default)
• vsicons.presets.foldersAllDefaultIcon (false by default)

These presets can be changed manually by using a settings.json file inside your project's .vscode folder or by changing vscode user settings. Take into account that the place where you set these presets, or for that matter, any configuration, will be very important. User settings are global so all your projects will be affected by them while workspace's settings are specific to the project and you will be able to switch presets by project. This can be interesting for the angular preset, for example.

These presets can also be automatically set by leveraging a new set of commands that can be found by pressing F1 and then writing down icons. You will be presented with some new commands:

• Toggle Angular Preset (Workspace Level): This command will enable/disable the Angular icons.
• Toggle Official JS Preset (User Level): This command will enable/disable the Official JS icon.
• Toggle Official TS Preset (User Level): This command will enable/disable the Official TS icon.
• Toggle Official JSON Preset (User Level): This command will enable/disable the Official JSON icon.
• Toggle Folder Icons Visibility (User Level): This command will enable/disable the Visibility of the folder icons.
• Toggle Specific Folder Icons (User Level): This command will enable/disable the Specific folder icons.

Note that some of the preset commands will modify your settings at a different level. If you choose to modify them manually then you can also choose what setting are you going to use.

It's also important to say that if you choose to make a manual modification you will have to execute the Apply Icons Customization command (see below).

The Angular Preset will affect all icons beginning with ng_ so you'd better name your custom icons accordingly if you want it to work flawlessly. ;P

Project detection

With the introduction of the project specific icons toggling feature, we also introduced the auto project detection feature, that will automatically detect what type of project you have opened in your workspace and prompt you to toggle the icons accordingly.

You will be presented with four choices:

• Restart: Will apply the changes and restart your workspace.
• Auto-Restart: Will always automatically apply the changes and restart your workspace. You will not be prompt again.
• Disable Detection: Disables the auto project detection. You will not be prompt again.
• Close: Cancels your action.

There are two different projectDetection settings associated with this feature, that modify your settings at the User Level:

• vsicons.projectDetection.autoReload (false by default)
• vsicons.projectDetection.disableDetect (false by default)

Fine tuning

Along with the commands we introduced above, you will find some more (just press F1 and type icons):

• Apply Icons Customization: This command will regenerate the Icons manifest with your customizations and restart the IDE for the changes to take effect.
• Reset Project Detection Defaults: This command will reset the project detection settings to their default values.
• Restore Default Icon Manifest: This command will revert any changes you may have applied and restore the extension to its default state.

But before you can even use them you will have to go to your settings and make your magic. The settings will provide you 2 different array items:

• vsicons.associations.files: IFileExtension[]
• vsicons.associations.folders: IFolderExtension[]

Each item of the array represents a file or a folder icon. The functionality is the same for files and folders.

Note that it's important to know what the current supported file extensions / icons and supported folder extensions / icons are.

Along with the previous arrays you will have 4 more settings available that will help you customize how the default icons for files and folders look like:

• vsicons.associations.fileDefault.file: IDefaultExtension
• vsicons.associations.fileDefault.file_light: IDefaultExtension
• vsicons.associations.fileDefault.folder: IDefaultExtension
• vsicons.associations.fileDefault.folder_light: IDefaultExtension

// this is a very simple interface.
// your configuration will simply replace the default icon. See Custom Icons sections below.
"vsicons.associations.fileDefault.file": { "icon": "myfile", "format": "svg" },

// if you want to disable default icons for folders that will do the trick
"vsicons.associations.folderDefault.folder": { "icon": "myfile", "format": "svg", "disabled": true }

Some examples

// Adding new extensions to an already supported icon.
// note: the format must match the existing one. If not, it will use the extension you provide.
"vsicons.associations.files": [
  { "icon": "js", "extensions": ["myExt1", "myExt2.custom.js"], "format": "svg" }
]

// Adding new filename extensions to an already supported icon.
// note: the format must match the existing one. If not, it will use the extension you provide.
"vsicons.associations.files": [
    { "icon": "webpack",  "extensions": ["webpack.config.test.js"], "filename": true, "format": "svg" }

// Disabling an already supported icon.
// note: this is, indeed, the functionality that presets are leveraging.
// Take into account that the disable property will hide all the icon occurrences.
// So it's an all or nothing toggle. If you want to enable the icon for just a few
// extensions instead of all the defined extensions take a look at the Overrides example below.
"vsicons.associations.files": [
  { "icon": "js", "extensions": [], "format": "svg", "disabled": true }
]

// Adding a new extension.
// note: see instructions below on custom icons.
"vsicons.associations.files": [
  { "icon": "custom", "extensions": ["custom", "my.custom"], "format": "svg" }
]

// Changing the icon to an already supported icon.
"vsicons.associations.files": [
  { "icon": "newIcon", "extensions": [""], "format": "svg", "extends": "js" }
]

// Overriding an already supported icon.
// note: the difference between overrides and extends is that overrides will completely
// remove the older icon functionality while extends will keep older settings by
// putting yours on top.
"vsicons.associations.files": [
  { "icon": "myJs", "extensions": ["js", "custom.js"], "format": "svg", "overrides": "js" }
]

// Partially disabling an icon
// In this case, you only want to show the `src` icon for `src` folders, not `sources, source`
// and the other defined icons. You may be tempted to use the `disabled` property but `overrides`
// is your friend here. Just remember that `overrides` will remove the older entry and add yours.
"vsicons.associations.folders": [
    { "icon": "src", "extensions": ["src"], "format": "svg", "overrides": "src" }
]

Custom Icons

In order to place your custom icons you will have to create a specific folder. Depending on your OS the path will be:

• Windows: C:\Users\<your_user>\AppData\Roaming\<Code Folder>\User\vsicons-custom-icons
• Linux: /home/<your_user>/.config/<Code Folder>/User/vsicons-custom-icons
• Mac: /Users/<your_user>/Library/Application Support/<Code Folder>/User/vsicons-custom-icons

<Code Folder> refers to the name of the folder of VSCode depending on the version:

• Code for the stable version.
• Code - Insiders for the insiders version.

Once you have created the folder you can put all your custom icons there. But, again, they have to follow vscode-icons naming conventions:

• Files: file_type_<value_of_icon_property>.svg
• Folders: folder_type_<value_of_icon_property>.svg & folder_type_<value_of_icon_property>_opened.svg
• Default Files & Folders: default_<value_of_icon_property>.svg

Note that folders must have two icons!!

See here the supported file extensions for an icon.

With 7.11.0, we shipped a new feature allowing you to provide your own specific custom icons folder path. This can be useful if you have a network share with your team or you want to delivery your own icons along your own repository.

If you want to take advantadge of this feature, just go to your settings and set vsicons.customIconFolderPath with the path to the folder containing the vscode-custom-icons folder.

Note that the name of the folder containing the icons must be vscode-custom-icons.

You have to specifically set the path, to the folder where this folder is going to be placed, not the folder itself. This is very important as it may lead to confusion.

i.e. If the path to the above folder is /path/to/custom/icons/folder/vsicons-custom-icons/, then the path set in the configuration has to be /path/to/custom/icons/folder/.

Optional Angular icons

Since 7.10.0, along with the usual Angular icons, we shipped some optional icons for users wanting to have some specific icons for component templates and component styles.

In order to enable them just add this to your settings:

{ "icon": "ng_component_html", "extensions": ["component.html", "component.htm"], "format": "svg", "disabled": true },
{ "icon": "ng_component_css", "extensions": ["component.css"], "format": "svg", "disabled": true },
{ "icon": "ng_component_less", "extensions": ["component.less"], "format": "svg", "disabled": true },
{ "icon": "ng_component_sass", "extensions": ["component.sass"], "format": "svg", "disabled": true },
{ "icon": "ng_component_scss", "extensions": ["component.scss"], "format": "svg", "disabled": true }

Note: The disabled attribute is set to true to allow the Project Auto Detection system to decide if they must be enabled or not. In our case, we want these icons to be disabled by default but to be enabled whenever we are working with an Angular project.

Contributing with icons

If you're willing to create an icon just follow this few conventions:

1. We're using SVG or PNG-24 but we prefer SVG if possible.
2. 32x32
3. 2px margin (but see #195)
4. Center the icon, but lower it a pixel.
5. It must be transparent.

Preview of icons

In order to help you preview how the icon you are contributing will look in the editor, we are providing you with a tool that generates dummy folders or files of the provided icon.

The syntax follows the pattern:

npm run example -- [flag] [space separated file names | space separated folder names]

Supported flags are --all, --folders, --files.

Syntax examples

npm run example -- --folders bower css

Hint: By omitting the use of the space separated folder names, the tool will create examples for all supported folders.

npm run example -- --files actionscript angular

Hint: By omitting the use of the space separated file names, the tool will create examples for all supported files.

npm run example -- --all

The above syntax will create examples for all supported files and folders.

Contributing with translations

We're looking for people willing to help us translate the extension's messages into all the languages that vscode supports.

We're currently supporting English, German, Italian, Russian, Simplified Chinese and Spanish. If you're willing to help with the translations of the missing languages take a look at #526 and get your hands dirty. We'll really appreciate it! ;P

Building the extension's source code

If you're willing to explore the extension source code and want to make it work you should run this:

npm install -d
npm run build

Building the extension's source code via docker

Make sure that you have docker installed.

docker build -t vscode-icons .
docker run --rm -it -v $PWD/dist:/app/dist vscode-icons

All of the files will be generated in the dist folder.

Change log

You can checkout all our changes in our change log.

If you feel that there's some icon missing please report it to the Github repository!

Versioning

vscode-icons follows Semantic Versioning 2.0.0.

Enjoy!