Skip to content

Commit

Permalink
Expose own version as sharp.versions.sharp #3471
Browse files Browse the repository at this point in the history
  • Loading branch information
lovell committed Jan 17, 2023
1 parent c150263 commit 02f855d
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/api-utility.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## versions
An Object containing the version numbers of libvips and its dependencies.
An Object containing the version numbers of sharp, libvips and its dependencies.


**Example**
Expand Down
3 changes: 3 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ Requires libvips v8.14.0
[#3470](https://github.com/lovell/sharp/pull/3470)
[@ejoebstl](https://github.com/ejoebstl)

* Expose sharp version as `sharp.versions.sharp`.
[#3471](https://github.com/lovell/sharp/issues/3471)

* Respect `fastShrinkOnLoad` resize option for WebP input.
[#3516](https://github.com/lovell/sharp/issues/3516)

Expand Down
3 changes: 2 additions & 1 deletion lib/utility.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ const interpolators = {
};

/**
* An Object containing the version numbers of libvips and its dependencies.
* An Object containing the version numbers of sharp, libvips and its dependencies.
* @member
* @example
* console.log(sharp.versions);
Expand All @@ -54,6 +54,7 @@ let versions = {
try {
versions = require(`../vendor/${versions.vips}/${platformAndArch}/versions.json`);
} catch (_err) { /* ignore */ }
versions.sharp = require('../package.json').version;

/**
* An Object containing the platform and architecture
Expand Down
4 changes: 3 additions & 1 deletion test/unit/util.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
'use strict';

const assert = require('assert');
const semver = require('semver');
const sharp = require('../../');

describe('Utilities', function () {
Expand Down Expand Up @@ -137,7 +138,8 @@ describe('Utilities', function () {
describe('Versions', function () {
it('Contains expected attributes', function () {
assert.strictEqual('object', typeof sharp.versions);
assert.strictEqual('string', typeof sharp.versions.vips);
assert(semver.valid(sharp.versions.vips));
assert(semver.valid(sharp.versions.sharp));
});
});

Expand Down

0 comments on commit 02f855d

Please sign in to comment.