spritesmith - npm Package Compare versions

Comparing version 0.18.0 to 0.19.0

CHANGELOG.md

 # spritesmith changelog
+0.19.0 - Added ability to turn off image sorting via `imageOpts`
+
 0.18.0 - Upgraded `gmsmith` to implicitly find `imagemagick`
@@ -3,0 +5,0 @@

package.json

 {
   "name": "spritesmith",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "description": "Utility that takes images and creates a spritesheet with JSON sprite data",
@@ -19,3 +19,3 @@ "main": "src/smith.js",
     "async": "~0.2.6",
-    "layout": "~1.3.0"
+    "layout": "~2.0.0"
   },
@@ -22,0 +22,0 @@ "devDependencies": {

README.md

@@ -40,2 +40,3 @@ # Spritesmith [![Build status](https://travis-ci.org/Ensighten/spritesmith.png?branch=master)](https://travis-ci.org/Ensighten/spritesmith)
  * @param {Mixed} [params.engineOpts] Options to pass through to engine for settings
+ * @param {Mixed} [params.algorithmOpts] Options to pass through to algorithm for layout
  * @param {Mixed} [params.exportOpts] Options to pass through to engine for export
@@ -84,2 +85,11 @@ * @param {Function} callback Function that receives compiled spritesheet and map
 
+#### `algorithmOpts`
+All algorithms provide the current options:
+
+```js
+{
+  'sort': false // Stops sorting of images (default for all algorithms)
+}
+```
+
 ### Adding new engines
@@ -86,0 +96,0 @@ Example engines can be found in [src/engines](tree/master/src/engines).

src-test/smith.content.js

@@ -13,6 +13,7 @@ // Load in modules and set up routes
   'An array of sprites': function () {
+    // DEV: These were unsorted for testing `sort: false` but these work for all tests as is =D
     this.sprites = [
       path.join(spriteDir, 'sprite1.png'),
-      path.join(spriteDir, 'sprite2.jpg'),
-      path.join(spriteDir, 'sprite3.png')
+      path.join(spriteDir, 'sprite3.png'),
+      path.join(spriteDir, 'sprite2.jpg')
     ];
@@ -59,2 +60,6 @@
   }, 'when processed via spritesmith'],
+  'when told not to sort': [function () {
+    this.namespace = 'unsorted.';
+    this.options = {'algorithm': 'top-down', 'algorithmOpts': {'sort': false}};
+  }, 'when processed via spritesmith'],
 
@@ -80,2 +85,3 @@ // Engine-specific setups
   'renders a padded spritesheet': 'assertSpritesheet',
+  'renders an unsorted spritesheet': 'assertSpritesheet',
   'has the proper coordinates': 'assertCoordinates',
@@ -82,0 +88,0 @@ 'has the proper properties': 'assertProps',

src-test/smith.outline.js

@@ -21,2 +21,8 @@ // Generate basic outlines
     ]
+  }, {
+    'when told not to sort': [
+      'renders an unsorted spritesheet',
+      'has the proper coordinates',
+      'has the proper properties'
+    ]
   }]
@@ -23,0 +29,0 @@ }, {

src/smith.js

@@ -50,3 +50,3 @@ var async = require('async'),
   var engineSmith = new EngineSmith(engine),
-      layer = new Layout(algorithmPref),
+      layer = new Layout(algorithmPref, params.algorithmOpts),
       padding = params.padding || 0,
@@ -53,0 +53,0 @@ exportOpts = params.exportOpts || {},

No alert changes

Improved metrics

Total package byte prevSize

389433

increased by1.9%

Number of package files

38

increased by8.57%

Lines of code

576

increased by6.47%

Number of lines in readme file

179

increased by5.92%

Dependency changes

• + Addedlayout@2.0.2(transitive)

• - Removedlayout@1.3.2(transitive)

• Updatedlayout@~2.0.0