Download and install Google Web Fonts on your local machine. 

Download and install Google Web Fonts on your local machine

lordgiotto

google-font-installer

	"description": "Download and install Google Web Fonts on your local machine",

	"author": "Lorenzo Zottar <lordgiotto@gmail.com>",

		"url": "https://github.com/lordgiotto/google-font-installer"

		"url" : "https://github.com/lordgiotto/google-font-installer/issues"

	"keywords" : ["google", "font", "download", "install", "cli"],

  "description": "Download and install Google Web Fonts on your local machine",

  "author": "Lorenzo Zottar <lordgiotto@gmail.com>",

    "url": "https://github.com/lordgiotto/google-font-installer"

    "url": "https://github.com/lordgiotto/google-font-installer/issues"

Google Font Installer is written in NodeJS and let you Search, Donwload and Install any font offered by Google Web Fonts.

- installing the module system wide and using the Command Line Interface (CLI)

- requiring the module in your project and use the APIs

In Linux and OSX, the font will be installed in the user's font directory (~/.fonts for Linux, ~/Library/Fonts for OSX).

In Windows, due to the fact that font installation require some register modifications, I prefered to create a little WScript (a windows script that use ActiveX windows interface) and spawn a `cscript` process to install the font in _'windows native way'_.

First of all you have to install google-font-installer in your system

$ sudo npm install -g google-font-installer

If you are on a Windows Machine, you have to omit `sudo` before `npm`

Now, from your terminal emulator, you can use the command `gfi`

The search is really permissive, so you can specify only few characters and view all the font families that contains these characters. Words order is also not important.

For instance, search for _Source Sans_ or _Sans Source_ will produce the same result.

$ gfi download [family_name] [-d|--dest destination_folder] [-v|--variants comma_separeted_variants]

If **family_name** will match more than one family, nothing will be downloaded: a list of alternatives will help you better specify the font family name.

- `-d` or `--dest` let you specify the folder where to download the fonts. If this option is omitted the fonts will be download in the folder in which the command was called (or in the home directory if this folder is not writable by the user)

- `-v` or `--variants` let you specify which variants of the font will be downloaded. You have to write each variant separated by the other with a comma. For exemple `$ gfi download Source Sans Pro -v 300,400`. If omitted, all variants will be downloaded.

$ gfi install [family_name] [-v|--variants comma_separeted_variants]

If **family_name** will match more than one family, nothing will be installed: a list of alternatives will help you better specify the font family name.

- `-v` or `--variants` let you specify which variants of the font will be installed. You have to write each variant separated by the other with a comma. For exemple `$ gfi install Source Sans Pro -v 300,400`. If omitted, all variants will be downloaded.

    Variants: 200, 300, regular, 500, 600, 700, 900

    CSS Url: https://fonts.googleapis.com/css?family=Source+Code+Pro

    Variants: 200, 200italic, 300, 300italic, regular, italic, 600, 600italic, 700, 700italic, 900, 900italic

    CSS Url: https://fonts.googleapis.com/css?family=Source+Sans+Pro

    CSS Url: https://fonts.googleapis.com/css?family=Source+Serif+Pro

Download Source Sans Pro 600 and 700italic:

$ gfi download source sans -v 600,700italic

Source Sans Pro variant 600 downloaded in /home/user/someFolder/SourceSansPro-600.ttf

Source Sans Pro variant 700italic downloaded in /home/user/someFolder/SourceSansPro-700italic.ttf

Lato variant 100 downloaded in /home/user/.fonts/Lato-100.ttf

First of all you have to install the module in you NodeJS project:

$ npm install google-font-installer --save

And then you can require it in your code:

var GooglFontList = require('google-font-installer');

var GoogleFontList = require('google-font-installer');

