easy-tinypng-cli
A cli can automatically compress images with tinypng.com.
Why
When delevoping a website, we often need to compress images to reduce the network io cast.In normal way, we may need four steps to compress images:
- download images from the internet
- upload the image to tinypng.com
- download the compressed image from tinypng.com
- copy the compressd images into our workspace
The above steps are very time-consuming. So !!! this cli can automatically compress images in background process. It will watch the fileSystem changes to auto handle if there are any images that need to be compressed.
π
Features
-
πΎ Support configuration file -
π Multiple directory watching -
β¨ Support HMR -
π¦ Auto detection nested directory images and compress them -
π Background process will not block the main thread -
π»ββοΈ Compressed record logging to avoid repeated compression
Usage
Install
pnpm add -D easy-tinypng-cli
Config tiny.config.ts
-
APIKey (required) : the API key of tinypng.com, you can get it from tinypng.com
-
targetDir (required) : the top directory that you want to compress images
import { defineTinyConfig } from 'easy-tinypng-cli/utils'
export default defineTinyConfig({
configs: [
{
targetDir: './src/images',
},
],
APIKey: 'xxxxxxxxx',
})
Add Script in package.json
{
"scripts": {
"optimizeImages": "tiny"
}
}
or
{
"scripts": {
"optimizeImages": "tiny --once" //only compress once no watching files change
}
}
Author
sudongyuer email:[email protected]
![[ImgBot] Optimize images](https://avatars.githubusercontent.com/in/4706?v=4)
144 Jan 8, 2023
22 Aug 11, 2022
585 Dec 31, 2022
596 Jul 27, 2022
7.1k Jan 2, 2023
399 Jan 3, 2023
8 Aug 3, 2022
3.5k Dec 30, 2022
8 May 1, 2023
89 Dec 20, 2022
9 Jul 7, 2022
7 May 17, 2022
7 Sep 13, 2022
15 Aug 6, 2022
17 Aug 17, 2022
4 Jul 10, 2022
5 Nov 12, 2022
7 Sep 22, 2022