Skip to content

andi1984/vscode-tinypng

Repository files navigation

TinyPNG API VSCode Extension

This extension uses the API provided byTinyPNG to compress your JP(E)G and PNG images directly inside VSCode!

Installs Downloads Version

Features

Compression of single files

Inside the file explorer, use the entry in the context menu to compress a single file.

Context menu for single file compression

Compression of folders

As an addition to compress single files you can also compress all images inside a complete folder — including subfolders — aswell!

Select a folder and press the corresponding TinyPNG context menu entry.

Context menu for a complete folder

Requirements

You need to have an active TinyPNG API key, which you can find in your TinyPNG Developer Dashboard. You can provide the API key in your settings, see below.

!!!Be aware of TinyPNG API's pricing model! All compressions you do via this extension are counting in your account's compression count! You can see your currently and monthly compression count via command you can see below or inside the dashboard!!!

Compression Count command

Extension Settings

This extension contributes the following settings:

  • tinypng.apiKey: Your own TinyPNG API Key
  • tinypng.forceOverwrite: Force the extension to overwrite the source file with the compressed one.
  • tinypng.compressedFilePostfix: Postfix string that is appended to the compressed file, unless forceOverwrite is enabled. (default: ".min")

Known Issues/Limitations

Currently not supported API features are:

  • Image resizing
  • Preserving metadata
  • Saving compressed images to Amazon S3.

Note: This extension uses the TinyPNG own NodeJS Tinify API client. Thus issues you might notice in the extension are actual issues of this library.

Release Notes

Release notes can be found in the changelog.

Release process

  • Eventually vsce login
  • vsce publish
  • Updating Changelog via github_changelog_generator -u andi1984 -p vscode-tinypng -t <token>

Enjoy!