Skip to content

Latest commit

 

History

History
96 lines (66 loc) · 2.86 KB

README.md

File metadata and controls

96 lines (66 loc) · 2.86 KB

AppThinning

AppThinning

中文请戳

NPM version

Make app thinner. Help you find large files and compress png, gif, jpg, svg files.

AppThinning

Desktop Version

AppThinning

You can build from AppThinning-Desktop.

Features

  • Compress jpg, png, jpeg, gif, svg automatically.
  • Auto ignore compressed files.
  • Support imageOptim and tinyPng.
  • Custom file size limit range.

Requirement

  • Check the node environment, if not installed, you can visit https://nodejs.org/ to download the installation package.
node -v
  • Install imageOptim if you need use it to compress images.

Install

Easy way (install from npm package)

npm i appthinning -g

Another way (install from source)

git clone git@github.com:CatchZeng/AppThinning.git ~/Downloads/AppThinning && cd ~/Downloads/AppThinning && npm i && npm i -g

or

  • Clone this repo
git clone git@github.com:CatchZeng/AppThinning.git
  • Install dependencies
npm i
  • Install appthinning
cd path/to/AppThinning
npm i -g

Usage

appthinning -d "/Users/catchzeng/Desktop/test" -t "png|jpg" -s 1000 -m 2000 -c imageOptim
appthinning -h
   __ _   _ __    _ __   | |_  | |__   (_)  _ __    _ __   (_)  _ __     __ _
  / _` | | '_ \  | '_ \  | __| | '_ \  | | | '_ \  | '_ \  | | | '_ \   / _` |
 | (_| | | |_) | | |_) | | |_  | | | | | | | | | | | | | | | | | | | | | (_| |
  \__,_| | .__/  | .__/   \__| |_| |_| |_| |_| |_| |_| |_| |_| |_| |_|  \__, |
         |_|     |_|                                                    |___/
Usage: appthinning [options]

Options:
  -V, --version            output the version number
  -d, --dir <String>       project directory.
  -t, --types <String>     file types, default is jpg|png|jpeg|gif|svg.
  -s, --size <Number>      file size, the default is 100, 100 k
  -m, --maxSize<Number>    file max size, default is unlimited.
  -c, --compress <String>  compression types including imageOptim, tinyPng, default is imageOptim.
  -k, --key <String>       tinyPng key get from https://tinypng.com/developers. default is the DefaultTinyPngKey read from src/config/index.js. You can set it up to use tinyPng easily.
  -i, --ignore <String>    ignored files, default is read from appthinning_ignore file. split by '|', such as a.png|/user/ss/b.png|c.png .
  -h, --help               output usage information