webin / sublime-file-icons

Sublime file icons for improved visual grepping

Starting 3.0.0 zz File Icons will be renamed to A File Icon. I've found the way how to fix/implement #23, #24. I have no plans to add new icons in 3.0.0, it will bring only the new way of applying them. I apologize for any inconvenience caused.

This package adds file specific icons to Sublime Text for improved visual grepping. It's heavily inspired by Atom File Icons.

Its aims are:

• To be a tmPreferences storage for UI themes that support file icons.
• To provide file type icons for themes those don't (fully) support file icons.

If you have any problems, please search for a similar issue first, before creating a new one.

Also, check the list of known issues before doing so.

Users

Installation

Package Control

The easiest way to install is using Sublime's Package Control. It's listed as zz File Icons.

1. Open Command Palette using menu item Tools → Command Palette...
2. Choose Package Control: Install Package
3. Find zz File Icons and hit Enter

Download

1. Download the .zip
2. Unzip and rename folder to zz File Icons
3. Copy folder into Packages directory, which you can find using the menu item Preferences → Browse Packages...

Note: Don't forget to restart Sublime Text after installing this package.

Customization

You can change the color, opacity level and size of the icons by modifying your user preferences file, which you can find by:

• Preferences → Package Settings → File Icons → Settings,
• Choose File Icons: Settings in Command Palette.

Themes

If your theme supports zz File Icons you can choose what icons you want to use – provided by the theme (by default) or provided by the package. Otherwise this package adds its own icons only.

Themes that already have support of zz File Icons include:

• Boxy Theme
• Material Theme

Troubleshooting

If something goes wrong try to:

1. Open Command Palette using menu item Tools → Command Palette....
2. Choose File Icons: Clean Up.
3. Restart Sublime Text.

Wrong Icons

Sublime Text file type icons use syntax scopes. That's why icons for packages provided by the community require to be installed.

See the list of custom packages that you may need to install to see the right icon.

Missing Icons

In some cases you may see that some icons from your current theme are missing. You can:

• Request support for this package from the theme's developer.
• Submit a request to add missing icons if the theme already does.

More details here →

Sublime Linter Setup

This package adds some syntax aliases which Sublime Linter doesn't recognize. Just update your Sublime Linter settings, e.g.:

  "syntax_map": {
    "html (django)": "html",
    "html (rails)": "html",
    "html 5": "html",
    "javascript (babel)": "javascript",
    "javascript (gruntfile)": "javascript",
    "javascript (gulpfile)": "javascript",
    "json (bower)": "json",
    "json (npm)": "json",
    "json (settings)": "json",
    "magicpython": "python",
    "php": "html",
    "python django": "python",
    "pythonimproved": "python"
  },

Full list of syntax aliases can be found here.

Developers

Bring Support to Your Theme

If you are a theme developer and you want to support zz File Icons, you should:

• Remove all stuff related to the icon setup: .tmPreferences, .sublime-settings and .tmLanguage files.
• Rename all your icons to match these ones.
• Add .st-file-icons file to the root of your theme (this is how we check if the theme is supported).

Also see MIGRATION.md. It contains a list of tasks that you have to follow to support the next version of zz File Icons.

How It Works

In simple terms, zz File Icons does the following:

1. Searches all installed and supported themes.
2. Checks if themes that don't support it are already patched, if not
3. Patches them by:
   • Generating <theme-name>.sublime-theme files from a template.
   • Putting them into dist/zpatches/ directory.
4. For themes that support it, provides .tmPreferences files by default (user can override icons provided by the theme via "force_override": true)
5. After restarting Sublime Text, the patched themes will be updated to use the icons provided by zz File Icons

It does these steps when:

• You install it.
• Plugins are loaded.
• You change its preferences.

The real process is just a little bit more complex to minimize hard drive I/O.

Contributing

Want to contribute some code? Excellent! Read up on our guidelines.

Together we will make Sublime File Icons even better than it is today!

Resources

Colors

Colors are from the Boxy Theme icon color palette. They are bright because they should look good with most themes. However you can change color and opacity level of all icons. See customization.

Icons

This package contains icons provided by:

• Atom File Icons
• Boxy Theme
• Devicons
• Font Awesome
• Font Mfizz
• Icomoon
• Octicons

Source icons are provided in SVG format (Sublime Text doesn't currently support it). We convert them to @1x, @2x and @3x PNG assets before each release via a custom gulp task.

Rasterized icons can be found in dist/zpatches folder.

Change Log

See CHANGELOG.md.

Known Issues

1. This package requires you to restart Sublime Text for the applied icons to take effect when:
   • you install it,
   • you change its preferences,
   • you install a new theme that should be patched.
2. The icons for custom packages need to be installed. E.g. if you want to see SCSS icon you should install one of the SCSS syntax packages.

Share The Love

I've put a lot of time and effort into making Sublime File Icons awesome. If you love it, you can buy me a coffee. I promise it will be a good investment 😉.

Donate with: Patreon.