- fix a bug where loader would not complete unless there were webfonts to load

- add flow and generated api documentation
- add more documentation to the README

Author: Matt Colman

Diff for: .babelrc

@@ -1,3 +1,3 @@
 {
-  "presets": ["es2015"]
+  "presets": ["es2015", "flow"]
 }

Diff for: .flowconfig

@@ -0,0 +1,7 @@
+[ignore]
+
+[include]
+
+[libs]
+
+[options]

Diff for: README.md

@@ -112,15 +112,35 @@ resolve: {
 }
 ```
 
-## Usage
+## Simple Usage
 ```
 import ManifestLoader from 'phaser-manifest-loader'
 import manifest from './manifest' // see manifest example below
-preload() {
+
+// no webfonts in this manifest so we can simply use the preload method
+preload() {  
   this.game.plugins.add(ManifestLoader).loadManifest(manifest)
 }
 ```
 
+## Advanced Usage (Webfonts)
+```
+import 'assets/fonts/bebas/stylesheet.css' // IMPORTANT remember to load your webfont stylesheet
+import ManifestLoader from 'phaser-manifest-loader'
+import manifest from './manifest' // see manifest example below
+
+// Load in a manifest of assets including web fonts
+// because webfonts don't use the Phaser loader we can't take advantage of Phaser's
+// preload method. So we performing loading in the create method and use the Promise
+// returned from `loadManifest`.
+create() {
+  const loader = this.game.plugins.add(ManifestLoader) // returns a Promise
+  loader.loadManifest(manifest).then(() => {
+    this.state.start('Main');
+  })
+}
+```
+
 ## Manifest Example
 ```
 const manifest = {
@@ -154,6 +174,18 @@ const manifest = {
 export default manifest
 ```
 
+## API
+### loadManifest
+
+[loadManifest loads a manifest of assets]
+
+**Parameters**
+
+-   `manifest` **Manifest**
+-   `assetPostfix` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?**  (optional, default `.g`)
+
+Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)**
+
 ## Run demo
 `npm start`
 

Diff for: lib/ManifestLoader.js

@@ -41,9 +41,6 @@ var ManifestLoader = function (_Phaser$Plugin) {
 
     /**
      * [loadManifest loads a manifest of assets]
-     * @param {Object} manifest
-     * @param {String} assetPostfix (optional) default = ''
-     * @return {Promise}
      */
 
   }, {
@@ -72,11 +69,15 @@ var ManifestLoader = function (_Phaser$Plugin) {
     key: '_loadWebFonts',
     value: function _loadWebFonts(fonts) {
       return new Promise(function (resolve) {
-        _webfontloader2.default.load(Object.assign({}, fonts, {
-          active: function active() {
-            resolve();
-          }
-        }));
+        if (!fonts) {
+          resolve();
+        } else {
+          _webfontloader2.default.load(Object.assign({}, fonts, {
+            active: function active() {
+              resolve();
+            }
+          }));
+        }
       });
     }
   }]);

Diff for: package.json

@@ -13,11 +13,12 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "babel-cli": "^6.22.2",
+    "babel-cli": "^6.24.1",
     "babel-core": "^6.21.0",
     "babel-loader": "^6.2.10",
     "babel-polyfill": "^6.20.0",
     "babel-preset-es2015": "^6.18.0",
+    "babel-preset-flow": "^6.23.0",
     "browser-sync": "^2.18.6",
     "browser-sync-webpack-plugin": "^1.1.3",
     "css-loader": "^0.26.1",
@@ -29,14 +30,15 @@
     "exports-loader": "^0.6.3",
     "expose-loader": "^0.7.1",
     "file-loader": "^0.9.0",
+    "flow-bin": "^0.43.1",
     "image-webpack-loader": "^3.1.0",
     "imports-loader": "^0.7.0",
     "style-loader": "^0.13.1",
     "url-loader": "^0.5.7",
-    "webpack": "^2.2.0",
-    "phaser-ce": "^2.7.3"
+    "webpack": "^2.2.0"
   },
   "dependencies": {
+    "phaser-ce": "^2.7.3",
     "webfontloader": "^1.6.27"
   }
 }

Diff for: src/ManifestLoader.js

@@ -2,17 +2,29 @@ import Phaser from 'phaser'
 import WebFont from 'webfontloader'
 import AssetLoader from './AssetLoader'
 
+type Manifest = {
+  spritesheets: Array<string>,
+  images: Array<string>,
+  audio: Array<string>,
+  bitmap_fonts: Array<string>,
+  fonts: {
+    custom: {
+      families: Array<string>,
+    },
+    google: {
+      families: Array<string>,
+    },
+  },
+}
+
 class ManifestLoader extends Phaser.Plugin {
 
   init () {}
 
   /**
    * [loadManifest loads a manifest of assets]
-   * @param {Object} manifest
-   * @param {String} assetPostfix (optional) default = ''
-   * @return {Promise}
    */
-  loadManifest (manifest, assetPostfix = '') {
+  loadManifest (manifest: Manifest, assetPostfix: string = ''): Promise {
     return Promise.all([
       this._loadAssets(manifest, assetPostfix),
       this._loadWebFonts(manifest.fonts)
@@ -33,11 +45,15 @@ class ManifestLoader extends Phaser.Plugin {
 
   _loadWebFonts (fonts) {
     return new Promise((resolve) => {
-      WebFont.load(Object.assign({}, fonts, {
-        active: () => {
-          resolve()
-        }
-      }))
+      if (!fonts) {
+        resolve()
+      } else {
+        WebFont.load(Object.assign({}, fonts, {
+          active: () => {
+            resolve()
+          }
+        }))
+      }
     })
   }
 }