Incorporates default option to strip Byte Order Mark.

Author: ptrdo

README.md

@@ -260,27 +260,29 @@ Once instantiated in the web client code, the microdata-template can be addresse
 ```javascript
 // In pre-ES6 implementations, the code is exposed to the global namespace: 
 var templater = window.MicrodataTemplate.init();
-templater.getVerson(); // returns current version, e.g. "2.2.2"
+templater.getVerson(); // returns current version, e.g. "2.3.0"
 
 // In ES6 implementations, the import code does not require init() 
 import templater from "./path/to/microdata-template.js";
-templater.getVersion(); // returns current version, e.g. "2.2.2"
+templater.getVersion(); // returns current version, e.g. "2.3.0"
 
 // Defaults are assumed, but configuration can be passed to init: 
 templater.init({
   showHeritage: true, // bypass obj.hasOwnProperty() filtering.
-  strictStandard: true // require Microdata attributes.
+  strictStandard: true, // require Microdata attributes.
+  stripByteOrderMark: false // leave HTML unperturbed.
 });
 ```
 
-| Method Name | Argument(s) | Description |
-|-------------|-------------|-------------|
+| Method Name | Argument(s) | Description                                                               |
+|-------------|-------------|---------------------------------------------------------------------------|
 | `init` | *Object (optional)* | Returns an instance of the microdata-template. Config object is optional. |
-| `render` | *element, data* | Populates the HTML element template with data. |
-| `clear` | *element, callback* | Removes dynamically populated content, retaining the original template. |
-| `refresh` | *element, data* | Makes current a previously rendered template. |
-| `getSetShowHeritage` | *Boolean* | False by default. When true, bypasses obj.hasOwnProperty() filtering. |
-| `getSetStrictStandard` | *Boolean* | False by default. When true, Microdata attributes are always required. |
-| `setTransformer` | *name, func* | Provides for a custom transformer. | 
-| `getTransformers` | *none* | Returns default and custom transformers. |
-| `getVersion` | *none* | Returns the current version. | 
+| `render` | *element, data* | Populates the HTML element template with data.                            |
+| `clear` | *element, callback* | Removes dynamically populated content, retaining the original template.   |
+| `refresh` | *element, data* | Makes current a previously rendered template.                             |
+| `getSetShowHeritage` | *Boolean* | False by default. When true, bypasses obj.hasOwnProperty() filtering.     |
+| `getSetStrictStandard` | *Boolean* | False by default. When true, Microdata attributes are always required.    |
+| `getSetStripByteOrderMark` | *Boolean* | True by default. When true, strips Byte Order Mark from incoming HTML snippets.     |
+| `setTransformer` | *name, func* | Provides for a custom transformer.                                        | 
+| `getTransformers` | *none* | Returns default and custom transformers.                                  |
+| `getVersion` | *none* | Returns the current version.                                              | 

lib/microdata-template.js

@@ -6,9 +6,9 @@
    * An implementation of HTML template by way of the microdata mechanism.
    *
    * @author Peter Sylwester
-   * @copyright (c)2019 Peter Sylwester
+   * @copyright (c)2022 Peter Sylwester
    * @license MIT
-   * @version 2.2.2, 2019/09/16
+   * @version 2.3.0, 2022/05/03
    * @requires "HTML5", "ECMA-262 Edition 5.1"
    *
    *
@@ -177,7 +177,7 @@
 
   /**
    * TODO: Determine if this is only a dubious feature.
-   * @type {Boolean} When true bypasses obj.hasOwnProperty() filtering.
+   * @type {Boolean} When true, bypasses obj.hasOwnProperty() filtering.
    */
   var showHeritage = false;
 
@@ -187,8 +187,15 @@
    * @public via proxy
    * @type {Boolean} When true, requires Microdata attributes for template.
    */
-  var strictStandard = false; 
-
+  var strictStandard = false;
+  
+  /**
+   * stripByteOrderMark removes the marking indicating UTF-8 encoding.
+   * 
+   * @public via proxy
+   * @type {Boolean} When true, strips Byte Order Mark from incoming HTML snippets.
+   */
+  var stripByteOrderMark = true;
 
   /* PRIVATE UTILITIES */
 
@@ -231,8 +238,13 @@
     return clone;
   };
 
-  var findTemplate = function (node) {
-    var candidate;
+  var findTemplate = function (source) {
+    var node, candidate;
+    if (stripByteOrderMark) {
+      node = stripBOM(source);
+    } else {
+      node = source;
+    }
     if (!strictStandard) {
       return node;
     } else if (isTemplate(node)) {
@@ -269,6 +281,15 @@
     return obj === undefined ? "" : obj;
   };
 
+  var stripBOM = function(buf) {
+    var str = buf.toString("utf-8");
+    if(str.charCodeAt(0) === 0xFEFF) {
+      return str.slice(1);
+    } else {
+      return str;
+    }
+  };
+
   /* PRIVATE METHODS */
 
   var clear = function (template, callback) {
@@ -645,6 +666,9 @@
         if ("showHeritage" in config) {
           strictStandard = !!config.showHeritage;
         }
+        if ("stripByteOrderMark" in config) {
+          stripByteOrderMark = !!config.stripByteOrderMark;
+        }
       }
       return this;
     },
@@ -755,6 +779,18 @@
       return showHeritage;
     },
 
+    getSetStripByteOrderMark: function (boo) {
+      /**
+       * @param boo {Boolean} When true, strips Byte Order Mark from incoming HTML snippets.
+       * @returns {Boolean} The current setting.
+       */
+      if (arguments.length > 0) {
+        stripByteOrderMark = !!boo;
+      }
+
+      return showHeritage;
+    },
+
     getSetSource: function (obj) {
 
       if (arguments.length > 0) {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "microdata-template",
-  "version": "2.2.2",
+  "version": "2.3.0",
   "description": "An implementation of HTML template by way of the microdata mechanism.",
   "keywords": [
     "javascript",