grunt-svgfit

grunt-svgfit

Crops the source svg to it's artwork bounds

Getting Started

This plugin requires Grunt ">=0.4.0"

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-svgfit --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-svgfit');

The "svgfit" task

Overview

In your project's Gruntfile, add a section named svgfit to the data object passed into grunt.initConfig().

grunt.initConfig({
  svgfit: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Usage Examples

Single svg

grunt.initConfig({
  svgfit: {
    files: {
      'tmp/fileObject/test.svg': ['test/svg/search.svg']
    }
  },
});

Multiple svg's

grunt.initConfig({
  svgfit: {
    files: {
      'tmp/fileObject/': ['test/svg/*.svg']
    }
  },
});

Multiple svg's with specific paths

grunt.initConfig({
  svgfit: {
    files: [
      {src: ['test/svg/search.svg', 'test/svg/search2.svg'], dest: ['tmp/fileArray/search.svg, tmp/fileArray/search2.svg']}
    ]
  },
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Why

Pulling svg's as part of a work process and they weren't tight to their bounds meaning they sometimes displayed strangely in the browser, wanted a pre process way of setting them to their exact bounds.

Release History

• 2.0.0 - Bumped svgfit v2.0.0
• 1.0.0 - Phantomjs updated to v2
• 0.5.0 - Fixed cross platform paths / Single async call no matter how many sources
• 0.2.0 - Fixed async calls
• 0.1.0 - Initial commit

License

Copyright (c) 2015 Michael Mellor Licensed under the MIT license.