Skip to content

Commit fb331b1

Browse files
authored
feat: add new config system and update icon design (#5)
* feat: add new config system * chore: update package config and dependencies * refactor: add static dir * docs: update readme * chore: update config descriptions * chore: add build scripts * chore: update config props * chore: update build scripts * refactor: update utils * types: improve extension and theme types * chore: update pnpm-lock.yaml * chore: update theme build scripts * types: update config types * refactor: improve theme creation * feat: add new config system * refactor: change extension main entry * chore: bump version to 1.5.0 * chore: update build theme script * refactor: update utils * chore: add commands * refactor: update extension main entry * feat: add extension meta * feat: add extension messages notifications * feat: add extension config system * feat: add extension command system * chore: update dependencies * refactor: improve icon-map theme generator * refactor: update theme icon definitions * refactor: remove icons * docs: update readme info * docs: update readme info * feat: improve theme exts and add new icons * types: update config types * refactor: improve theme config patterns * feat: add opacity config and command * docs: add info for opacity settings * refactor: update theme * chore: update dependencies * chore: update dependencies * chore: update dependencies * chore: update dependencies * feat: add new media design * feat: add new hypernym-icons font * feat: add new icon design * docs: update cover and extension info
1 parent a7866cb commit fb331b1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+1802
-677
lines changed

README.md

Lines changed: 195 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<img src="https://raw.githubusercontent.com/hypernym-studio/vscode-icons/main/media/cover.gif" alt="Hypernym Icons Cover" />
2+
<img alt="Hypernym Icons" src="./media/cover.png">
33
</p>
44

55
<h1 align="center">Hypernym Icons</h1>
@@ -8,39 +8,223 @@
88

99
<p align="center">
1010
<a href="https://github.com/hypernym-studio/vscode-icons">Repository</a>
11-
<span>+</span>
11+
<span></span>
1212
<a href="https://github.com/hypernym-studio/vscode-icons/releases">Releases</a>
13-
<span>+</span>
13+
<span></span>
1414
<a href="https://github.com/hypernym-studio/vscode-icons/discussions">Discussions</a>
15-
<span>+</span>
15+
<span></span>
1616
<a href="https://marketplace.visualstudio.com/items?itemName=hypernym-studio.hypernym-icons">Marketplace</a>
1717
</p>
1818

19+
<br>
20+
21+
## Features
22+
23+
- Adds minimalistic modern style
24+
- Dynamically infers colors based on state
25+
- Allows additional customization via options
26+
- Provides special commands
27+
28+
## Extension
29+
1930
<p align="center">
20-
<strong>Hypernym Studio</strong>
31+
<img alt="Hypernym Icons" src="./media/icons.png">
2132
</p>
2233

23-
<br>
34+
The brand new carefully designed `Hypernym Icons` theme provides an improved, modern and more eye-pleasing minimalistic look.
2435

25-
## Extension
36+
Extension now supports an additional customization system that allows you to change the color, opacity, and size of icons and folders.
2637

27-
This icon theme is heavily inspired by the latest modern trends and follows an ultra-minimalistic style. Also, the project is built with TypeScript under the hood so it can be very easily extended in dev mode.
38+
The icons are merged into a custom font because this brings more flexibility such as dynamically inferring icon colors on hover and active states with adjustable icon sizes.
39+
40+
It also implements special commands for easier usage from VSCode Command Palette.
2841

2942
## Installation
3043

3144
### Marketplace
3245

33-
Search for `Hypernym Icons` in the official VSCode Marketplace and install the extension.
46+
Install [Hypernym Icons](https://marketplace.visualstudio.com/items?itemName=hypernym-studio.hypernym-icons) extension from the official VSCode Marketplace.
3447

3548
### Manual
3649

50+
If necessary, the extension can be installed manually (optional).
51+
3752
1. Download the [latest version](https://github.com/hypernym-studio/vscode-icons/releases/latest) of the extension.
38-
2. Open the Command Palette dropdown (⇧⌘P).
53+
2. Open the **Command Palette** dropdown (**⇧⌘P**).
3954
- Run the `Extensions: Install from VSIX` command.
4055
- Select previously downloaded `.vsix` extension file.
4156
3. After installation, simply activate the extension.
4257

43-
<sub>Read the official <a href="https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix">guide</a> to learn more about manual installation.</sub>
58+
<sub>Read the official VSCode <a href="https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix">guide</a> to learn more about manual installation.</sub>
59+
60+
## Options
61+
62+
It is now possible to change the color, opacity and size of the icons and completely change the appearance as needed.
63+
64+
All options are optional and will fall back to defaults if not specified.
65+
66+
<sub>See the official VSCode <a href="https://code.visualstudio.com/docs/getstarted/settings">settings</a> section for more info.</sub>
67+
68+
### Explorer Arrows
69+
70+
- Type: `boolean`
71+
- Default: `true`
72+
73+
Specifies the visibility of the Explorer arrows.
74+
75+
```ts
76+
// settings.json
77+
78+
{
79+
"hypernym-icons.hidesExplorerArrows": true
80+
}
81+
```
82+
83+
### Folder Color
84+
85+
- Type: `string`
86+
- Default: `undefined`
87+
88+
Specifies a custom color for folder icons. Accepts valid HEX color format.
89+
90+
```ts
91+
// settings.json
92+
93+
{
94+
"hypernym-icons.folders.color": "#fff" // #ffffff
95+
}
96+
```
97+
98+
### Folder Opacity
99+
100+
- Type: `string`
101+
- Default: `undefined`
102+
103+
Specifies a custom opacity for folder icons. Accepts a percentage size format.
104+
105+
```ts
106+
// settings.json
107+
108+
{
109+
"hypernym-icons.folders.opacity": "60%" // 0-100%
110+
}
111+
```
112+
113+
### Folder Size
114+
115+
- Type: `string`
116+
- Default: `undefined`
117+
118+
Specifies a custom size for folder icons. Accepts a percentage size format.
119+
120+
```ts
121+
// settings.json
122+
123+
{
124+
"hypernym-icons.folders.size": "130%"
125+
}
126+
```
127+
128+
### Icon Color
129+
130+
- Type: `string`
131+
- Default: `undefined`
132+
133+
Specifies a custom color for all icons. Accepts valid HEX color format.
134+
135+
```ts
136+
// settings.json
137+
138+
{
139+
"hypernym-icons.icons.color": "#fff" // #ffffff
140+
}
141+
```
142+
143+
### Icon Opacity
144+
145+
- Type: `string`
146+
- Default: `undefined`
147+
148+
Specifies a custom opacity for all icons. Accepts a percentage size format.
149+
150+
```ts
151+
// settings.json
152+
153+
{
154+
"hypernym-icons.icons.opacity": "60%" // 0-100%
155+
}
156+
```
157+
158+
### Icon Size
159+
160+
- Type: `string`
161+
- Default: `undefined`
162+
163+
Specifies a custom size for all icons. Accepts a percentage size format.
164+
165+
```ts
166+
// settings.json
167+
168+
{
169+
"hypernym-icons.icons.size": "130%"
170+
}
171+
```
172+
173+
## Commands
174+
175+
Extension includes a set of specific `commands` that can simplify customization.
176+
177+
1. Open the **Command Palette** dropdown (**⇧⌘P**).
178+
2. Type `Hypernym Icons` to see a list of all available commands.
179+
3. Run the selected command.
180+
181+
<sub>See the official VSCode <a href="https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette">commands</a> section for more info.</sub>
182+
183+
### Toggle Explorer Arrows
184+
185+
- Command: `Hypernym Icons: Toggle Explorer Arrows`
186+
187+
Specifies the visibility of the explorer arrows.
188+
189+
### Set Folder Color
190+
191+
- Command: `Hypernym Icons: Set Folder Color`
192+
193+
Specifies a custom color for folder icons. Accepts valid HEX color format.
194+
195+
### Set Folder Opacity
196+
197+
- Command: `Hypernym Icons: Set Folder Opacity`
198+
199+
Specifies a custom opacity for folder icons. Accepts a percentage size format.
200+
201+
### Set Folder Size
202+
203+
- Command: `Hypernym Icons: Set Folder Size`
204+
205+
Specifies a custom size for folder icons. Accepts a percentage size format.
206+
207+
### Set Icon Color
208+
209+
- Command: `Hypernym Icons: Set Icon Color`
210+
211+
Specifies a custom color for all icons. Accepts valid HEX color format.
212+
213+
### Set Icon Opacity
214+
215+
- Command: `Hypernym Icons: Set Icon Opacity`
216+
217+
Specifies a custom opacity for all icons. Accepts a percentage size format.
218+
219+
### Set Icon Size
220+
221+
- Command: `Hypernym Icons: Set Icon Size`
222+
223+
Specifies a custom size for all icons. Accepts a percentage size format.
224+
225+
### Reset Commands
226+
227+
It is also possible to reset settings via commands if they are input type. Simply select a command, type `default` and run it. This will reset the option to its default value.
44228

45229
## Community
46230

icons/10_info.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

icons/11_json.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

icons/12_style.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

icons/13_terminal.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

icons/14_verified.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

icons/1_config.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

icons/2_copyright.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

icons/3_file.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

icons/4_folder.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)