Skip to content

#93 - Allow user to specify binary mirror #94

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

Closed
wants to merge 2 commits into from
Closed

#93 - Allow user to specify binary mirror #94

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
011c8f3
#93 - Allow user to specify binary mirror
ConfuddledPenguin May 25, 2019
38c2634
enuring code is correctly formatted
ConfuddledPenguin May 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,15 @@ const path = require('path');
const BinWrapper = require('bin-wrapper');
const pkg = require('../package.json');

const url = `https://raw.githubusercontent.com/imagemin/jpegtran-bin/v${pkg.version}/vendor/`;
// The default location that missing binaries are fetched from
const defaultDownloadUrl = 'https://raw.githubusercontent.com/imagemin/jpegtran-bin/';
const defaultDownloadDir = 'vendor/';

// If we detect that a different download location has been set in the environment shall use it over the default
const downloadUrl = process.env.IMAGEMIN__JPEGTRAN_BIN__MIRROR_URL ? process.env.IMAGEMIN__JPEGTRAN_BIN__MIRROR_URL : defaultDownloadUrl;
const downloadDir = process.env.IMAGEMIN__JPEGTRAN_BIN__CUSTOM_DIR ? process.env.IMAGEMIN__JPEGTRAN_BIN__CUSTOM_DIR : defaultDownloadDir;

const url = `${downloadUrl}v${pkg.version}/${downloadDir}`;

module.exports = new BinWrapper()
.src(`${url}macos/jpegtran`, 'darwin')
Expand Down
25 changes: 25 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,31 @@ You probably want [`imagemin-jpegtran`](https://github.com/imagemin/imagemin-jpe
$ npm install --save jpegtran-bin
```

### Customizing the Download Mirror

By default this package will fetch the libjpeg-turbo binary from this repository during install, if you need to customise this behavour it can be overridden using enviroment variables.

The following options are available:

Environment Variable | Description | Default
-----------------------------------| -------------------------------------| --------------------------------------------------------
IMAGEMIN__JPEGTRAN_BIN__MIRROR_URL | Specifies the location of the mirror | https://raw.githubusercontent.com/imagemin/jpegtran-bin/
IMAGEMIN__JPEGTRAN_BIN__CUSTOM_DIR | Specifies a custom folder if needed | vendor/

The resulting mirror location is composed as follows:

```js
url = IMAGEMIN__JPEGTRAN_BIN__MIRROR_URL + {library version} + IMAGEMIN__JPEGTRAN_BIN__CUSTOM_DIR + {platform information}
```

For instance with the below set:

```
IMAGEMIN__JPEGTRAN_BIN__MIRROR_URL = 'https://www.example.com/private/mirror/'
IMAGEMIN__JPEGTRAN_BIN__CUSTOM_DIR = 'binaries/'
```

Would result in `https://www.example.com/private/mirror/v4.0.0/binaries/win/x64/jpegtran.exe` on 64 bit Windows.

## Usage

Expand Down