grunt-icomoon-zip v0.0.2

grunt-icomoon-zip

Grunt task for automating icomoon generation

Getting Started

This plugin requires Grunt.

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-icomoon-zip --save-dev

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

grunt.loadNpmTasks('grunt-icomoon-zip');

The "icomoon-zip" task

Overview

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

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

Options

options.clear

Type: Boolean Default value: true

A true/false value to determine whether to delete the extracted icomoon sources or not.

options.fontsPath

Type: String Default value: ''

Absolute path to your fonts folder where icomoon generated fonts will be copied.

options.fontsRelativePath

Type: String Default value: 'fonts'

Relative path to your fonts folder. It should be relative to your icomoon styles file.

options.styleFile

Type: String Default value: ''

Absolute path to your icomoon partial file (including filename). It can be a Sass partial or vanila CSS file.

Usage Example

grunt.initConfig({
  'icomoon-zip': {
    options: {
      clear: false,
      fontsPath: 'src/fonts',
      fontsRelativePath: '../fonts',
      styleFile: 'src/scss/vendor/_icomoon.scss'
    },
    icons: {
      files: {
        'src/icomoon': ['src/icomoon.zip']
      }
    }
  },
})

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.

License

Copyright (c) 2015 Piotr Kulpinski. Licensed under the MIT license.