twolfson/grunt-spritesmith

Combination of Phantom and not specifying algorithm causes 0 size png to be generated

Open

#47 opened on Nov 11, 2013

View on GitHub
 (30 comments) (0 reactions) (0 assignees)JavaScript (98 forks)batch import
bughelp wanted

Repository metrics

Stars
 (1,141 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Firstly, thanks for an awesome grunt plugin. I had some issues today using this for the first time on Windows with Phantom. I was seeing that the css was generated fine, but the png had zero file size. My task looked like:

classes_sp : {
   src : '<%= css_src_path %>/classes/**/*.png',
   destImg : '<%= css_build_path %>/classes-sprite.png',
   destCSS : '<%= css_build_path %>/classes-sprite.css',
   'engine' : 'phantomjs'
},

By adding in the algorithm as binary-tree, rather than using the default, all of a sudden png files and css generated correctly. Admittedly the sprites were fairly large one 5Mb and one 70Mb (152 images) - which is ridiculous but I was just trying to get something working.

I think if it is related to the size an error stating that files were too large to sprite with the algorithm would be cool - a silent fail makes me a bit nervous to use this in production.

Contributor guide

Research direction
Investigate the grunt spritesmith source code to understand how the algorithm defaults are set and why omitting the algorithm causes a silent failure with the PhantomJS engine. Compare the behavior when algorithm is explicitly set to 'binary tree' vs default.
Tech stack
javascriptnodejs
Domain
build systemtooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.jsGrunt
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70