New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
spritesmith
Advanced tools
spritesmith - npm Package Compare versions
Comparing version 1.0.1 to 1.0.2
| # spritesmith changelog | ||
| 1.0.2 - Moved to consistent documentation bullets with `grunt-spritesmith` and `gulp.spritesmith` | ||
| 1.0.1 - Added attribution to README | ||
@@ -3,0 +5,0 @@ |
| { | ||
| "name": "spritesmith", | ||
| "description": "Utility that takes images and creates a spritesheet with JSON sprite data", | ||
| "version": "1.0.1", | ||
| "version": "1.0.2", | ||
| "homepage": "https://github.com/Ensighten/spritesmith", | ||
@@ -6,0 +6,0 @@ "author": { |
@@ -86,37 +86,38 @@ # spritesmith [](https://travis-ci.org/Ensighten/spritesmith) | ||
| - params `Object` Container for paramters | ||
| - params.src `String[]` Array of filepaths for images to include in spritesheet | ||
| - params.padding `Number` Padding to use between images | ||
| - params `Object` - Container for paramters | ||
| - src `String[]` - Array of filepaths for images to include in spritesheet | ||
| - padding `Number` - Padding to use between images | ||
| - For example if `2` is provided, then there will be a `2px` gap to the right and bottom between each image | ||
| - params.engine `String|Object` Optional engine override to use | ||
| - engine `String|Object` - Optional engine override to use | ||
| - By default we use [`pixelsmith`][], a node-based `spritesmith` engine | ||
| - For more engine options, see the [Engines section](#engines) | ||
| - params.engineOpts `Object` Options to pass through to engine for settings | ||
| - engineOpts `Object` - Options to pass through to engine for settings | ||
| - For example `phantomjssmith` accepts `timeout` via `{engineOpts: {timeout: 10000}}` | ||
| - See your engine's documentation for available options | ||
| - params.exportOpts `Mixed` Options to pass through to engine for export | ||
| - exportOpts `Mixed` - Options to pass through to engine for export | ||
| - For example `gmsmith` supports `quality` via `{exportOpts: {quality: 75}}` | ||
| - See your engine's documentation for available options | ||
| - params.algorithm `String` Optional algorithm to pack images with | ||
| - algorithm `String` - Optional algorithm to pack images with | ||
| - By default we use `binary-tree` which packs images as efficiently as possible | ||
| - For more algorithm options, see the [Algorithms section](#algorithms) | ||
| - params.algorithmOpts `Object` Optional algorithm options to pass through to algorithm for layout | ||
| - algorithmOpts `Object` - Optional algorithm options to pass through to algorithm for layout | ||
| - For example `top-down` supports ignoring sorting via `{algorithmOpts: {sort: false}}` | ||
| - See your algorithm's documentation for available options | ||
| - https://github.com/twolfson/layout#algorithms | ||
| - callback `Function` Error-first function that receives compiled spritesheet and map | ||
| - callback `Function` - Error-first function that receives compiled spritesheet and map | ||
| - `callback` should have signature `function (err, result)` | ||
| - err `Error|null` If an error occurred, this will be it | ||
| - result `Object` Container for result items | ||
| - result.image `String` Binary string representation of image | ||
| - result.coordinates `Object` Map from filepath to coordinate information between original sprite and spritesheet | ||
| - err `Error|null` - If an error occurred, this will be it | ||
| - result `Object` - Container for result items | ||
| - image `String` - Binary string representation of image | ||
| - coordinates `Object` - Map from filepath to coordinate information between original sprite and spritesheet | ||
| - `filepath` will be the same as provided in `params.src` | ||
| - result.coordinates[filepath] `Object` Container for coordinate information | ||
| - result.coordinates[filepath].x `Number` Horizontal position of top-left corner of original sprite on spritesheet | ||
| - result.coordinates[filepath].y `Number` Vertical position of top-left corner of original sprite on spritesheet | ||
| - result.coordinates[filepath].width `Number` Width of original sprite | ||
| - result.coordinates[filepath].height `Number` Height of original sprite | ||
| - result.properties `Object` Container for information about spritesheet | ||
| - result.properties.width `Number` Width of the spritesheet | ||
| - result.properties.height `Number` Height of the spritesheet | ||
| - [filepath] `Object` - Container for coordinate information | ||
| - For those keeping track, this is `result.coordinates[filepath]` | ||
| - x `Number` - Horizontal position of top-left corner of original sprite on spritesheet | ||
| - y `Number` - Vertical position of top-left corner of original sprite on spritesheet | ||
| - width `Number` - Width of original sprite | ||
| - height `Number` - Height of original sprite | ||
| - properties `Object` - Container for information about spritesheet | ||
| - width `Number` - Width of the spritesheet | ||
| - height `Number` - Height of the spritesheet | ||
@@ -123,0 +124,0 @@ [`pixelsmith`]: https://github.com/twolfson/pixelsmith |
No alert changes
Improved metrics
- Number of lines in readme file
- increased by0.29%
342
Worsened metrics
- Total package byte prevSize
- decreased by-0.02%
81947
No dependency changes