Changed: no longer required to transfer options for figter using config option.

Changed: to load configuration from file, need specify `useConfigFile` option.
Chore: no need to use function `encodeURI` for `query string`.

Author: evilebottnawi

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+# Head
+
+- Changed: no longer required to transfer options for `figter` using `config` option.
+- Changed: to load configuration from file, need specify `useConfigFile` option.
+- Chore: no need to use function `encodeURI` for `query string`.
+
 # 1.1.1 - 2017-01-31
 
 - Fixed: updated webpack peer dependency to support `2.2.1`.

README.md

@@ -67,7 +67,7 @@ module.exports = {
   module: {
     loaders: [
       {
-        loader: "figlet",
+        loader: "figlet?useConfigFile",
         test: /\.figletrc$/, // or "/\.figletrc\.json$/", or "/\.figletrc\.js$/"
       }
     ]
@@ -83,11 +83,17 @@ module.exports = {
 Alternative configurations supported dynamic configuration:
 
 ```javascript
+const querystring = require('querystring');
+const figletConfig = {
+    options: {},
+    text: "ANOTHER-TEXT"
+};
+
 module.exports = {
   module: {
     loaders: [
       {
-       loader: `figlet?config=${encodeURI(JSON.stringify(figletConfig))}`,
+       loader: `figlet?config=${JSON.stringify(figletConfig)}`,
        test: /figlet$/
       }
     ]
@@ -100,17 +106,44 @@ module.exports = {
 }
 ```
 
-Note: `webpack` normalize `query` to `loader`, if you want to specify `url` in `outputTextBefore` or `outputTextAfter`, 
-then use `'Visit Site - https:\\/\\/itgalaxy.company'`.
+In `webpack 2` your can use this config:
+
+```javascript
+const figletConfig = {
+    options: {},
+    text: "ANOTHER-TEXT"
+};
 
-Using `config` through `query string` is have large priority than through `resolve.alias`.
+module.exports = {
+  module: {
+    loaders: [
+      {
+        loader: `figlet-loader`,
+        options: figletConfig,
+        test: /figlet$/
+      }
+    ]
+  },
+  resolve: {
+    alias: {
+      figlet$: path.resolve(__dirname, "path/to/empty-file") // You can add comment "Please do not delete this file" in this file
+    }
+  }
+}
+```
 
-Option `figletConfig` must contain `text` and `options` as above in **Initialization** section.
+Config should always contains `text` and `options` as above in **Initialization** section.
 
 ### Usage
 
 Now you are able to import your custom figlet build as a module throughout your application like so:
 
+```javascript
+const figlet = require('figlet');
+```
+
+Or
+
 ```javscript
 import 'figlet';
 ```

__tests__/fixtures/.figletrc-invalid.json

@@ -2,5 +2,5 @@
     "options": {
         "font": "NonexistsFont"
     },
-    "text": "ANOTHER-TEXT"
+    "text": "ANOTHER-TEXT-INVALID"
 }

__tests__/fixtures/.figletrc.js

@@ -9,5 +9,5 @@ module.exports = {
         kerning: "default",
         verticalLayout: "default"
     },
-    text: "ANOTHER-TEXT"
+    text: "ANOTHER-TEXT-JS-RC"
 };

__tests__/fixtures/.figletrc.json

@@ -7,5 +7,5 @@
         "kerning": "default",
         "verticalLayout": "default"
     },
-    "text": "ANOTHER-TEXT"
+    "text": "ANOTHER-TEXT-JSON-RC"
 }