vscode-icons

Bring icons to your VS Code.

IMPORTANT NOTE

As you all know, VSCode finally supports File and Folder icons in an official way. 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.

I would like to thank the VSCode team for their support during this summer (2016) in terms of migrating this extension and preparing the new contribution point (especially @aeschli for his good disposition).

I would also like to thank the whole community for their support: bringing in ideas, collaborating and making this path easy. And I would also like to stress the great help that @jens1o has provided to the project. He's amazing! And he's only 14!! :D Thanks, truly!

State of the extension

Release 5.0.0 introduces the ability for users to customize the icons without having to inject anything into the Visual Studio Code's code.

This is a huge step again to allow the users to fully customize how the icons look like and how they can be associated to any extension at will.

Custom Icon associations 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. 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

---

New Year release

We're happy to annouce that the extension now provides custom icons and some icon presets like Angular, Official JS Logo, Official TS Logo and Hide Folders. With this release you will be able to completely tune the way the icons look! Please, take a look at the corresponding section to know more about how to make this work.

Besides that, @JimiC along with @ginfuru are continuing to contribute to the massive svg icon conversion and providing new quality icons.

---

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. ;)

---

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.

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

You have 4 different presets at the moment:

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

These 4 different 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 Folder Icons Visibility (User Level): This command will enable/disable the Visibility of the 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

Fine tuning

Along with the commands we introduced before you will find two 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.
• 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" }
]

// Disabling an already supported icon.
// note: this is, indeed, the functionality that presets are leveraging.
"vsicons.associations.files": [
  { "icon": "js", "extensions": [], "format": "svg", "disable": 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" }
]

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>@2x.svg
• Folders: folder_type_<value_of_icon_property>@2x.svg & folder_type_<value_of_icon_property>_opened@2x.svg
• Default Files & Folders: default_<value_of_icon_property>@2x.svg

Note that folders must have two icons!!

See here the supported icon extensions.

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.

Configuration

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

{
  "vsicons.dontShowNewVersionMessage": false
}

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!

Enjoy!