To use this API is necessary to obtain a Browser Key enabled to Google Font API from the [Google Developer Dashboard](https://console.developers.google.com/).

**GoogleFontList** is a class that can be instanced with the Google API Key as only argument.

var fontList = new GoogleFontList('API_KEY');

If you prefer you can also create an instance without the apiKey and call the methods `.setApiKey('API_KEY')` and `.downloadList()` in a second moment.

Emitted when the Font List is downloaded from Google and the data are converted, stored and processed. Callback contains only one argument for convenience: the object itself

Emitter if something go wrong in downloading, coverting or processing data. The Callback argument is the error object.

Array of GoogleFont instances, a class that extends the data provided by the Google APIs. Empty until 'success' event.

The Google APIs Key setted with the constructor or with setApiKey().

- Returns [String|Boolean] If apiKey is a valid string, return the apiKey trimmed, else returns false.

Used to set the apiKey to download data from Google Web Font APIs.

Download the list from Google Web Font APIs.

- _rawData_ [String] String in valid JSON format.

Parse raw data in valid JSON format. Used internally, but public for convenience if someone prefers to use the object without downloading the list (ex. cached data).

- _jsonData_ [Array] An array of Object rappresenting the font like Google does.

Populate the object `data` property with an array of GoogleFont instances, based on the data provided by Google Apis. Used internally, but public for convenience if someone prefers to use the object without downloading and parsing the list (ex. cached data).

- Returns [GoogleFontList] A new instance of GoogleFontList

Return a new instance of the object, with the same `data` and `apiKey` properties.

###### `searchFont(term, field, callback)`

- term [String] The string to search for.

- field [String] The property of the GoogleFont instance to test.

- callback(err, fontList) [Function] Mandatory callback with optional error obj and a new instance of GoogleFontList with the searched subset of Fonts

Function with callback used to search a specific string inside a specific property of googleFont object.

###### `searchFontByName(term, callback)`

Same as searchFont, but specific for the Family property. (the font name)

###### `searchFontByType(term, callback)`

Same as searchFont, but specific for the Category property. (for instance serif, sans-serif, display, etc)

- Returns [GoogleFont|Boolean] If not empty, return the first GoogleFont instance inside

GoogleFontList `data` property, else return false.

- Returns [Boolean] Returns true if the is only one GoogleFont in GoogleFontList `data` property, else return false.

Execture fn foreach GoogleFOnt in GoogleFontList `data` property. It's async.

Class that extends data structure provided by Google APIs.

It's instanced by the populate method of GoogleFontList, called internally by the constructor or by parseRawData method.

**Every object inside the `data` property of GoogleFontList is an instance of this class.**

###### `family` `category` `version` `lastModified` [String]

Inherits by Google Font API structure, respectively the font name, the font type (serif, sans-serif, etc), the version and the string rappresenting the last modification data.

Inherits by Google Font API structure, a list of the available subsest for that font.

    - result [Array] An Array containing one object for each installed file, with the following properties:

        - _family_: the downloaded font family

        - _variant_: the downloaded variant

        - _path_: the path of the downloaded file

        - _family_: the installed font family

        - _variant_: the installed variant

        - _path_: the path of the installed file

Install specified variants of the font. The destination folder depends on the platform used:

- Windows: The file is not copied into c:\Windows\Fonts, but is used a WScript that install the font invoking the font install windows function.

var GoogleFontlist = require('google-font-installer');

var fontList = new GoogleFontlist('VALID_API_KEY');

	this.searchFontByName('Source Sans Pro', function(err, filteredList) {

		filteredList.getFirst().download(['300', '400'], function(err, result){

				console.log('Variant %s of %s downloaded in %s', el.variant, el.family, el.path);

		{
		"name": "google-font-installer",
		"version": "1.0.0",
		"description": "Download and install Google Web Fonts on your local machine",
		"author": "Lorenzo Zottar <lordgiotto@gmail.com>",
		"main": "./lib/google-font-list.js",
		"bin": {
		"gfi": "./cli.js"
		},
		"repository":
		{
		"type": "git",
		"url": "https://github.com/lordgiotto/google-font-installer"
		},
		"bugs": {
		"url" : "https://github.com/lordgiotto/google-font-installer/issues"
		},
		"license": "MIT",
		"keywords" : ["google", "font", "download", "install", "cli"],
		"dependencies": {
		"async": "^1.5.2",
		"colors": "^1.1.2",
		"commander": "^2.9.0",
		"file-type": "^3.6.0",
		"mv": "^2.1.1",
		"pascal-case": "^1.1.2"
		}
		"name": "google-font-installer",
		"version": "1.0.1",
		"description": "Download and install Google Web Fonts on your local machine",
		"author": "Lorenzo Zottar <lordgiotto@gmail.com>",
		"main": "./lib/google-font-list.js",
		"bin": {
		"gfi": "./cli.js"
		},
		"repository": {
		"type": "git",
		"url": "https://github.com/lordgiotto/google-font-installer"
		},
		"bugs": {
		"url": "https://github.com/lordgiotto/google-font-installer/issues"
		},
		"license": "MIT",
		"keywords": [
		"google",
		"font",
		"download",
		"install",
		"cli"
		],
		"dependencies": {
		"async": "^1.5.2",
		"colors": "^1.1.2",
		"commander": "^2.9.0",
		"file-type": "^3.6.0",
		"mv": "^2.1.1",
		"pascal-case": "^1.1.2"
		}
		}

Improved metrics

Worsened metrics

		@@ -96,3 +96,3 @@ Google Font Installer
		```js
		var GooglFontList = require('google-font-installer');
		var GoogleFontList = require('google-font-installer');
		```
		@@ -244,5 +244,5 @@
		- result [Array] An Array containing one object for each installed file, with the following properties:
		- _family_: the downloaded font family
		- _variant_: the downloaded variant
		- _path_: the path of the downloaded file
		- _family_: the installed font family
		- _variant_: the installed variant
		- _path_: the path of the installed file

		@@ -249,0 +249,0 @@ Install specified variants of the font. The destination folder depends on the platform used: