You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+72-28Lines changed: 72 additions & 28 deletions
Original file line number
Diff line number
Diff line change
@@ -22,11 +22,12 @@
22
22
[](https://isitmaintained.com/project/vscode-icons/vscode-icons"Average time to resolve an issue")
23
23
[](https://isitmaintained.com/project/vscode-icons/vscode-icons"Percentage of issues still open")
24
24
25
-
Bring icons to your [Visual Studio Code](https://code.visualstudio.com/) (**minimum supported version: `1.8.1`**)
25
+
Bring icons to your [Visual Studio Code](https://code.visualstudio.com/) (**minimum supported version: `1.8.1`**)
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](https://twitter.com/chrisdias): ["Rebellion. Mutiny. Revolt. Uprising."](https://code.visualstudio.com/blogs/2016/09/08/icon-themes) if you want to learn the history about this plugin and how finally icons landed in VSCode.
31
32
32
33
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](https://github.com/aeschli) (VSCode Team) and especially from [@jens1o](https://github.com/jens1o) (community member), which turned out to be a 14-year-old amazing coder!
@@ -36,19 +37,23 @@ Later on, until the present moment, [@JimiC](https://github.com/JimiC) entered t
36
37
I'm very happy to be part of this team, along with [@jens1o](https://github.com/jens1o) and [@JimiC](https://github.com/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
37
38
38
39
## Main Contributors
40
+
39
41
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.
If you're willing to collaborate with us feel free to join our [Github repository](https://github.com/vscode-icons/vscode-icons/). ;)
48
50
49
51
---
50
52
51
53
## State of the extension
54
+
55
+
[@JimiC](https://github.com/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](https://github.com/vscode-icons/vscode-icons/blob/master/README.md#custom-icons).
56
+
52
57
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](https://github.com/vscode-icons/vscode-icons#configuration) section for more details.
53
58
54
59
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.
@@ -57,59 +62,70 @@ We're talking about a major improvement over this feature. It will help you to e
57
62
58
63
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](https://github.com/vscode-icons/vscode-icons#contributing-with-translations) section if you want to know more or contribute.
59
64
60
-
We also keep supporting the ability for users to customize the icons without having to inject anything into the `Visual Studio Code`'s code.
65
+
We also keep supporting the ability for users to customize the icons without having to inject anything into the `Visual Studio Code`'s code.
61
66
62
67
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.
63
68
64
69
`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](https://github.com/Microsoft/vscode/issues/12493#issuecomment-249117649) 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](https://github.com/vscode-icons/vscode-icons/issues/328).
65
70
71
+
<!-- markdownlint-disable MD036 -->
66
72
**Thank you all for your kind support. We will continue to try to improve the extension to make it more user friendly :D**
73
+
<!-- markdownlint-enable MD036 -->
67
74
68
-
----
75
+
---
69
76
70
77
## Installation
78
+
71
79
Some people have reported that they cannot find the extension when they insert the installation command:
72
-
```
80
+
81
+
```sh
73
82
ext install vscode-icons
74
83
```
75
84
76
85
If you're in the same position try this:
86
+
77
87
```sh
78
88
ext install icons
79
89
# or
80
90
ext install "vscode-icons"
81
91
```
82
92
83
93
## Enable the extension
84
-
Go to **File > Preferences > File Icon Theme > VSCode Icons**.
85
94
86
-
(Note on OSX it is **Code > Preferences > File Icon Theme > VSCode Icons**.)
95
+
Go to **File > Preferences > File Icon Theme > VSCode Icons**.
87
96
97
+
(Note on OSX it is **Code > Preferences > File Icon Theme > VSCode Icons**.)
88
98
89
99
## List of supported icons
100
+
90
101
The list is slowly growing. If you want to check what icons are currently supported take a look [here](https://github.com/vscode-icons/vscode-icons/blob/master/src/icon-manifest/supportedExtensions.ts). If you feel that there's some icon missing please let me know through [the issues section of the Github's repo](https://github.com/vscode-icons/vscode-icons/issues).
91
102
92
103
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
93
104
94
105
## List of supported folder icons
106
+
95
107
If you want to check which folder icons are currently supported take a look [here](https://github.com/vscode-icons/vscode-icons/blob/master/src/icon-manifest/supportedFolders.ts). As usual, if you want to add an icon submit a PR or [raise a Github issue](https://github.com/vscode-icons/vscode-icons/issues).
96
108
97
109
## Configuration
110
+
98
111
If you don't want to see the `new version` message every time the extension updates, then set this configuration setting:
112
+
99
113
```json
100
114
{
101
115
"vsicons.dontShowNewVersionMessage": true
102
116
}
103
117
```
104
118
105
119
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:
The extension gives you the ability to change how the icons look or even what icons are associated to each extension.
114
130
115
131
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.
@@ -121,6 +137,7 @@ But, how does this work?
121
137
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.
122
138
123
139
### Presets
140
+
124
141
There are several different `presets`:
125
142
126
143
-`vsicons.presets.angular` (false by default)
@@ -148,6 +165,7 @@ Note that some of the `preset commands` will modify your `settings` at a differe
148
165
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
149
166
150
167
### Project detection
168
+
151
169
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.
152
170
153
171
You will be presented with four choices:
@@ -163,6 +181,7 @@ There are two different `projectDetection` settings associated with this feature
163
181
-`vsicons.projectDetection.disableDetect` (false by default)
164
182
165
183
### Fine tuning
184
+
166
185
Along with the commands we introduced above, you will find some more (just press `F1` and type `icons`):
167
186
168
187
-`Apply Icons Customization`: This command will regenerate the `Icons manifest` with your customizations and restart the IDE for the changes to take effect.
@@ -194,7 +213,8 @@ Along with the previous arrays you will have 4 more settings available that will
@@ -253,8 +274,8 @@ In order to place your custom icons you will have to create a specific folder. D
253
274
254
275
`<Code Folder>` refers to the name of the folder of VSCode depending on the version:
255
276
256
-
>-`Code` for the stable version.
257
-
>-`Code - Insiders` for the insiders version.
277
+
-`Code` for the stable version.
278
+
-`Code - Insiders` for the insiders version.
258
279
259
280
Once you have created the folder you can put all your custom icons there. But, again, they have to follow `vscode-icons` naming conventions:
260
281
@@ -266,7 +287,18 @@ Once you have created the folder you can put all your custom icons there. But, a
266
287
267
288
See [here the supported file extensions for an icon](https://github.com/vscode-icons/vscode-icons/blob/master/src/models/extensions/fileFormat.ts).
268
289
290
+
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.
291
+
292
+
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.
293
+
294
+
**Note that the name of the folder containing the icons must be `vscode-custom-icons`**.
295
+
296
+
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.
297
+
298
+
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/`.
299
+
269
300
#### Optional Angular icons
301
+
270
302
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`.
271
303
272
304
In order to enable them just add this to your settings:
@@ -284,69 +316,81 @@ In order to enable them just add this to your settings:
284
316
**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.
285
317
286
318
## Contributing with icons
319
+
287
320
If you're willing to create an icon just follow this few conventions:
288
321
289
322
1. We're using SVG or PNG-24 but we prefer SVG if possible.
290
-
2. 32x32
291
-
3. 2px margin (but see [#195](https://github.com/vscode-icons/vscode-icons/pull/195))
292
-
4. Center the icon, but lower it a pixel.
293
-
5. It must be transparent.
323
+
1. 32x32
324
+
1. 2px margin (but see [#195](https://github.com/vscode-icons/vscode-icons/pull/195))
325
+
1. Center the icon, but lower it a pixel.
326
+
1. It must be transparent.
294
327
295
328
## Preview of icons
296
-
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.
329
+
330
+
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.
297
331
298
332
The syntax follows the pattern:
299
-
```
333
+
334
+
```sh
300
335
npm run example -- [flag] [space separated file names | space separated folder names]
301
336
```
302
337
303
338
Supported flags are `--all`, `--folders`, `--files`.
304
339
305
-
#### Syntax examples:
306
-
```
340
+
### Syntax examples
341
+
342
+
```sh
307
343
npm run example -- --folders bower css
308
344
```
309
345
310
-
**Hint:** By omitting the use of the space separated folder names, the tool will create examples for all supported folders.
346
+
**Hint:** By omitting the use of the space separated folder names, the tool will create examples for all supported folders.
311
347
312
-
```
348
+
```sh
313
349
npm run example -- --files actionscript angular
314
350
```
315
351
316
352
**Hint:** By omitting the use of the space separated file names, the tool will create examples for all supported files.
317
353
318
-
```
354
+
```sh
319
355
npm run example -- --all
320
356
```
321
357
322
358
The above syntax will create examples for all supported files and folders.
323
359
324
360
## Contributing with translations
361
+
325
362
We're looking for people willing to help us translate the extension's messages into [all the languages that `vscode` supports](https://code.visualstudio.com/docs/customization/locales).
326
363
327
364
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](https://github.com/vscode-icons/vscode-icons/issues/526) and get your hands dirty. We'll really appreciate it! ;P
328
365
329
366
## Building the extension's source code
367
+
330
368
If you're willing to explore the extension source code and want to make it work you should run this:
331
-
```
369
+
370
+
```sh
332
371
npm install -d
333
372
npm run build
334
373
```
335
374
336
375
### Building the extension's source code via docker
376
+
337
377
Make sure that you have docker installed.
338
-
```
378
+
379
+
```sh
339
380
docker build -t vscode-icons .
340
381
docker run --rm -it -v $PWD/dist:/app/dist vscode-icons
341
382
```
383
+
342
384
All of the files will be generated in the `dist` folder.
343
385
344
-
## Change log
386
+
## Change log
387
+
345
388
You can checkout all our changes in our [change log](https://github.com/vscode-icons/vscode-icons/blob/master/CHANGELOG.md).
346
389
347
390
If you feel that there's some icon missing please report it to the Github repository!
0 commit comments