grunt-ziti

Subsetting, optimizing and converting large font files to smaller web fonts.

This grunt plugin:

• can gettext from your HTML, JavaScript and CSS files
• includes source files of font-optimizer (by Philip Taylor) - to subset and optimize TTF font file
• will download webify (by Anantha Kumaran) binary file - to generate web font

Notes:

• For edge cases of getting texts, you can always use comments or specify characters directly in grunt.initConfig().
• If you are using Linux, the webify binary requires glibc version >= 2.15, for Ubuntu users, you'll need 12.04 LTS or newer system.
• If you are using TTC font, you can use FontForge to open the file and then save it as separate TTF files.
• If your font files are large, don't include them in your project's git repository. You should put them in another repository and use download option.

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-ziti --save-dev

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

grunt.loadNpmTasks('grunt-ziti');

Options

subset

Type: Boolean Default: true

Whether to make a subset of the source TTF font.

optimize

Type: Boolean Default: true

Whether to delete font data that is not necessary for their use in web browsers. It will strip font name strings and PostScript glyph names. This option works only when subset is true.

convert

Type: Boolean Default: true

Whether to convert the TTF font to three other web font formats, namely the WOFF, EOT and SVG. If subset is true, it will convert the subsetted font. Otherwise, it will convert the original font.

deleteCharsFile

Type: Boolean Default: true

Whether to remove the text file contains characters used when subsetting the font.

html

Type: Object

Options to be used when processing HTML files.

html.pattern

Type: String Default: '\\.html?$'

RegExp to find HTML files.

html.classes

Type: Array of Strings

Get inner texts from HTML elements which have one of these class names.

html.attributes

Type: Array of Strings

Get attribute values from these attributes.

html.elements

Type: Array of Strings

Get inner texts from these HTML elements.

html.comments

Type: Array of Strings

If you set this option to [ 'example' ], it will get texts between example { and } in comments.

js

Type: Object

Options to be used when processing JavaScript files.

js.pattern

Type: String Default: '\\.js$'

RegExp to find JavaScript files.

js.functions

Type: Array of Strings

Get texts from these functions. For example, $ziti$('字'+'体'); will have 字体.

js.comments

Type: Array of Strings

If you set this option to [ 'example' ], it will get texts between example { and } in comments.

css

Type: Object

Options to be used when processing CSS files.

css.pattern

Type: String Default: '\\.css$'

RegExp to find CSS files.

css.selectors

Type: Array of Strings

Get values from the last valid content property of each of these selectors.

css.comments

Type: Array of Strings

If you set this option to [ 'example' ], it will get texts between example { and } in comments.

font

Type: Object

Options to be used when processing TTF font files.

font.pattern

Type: String Default: '\\.ttf$'

font.chars

Type: String

Extra characters to be included when subsetting the font.

font.charsFilePattern

Type: String

RegExp to find text files. All characters in these text files will be included when subsetting the font.

download

Type: Object

Download files from URLs. Like Grunt's file object, keys are the destination locations while values can be a single URL string or an array of URL strings. When it is an array, next URL in the array will be used if previous one fails to download. Download starts only when one of destination files is missing in the files object.

You can add a hash tag and the file checksum hash at the end of the URL or the file location to verify the file after download completes. You can use the MD5, SHA-1, SHA-256 or SHA-512 algorithm.

Examples

Full options

grunt.initConfig({
  ziti: {
    index: {
      options: {
        html: {
          pattern: '\\.html?$',
          classes: [ 'my-ziti' ],
          attributes: [ 'data-text' ],
          elements: [ 'h2' ],
          comments: [ 'ziti' ]
        },
        js: {
          pattern: '\\.js$',
          functions: [ '$ziti$', '$htmlziti$' ],
          comments: [ 'ziti' ]
        },
        css: {
          pattern: '\\.css$',
          selectors: [ '.words:before' ],
          comments: [ 'ziti', 'htmlziti' ]
        },
        font: {
          pattern: '\\.ttf$',
          chars: '配置',
          charsFilePattern: '\\.txt$'
        },
        download: {
          'src/original.ttf#3a15ae4faaeb955e0517dd5b2abb2f35f41c18cc': [
            'http://localhost:8000/fonts/WenQuanYiMicroHei.ttf',
            'http://localhost:3000/fonts/WenQuanYiMicroHei.ttf',
            'https://github.com/cghio/wqyfonts/raw/master/fonts/WenQuanYiMicroHei.ttf'
          ]
        },
        subset: true,
        optimize: true,
        convert: true,
        deleteCharsFile: false
      },
      files: {
        'public/index.ttf': [
          'src/index.html',
          'src/index.js',
          'src/index.css',
          'src/index.txt',
          'src/*.ttf'
        ]
      }
    }
  }
});

Subset font only

grunt.initConfig({
  ziti: {
    subset_only: {
      options: {
        font: {
          chars: '字形字体字型'
        },
        convert: false
      },
      files: {
        'public/my.ttf': [ 'src/original.ttf' ]
      }
    }
  }
});

Convert to web fonts only

grunt.initConfig({
  ziti: {
    convert_only: {
      options: {
        subset: false,
        convert: true
      },
      files: {
        'public/my.ttf': [ 'src/original.ttf' ]
      }
    }
  }
});

License

font-optimizer, webify and grunt-ziti use the MIT license:

• Copyright (c) 2009 Philip Taylor
• Copyright (c) 2013 Anantha Kumaran <[e-mail]>
• Copyright (c) 2014 Cai Guanhao (Choi Goon-ho)