Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(readme): add a note on how to pass arguments in [0,1] range #28

Closed
wants to merge 2 commits into from
Closed

docs(readme): add a note on how to pass arguments in [0,1] range #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cecf392
Readme tweaks
sindresorhus Jul 5, 2020
a4091bf
docs(readme): add a note on how to pass arguments in [0,1] range
antongolub May 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 3 additions & 18 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,15 @@
# imagemin-cli [![Build Status](https://travis-ci.org/imagemin/imagemin-cli.svg?branch=master)](https://travis-ci.org/imagemin/imagemin-cli)
# imagemin-cli [![Build Status](https://travis-ci.com/imagemin/imagemin-cli.svg?branch=master)](https://travis-ci.com/github/imagemin/imagemin-cli)

> Minify images

---

<div align="center">
<sup>Gumlet is helping make open source sustainable by sponsoring Sindre Sorhus.</sup>
<a href="https://www.gumlet.com">
<div>
<img src="https://sindresorhus.com/assets/thanks/gumlet-logo.svg" width="300"/>
</div>
<sup><b>Optimised Image Delivery made simple</b></sup>
</a>
</div>

---

*Issues with the output should be reported on the `imagemin` [issue tracker](https://github.com/imagemin/imagemin/issues).*


## Install

```
$ npm install --global imagemin-cli
```


## Usage

```
Expand All @@ -45,9 +29,10 @@ $ imagemin --help
$ imagemin foo.png > foo-optimized.png
$ cat foo.png | imagemin > foo-optimized.png
$ imagemin foo.png --plugin=pngquant > foo-optimized.png
$ imagemin foo.png --plugin.pngquant.quality={0.1,0.2} > foo-optimized.png
$ imagemin foo.png --plugin.pngquant.quality={.5,1} > foo-optimized.png
$ imagemin foo.png --plugin.webp.quality=95 --plugin.webp.preset=icon > foo-icon.webp
```
⚠️ To pass an argument as a number in `[0, 1]` range trim the first digit: `--param=0.05` → `--param=.05`

## Related

Expand Down
5 changes: 3 additions & 2 deletions test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,10 @@ test('throw on missing plugins', async t => {
test('support plugin options', async t => {
const input = await readFile('fixtures/test.png');

const {stdout: data} = await execa('./cli.js', ['--plugin.pngquant.dithering=1'], {
const {stdout: data} = await execa('./cli.js', ['--plugin.pngquant.dithering=1', '--plugin.pngquant.quality={.1,.4}'], {
input,
encoding: 'buffer'
encoding: 'buffer',
shell: true
});

const {stdout: compareData} = await execa('./cli.js', {
Expand Down