grunt-webfont - npm Package Compare versions

Comparing version 1.4.0 to 1.5.0

Changelog.md

@@ -0,1 +1,7 @@
+# 1.5.0 - 2016-08-09
+
+* **New feature:** `fontFamilyName` option (#338 by @aaronshekey).
+* **Fixed:** Make sure the `htmlRelativeFontPath` is correct (#344 by @SBeator).
+* **Fixed:** Create folder for HTML demo if it doesn’t exist (#337 by @irfan).
+
 # 1.4.0 - 2016-05-23
@@ -2,0 +8,0 @@

Gruntfile.js

@@ -208,4 +208,3 @@ /*jshint node:true*/
 						baseClass: 'glyph-icon',
-						classPrefix: 'glyph_',
-						mixinPrefix: 'make-icon-'
+						classPrefix: 'glyph_'
 					}
@@ -307,2 +306,10 @@ }
 			},
+			font_family_name: {
+				src: 'test/src/*.svg',
+				dest: 'test/tmp/font_family_name',
+				options: {
+					fontFamilyName: 'customName',
+					types: 'ttf',
+				}
+			},
 			custom_output: {
@@ -309,0 +316,0 @@ src: 'test/src/*.svg',

package.json

 {
   "name": "grunt-webfont",
   "description": "Ultimate SVG to webfont converter for Grunt.",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "homepage": "https://github.com/sapegin/grunt-webfont",
@@ -6,0 +6,0 @@ "author": {

Readme.md

@@ -255,4 +255,3 @@ # SVG to webfont converter for Grunt
 		baseClass: 'glyph-icon',
-		classPrefix: 'glyph_',
-		mixinPrefix: 'glyph-'
+		classPrefix: 'glyph_'
 	}
@@ -369,2 +368,8 @@ }
 
+#### normalize
+
+Type: `boolean` Default: `false`
+
+When using the fontforge engine, if false, glyphs will be generated with a fixed width equal to fontHeight. In most cases, this will produce an extra blank space for each glyph. If set to true, no extra space will be generated. Each glyph will have a width that matches its boundaries.
+
 #### startCodepoint
@@ -415,2 +420,14 @@
 
+#### fontFamilyName
+
+Type: `string` Default: _`font` value_
+
+If you’d like your generated fonts to have a name that’s different than the `font` value, you can specify this as a string. This will allow a unique display name within design authoring tools when installing fonts locally. For example, your font’s name could be `GitHub Octicons` with a filename of `octicons.ttf`.
+
+```javascript
+options: {
+	fontFamilyName: 'GitHub Octicons',
+}
+```
+
 #### descent
@@ -492,4 +509,3 @@
 				baseClass: 'glyph-icon',
-				classPrefix: 'glyph_',
-				mixinPrefix: 'glyph-'
+				classPrefix: 'glyph_'
 			}
@@ -496,0 +512,0 @@ }

tasks/engines/node.js

@@ -37,3 +37,3 @@ /**
 				var stream = svgicons2svgfont(streams, {
-					fontName: o.fontName,
+					fontName: o.fontFamilyName,
 					fontHeight: o.fontHeight,
@@ -40,0 +40,0 @@ descent: o.descent,

tasks/templates/bem.json

 {
 	"baseClass": "icon",
-	"classPrefix": "icon_",
-	"mixinPrefix": "icon-"
+	"classPrefix": "icon_"
 }

tasks/templates/bootstrap.json

 {
 	"baseClass": "",
-	"classPrefix": "icon-",
-	"mixinPrefix": ""
+	"classPrefix": "icon-"
 }

tasks/webfont.js

@@ -131,2 +131,3 @@ /**
 		o.fontFilename = template(options.fontFilename || o.fontBaseName, o);
+		o.fontFamilyName = template(options.fontFamilyName || o.fontBaseName, o);
 
@@ -420,3 +421,3 @@ // “Rename” files
 			var relativeRe = new RegExp(_s.escapeRegExp(o.relativeFontPath), 'g');
-			var htmlRelativeFontPath = normalizePath(path.relative(o.destHtml, o.relativeFontPath));
+			var htmlRelativeFontPath = normalizePath(path.relative(o.destHtml, o.dest));
 			var _fontSrc1 = o.fontSrc1.replace(relativeRe, htmlRelativeFontPath);
@@ -520,6 +521,12 @@ var _fontSrc2 = o.fontSrc2.replace(relativeRe, htmlRelativeFontPath);
 
-			// Save file
-			fs.writeFileSync(getDemoFilePath(), demo);
+			mkdirp(getDemoPath(), function(err) {
+				if (err) {
+					logger.log(err);
+					return;
+				}
+				// Save file
+				fs.writeFileSync(getDemoFilePath(), demo);
+				done();
+			});
 
-			done();
 		}
@@ -764,2 +771,9 @@
 
+		/**
+		 * Return path of HTML demo file or `null` if feature was disabled
+		 */
+		function getDemoPath() {
+			if (!o.htmlDemo) return null;
+			return o.destHtml;
+		}
 
@@ -766,0 +780,0 @@ /**

No alert changes

Improved metrics

Total package byte prevSize

103049

1.46%

Number of package files

61

1.67%

Lines of code

2203

0.87%

Number of lines in readme file

666

2.46%

No dependency changes