feat: hide: default mask can be overridden

a significant refactoring has been necessary
to allow all tag functions to accept an object
of options:

```javascript
myTag({foo_enabled: true})`do something with ${x} and ${y}`
```

Author: customcommander

Makefile

@@ -11,7 +11,7 @@ dist/%.js: src/%.js
 	mkdir -p $(@D)
 	java -jar /workspaces/closure-compiler/compiler.jar \
 		--compilation_level=SIMPLE_OPTIMIZATIONS \
-		--language_in=ECMASCRIPT_2015 \
+		--language_in=ECMASCRIPT_2018 \
 		--language_out=ECMASCRIPT_2015 \
 		--js=$^ \
 		--js_output_file=$@

README.md

@@ -99,14 +99,21 @@ defaults`Hi ${username}/guest, you have ${num}/no new emails`;
 ### <a name="hide"></a>hide
 
 
-The `hide` tag replaces all interpolated values with 'xxx':
+The `hide` tag replaces all interpolated values with a default mask `'xxx'`:
 
 ```javascript
 import {hide} from '@customcommander/tagtical';
 
 hide`Hi ${name}, your credit card number is ${cc_num}`
 //=> "Hi xxx, your credit card number is xxx"
 ```
+
+The default mask can be overridden:
+
+```javascript
+hide({mask: '🌯'})`Hi ${name}, your credit card number is ${cc_num}`
+//=> "Hi 🌯, your credit card number is 🌯"
+```
 ### <a name="lower"></a>lower
 
 

jsconfig.json

@@ -0,0 +1,5 @@
+{
+  "include": [
+    "src/**/*.js"
+  ]
+}

src/hide.js

@@ -21,21 +21,37 @@
  * SOFTWARE.
  */
 
+const tag_function = require('./utils/tag-function');
+
 /**
  * Hides interpolated values
  *
- * The `hide` tag replaces all interpolated values with 'xxx':
+ * The `hide` tag replaces all interpolated values with a default mask `'xxx'`:
  *
  * ```javascript
  * import {hide} from '@customcommander/tagtical';
  * 
  * hide`Hi ${name}, your credit card number is ${cc_num}`
  * //=> "Hi xxx, your credit card number is xxx"
  * ```
+ *
+ * The default mask can be overridden:
+ *
+ * ```javascript
+ * hide({mask: '🌯'})`Hi ${name}, your credit card number is ${cc_num}`
+ * //=> "Hi 🌯, your credit card number is 🌯"
+ * ```
+ *
+ * @function
  */
 module.exports =
-  (l, x, r) =>
-    [ l
-    , 'xxx'
-    , r
-    ];
+  tag_function
+    ( (l, x, r, {mask}) =>
+        [ l
+        , mask
+        , r
+        ]
+    /* default options */
+    , { mask: 'xxx'
+      }
+    );

src/index.js

@@ -1,4 +1,5 @@
-const tag_function = require('./utils/tag_function');
+const tag_function = require('./utils/tag-function');
+const use_tag = require('./utils/use-tag');
 const join = require('./utils/join');
 const intersperse = require('./utils/intersperse');
 const compose = require('./utils/compose');
@@ -11,15 +12,15 @@ const upper = require('./upper');
 
 const tag = (...fns) =>
   (strs, ...vals) =>
-    compose(join(''), ...fns.map(tag_function.unwrap))
+    compose(join(''), ...fns.map(use_tag.unwrap))
       (intersperse(strs, vals));
 
-tag.defaults = tag_function(defaults);
-tag.hide = tag_function(hide);
-tag.lower = tag_function(lower);
-tag.pluralize = tag_function(pluralize);
-tag.trim = tag_function(trim);
-tag.upper = tag_function(upper);
-tag.of = tag_function;
+tag.defaults = use_tag(defaults);
+tag.hide = use_tag(hide);
+tag.lower = use_tag(lower);
+tag.pluralize = use_tag(pluralize);
+tag.trim = use_tag(trim);
+tag.upper = use_tag(upper);
+tag.of = compose(use_tag, tag_function);
 
 module.exports = tag;

src/lower.js

@@ -21,6 +21,8 @@
  * SOFTWARE.
  */
 
+const tag_function = require('./utils/tag-function');
+
 /**
  * Lowercase interpolated values
  *
@@ -41,10 +43,12 @@
  * ```
  */
 module.exports =
-  (l, x, r) =>
-    [ l
-    , typeof x === 'string'
-        ? x.toLowerCase()
-        : x
-    , r
-    ];
+  tag_function
+    ( (l, x, r) =>
+        [ l
+        , typeof x === 'string'
+            ? x.toLowerCase()
+            : x
+        , r
+        ]
+    );

src/pluralize.js

@@ -21,6 +21,8 @@
  * SOFTWARE.
  */
 
+const tag_function = require('./utils/tag-function');
+
 const is_pos_int = x =>
   Number.isInteger(x) && x >= 0;
 
@@ -49,7 +51,6 @@ const get_plural_form = str =>
       ? lws + plf.substring(1) + tws
       : lws + snf + plf.substring(1, plf.length-1) + tws);
 
-
 /**
  * Choose between singular or plural forms.
  *
@@ -97,14 +98,16 @@ const get_plural_form = str =>
  * 📢 A `0` will pick the __plural__ form(s).
  */
 module.exports =
-  (l, x, r) =>
-    [   !is_pos_int(x)  ? l
-      : x === 1         ? get_singular_form(l)
-                        : get_plural_form(l)
+  tag_function
+    ( (l, x, r) =>
+        [   !is_pos_int(x)  ? l
+          : x === 1         ? get_singular_form(l)
+                            : get_plural_form(l)
 
-    , x
+        , x
 
-    ,   !is_pos_int(x)  ? r
-      : x === 1         ? get_singular_form(r)
-                        : get_plural_form(r)
-    ];
+        ,   !is_pos_int(x)  ? r
+          : x === 1         ? get_singular_form(r)
+                            : get_plural_form(r)
+        ]
+    );

src/trim.js

@@ -21,6 +21,8 @@
  * SOFTWARE.
  */
 
+const tag_function = require('./utils/tag-function');
+
 /**
  * Trim interpolated values
  *
@@ -36,10 +38,12 @@
  * ```
  */
 module.exports =
-  (l, x, r) =>
-    [ l
-    , typeof x === 'string'
-        ? x.trim()
-        : x
-    , r
-    ]
+  tag_function
+    ( (l, x, r) =>
+        [ l
+        , typeof x === 'string'
+            ? x.trim()
+            : x
+        , r
+        ]
+    )

src/types/index.js

@@ -0,0 +1,14 @@
+/**
+ * Tag options.
+ * @typedef {Object} TagOptions
+ */
+
+/**
+ * Creates a tag function bound to a specific set of options.
+ * @typedef {function(TagOptions): TagFunction} TagConfigFunction
+ */
+
+/**
+ * Tag function.
+ * @typedef {function(string, ?, string, TagOptions): Array} TagFunction
+ */

src/upper.js

@@ -21,6 +21,8 @@
  * SOFTWARE.
  */
 
+const tag_function = require('./utils/tag-function');
+
 /**
  * Uppercase interpolated values
  *
@@ -37,10 +39,12 @@
  * ```
  */
 module.exports =
-  (l, x, r) =>
-    [ l
-    , typeof x === 'string'
-        ? x.toUpperCase()
-        : x
-    , r
-    ];
+  tag_function
+    ( (l, x, r) =>
+        [ l
+        , typeof x === 'string'
+            ? x.toUpperCase()
+            : x
+        , r
+        ]
+    );