v0.0.3

Author: stevenvachon

README.md

@@ -1,8 +1,34 @@
-# handlebars-react
-> Compile Handlebars templates to [React](https://facebook.github.io/react/).
+# handlebars-html-parser
+> Parse Handlebars and HTML.
+
+Parse this:
+```handlebars
+<{{tag}}>value</{{tag}}>
+```
+into this:
+```js
+[
+ { type:"htmlTagStart", closing:false },
+ { type:"htmlTagNameStart" },
+ { type:"hbsVariable", id:"tag" },
+ { type:"htmlTagNameEnd" },
+ { type:"text", text:"value" },
+ { type:"htmlTagStart", closing:true },
+ { type:"htmlTagNameStart" },
+ { type:"hbsVariable", id:"tag" },
+ { type:"htmlTagNameEnd" },
+ { type:"htmlTagEnd" }
+]
+```
+…for use in compiling to something like a virtual DOM, such that of [handlebars-react](https://github.com/stevenvachon/handlebars-react).
+
+For more information on the strengths, weaknesses and implementation details of this library, check out the [wiki](https://github.com/stevenvachon/handlebars-html-parser/wiki).
 
 ## FAQ
-1. **Why not use [parse5](https://npmjs.com/package/parse5)?** 
+1. **How is this different from [HTMLBars](https://github.com/tildeio/htmlbars)?** 
+HTMLBars *builds* a DOM whereas this library *allows* you to build a DOM and even a virtual DOM.
+
+2. **Why not use [parse5](https://npmjs.com/package/parse5)?** 
 As of v1.2.0, it is not forgiving enough, in that it will parse `<{{tag}}>asdf</{{tag}}>` as text instead of HTML.
 
 ## Roadmap Features
@@ -11,12 +37,5 @@ As of v1.2.0, it is not forgiving enough, in that it will parse `<{{tag}}>asdf</
 * `options.ignoreComments` to omit html comments from compiling
 * `options.mustacheOnly` that disables helpers
 
-## api idea
-https://github.com/isaacs/sax-js#usage
-
-## ast type ideas
-https://github.com/blakeembrey/dombars/blob/master/lib/compiler/base.js
-https://github.com/mikepb/jade-react-compiler/blob/master/lib/builder.js
-
-## template idea
-https://github.com/duncanbeevers/jade-react
+## Changelog
+* 0.0.1–0.0.3 pre-releases

lib/NodeTypes.js

@@ -0,0 +1,26 @@
+"use strict";
+module.exports = 
+{
+HBS_COMMENT_END: "hbsCommentEnd",
+HBS_COMMENT_START: "hbsCommentStart",
+HBS_HELPER_END: "hbsHelperEnd",
+HBS_HELPER_START: "hbsHelperStart",
+HBS_SECTION_END: "hbsSectionEnd",
+HBS_SECTION_START: "hbsSectionStart",
+HBS_VARIABLE: "hbsVariable",
+
+HTML_ATTR_END: "htmlAttrEnd",
+HTML_ATTR_NAME_END: "htmlAttrNameEnd",
+HTML_ATTR_NAME_START: "htmlAttrNameStart",
+HTML_ATTR_START: "htmlAttrStart",
+HTML_ATTR_VALUE_END: "htmlAttrValueEnd",
+HTML_ATTR_VALUE_START: "htmlAttrValueStart",
+HTML_COMMENT_END: "htmlCommentEnd",
+HTML_COMMENT_START: "htmlCommentStart",
+HTML_TAG_END: "htmlTagEnd",
+HTML_TAG_NAME_END: "htmlTagNameEnd",
+HTML_TAG_NAME_START: "htmlTagNameStart",
+HTML_TAG_START: "htmlTagStart",
+
+TEXT: "text"
+};

lib/Nodes.js

@@ -0,0 +1,119 @@
+//"use strict";
+var NodeTypes = require("./NodeTypes");
+var Nodes = {};
+
+for (var i in NodeTypes)
+{
+if (NodeTypes.hasOwnProperty(i) === false) continue;
+
+switch (NodeTypes[i])
+{
+case NodeTypes.HBS_HELPER_END:
+{
+Nodes[i] = function(statement)
+{
+return {
+type: NodeTypes.HBS_HELPER_END,
+id: statement.mustache.id.string,
+//statement: statement
+};
+};
+break;
+}
+
+
+case NodeTypes.HBS_HELPER_START:
+{
+Nodes[i] = function(statement)
+{
+return {
+type: NodeTypes.HBS_HELPER_START,
+id: statement.mustache.id.string,
+params: statement.mustache.params.map( function(param){ return param.string }),
+//statement: statement
+};
+};
+break;
+}
+
+
+case NodeTypes.HBS_SECTION_END:
+{
+Nodes[i] = function(statement)
+{
+return {
+type: NodeTypes.HBS_SECTION_END,
+id: statement.mustache.id.string,
+//statement: statement
+};
+};
+break;
+}
+
+
+case NodeTypes.HBS_SECTION_START:
+{
+Nodes[i] = function(statement)
+{
+return {
+type: NodeTypes.HBS_SECTION_START,
+id: statement.mustache.id.string,
+params: statement.mustache.params.parts,// ?
+//statement: statement
+};
+};
+break;
+}
+
+
+case NodeTypes.HBS_VARIABLE:
+{
+Nodes[i] = function(statement)
+{
+return {
+type: NodeTypes.HBS_VARIABLE,
+id: statement.id.string,
+//statement: statement
+};
+};
+break;
+}
+
+
+case NodeTypes.HTML_TAG_START:
+{
+Nodes[i] = function(closing)
+{
+return {
+type: NodeTypes.HTML_TAG_START,
+closing: !!closing
+};
+};
+break;
+}
+
+
+case NodeTypes.TEXT:
+{
+Nodes[i] = function(text)
+{
+return {
+type:NodeTypes.TEXT,
+text:text
+};
+};
+break;
+}
+
+
+default:
+{
+// Simple types are references for speed
+Nodes[i] = { type:NodeTypes[i] };
+}
+}
+}
+
+
+
+module.exports = Nodes;

lib/devlog.js

@@ -0,0 +1,131 @@
+"use strict";
+// TODO :: call this debug-inspect? a plugin for debug package?
+var util = require("util");
+
+var trimPattern = new RegExp([
+"^(\\[) ?",// group $1, must start with "[" or "[ "
+"([\\s\\S]*?)",// group $2, any char(s) 0 or more times (matching the least amount possible)
+"(?:",// non-capturing group
+",?\\s*",// optional ", " or ", " etc
+"\\[length]: ",// array length for `all()`
+"(?:\\x1B\\[\\d+m)?",// optional ansi color start
+"\\d+",// number(s)
+"(?:\\x1B\\[\\d+m)?",// optional ansi color end
+")?",// optional
+" ?(])$"// group $3, must end in "]" or " ]"
+].join(""));
+
+
+
+function log(args, options)
+{
+var data = parseArgs(args);
+var str = util.inspect(data.args, options);
+str = trim(str, data.trimLength, data.unencapsulate);
+
+console.log(str);
+}
+
+
+
+function parseArgs(args)
+{
+var result, trimLength=false, unencapsulate=false;
+
+switch (args.length)
+{
+case 0:
+{
+result = "";
+break;
+}
+case 1:
+{
+result = args[0];
+
+if (Object.prototype.toString.call(result) === "[object Array]")
+{
+trimLength = true;
+unencapsulate = result.length > 0;
+}
+break;
+}
+default:
+{
+// Return regular array instead of special arguments object
+var argsArray = [];
+for (var i=0; i<args.length; i++)
+{
+argsArray.push( args[i] );
+}
+
+result = argsArray;
+trimLength = true;
+unencapsulate = true;
+}
+}
+
+return { args:result, trimLength:trimLength, unencapsulate:unencapsulate };
+}
+
+
+
+function trim(str, trimLength, unencapsulate)
+{
+if (trimLength===true || unencapsulate===true)
+{
+var groups = (unencapsulate===true) ? "$2" : "$1$2$3";
+
+return str.replace(trimPattern, groups);
+}
+else
+{
+return str;
+}
+}
+
+
+
+// Public API
+
+
+
+function inspect()
+{
+log.apply(null, [arguments, {depth:null, colors:true}]);
+}
+
+
+
+inspect.all = function()
+{
+log.apply(null, [arguments, {depth:null, showHidden:true, colors:true}]);
+};
+
+
+
+inspect.basic = function()
+{
+console.log.apply(null, arguments);
+};
+
+
+
+/*inspect("asdf");
+inspect("asdf", 123);
+inspect("asdf");
+
+console.log("==========");
+
+inspect.all( { asdf1:{asdf:{asdf:["asdf"]}}, asdf2:"asdf" }, ["asdf"] );
+console.log( { asdf1:{asdf:{asdf:["asdf"]}}, asdf2:"asdf" }, ["asdf"] );
+
+console.log("==========");
+
+inspect.all([]);
+inspect([]);
+console.log( util.inspect([], {depth:null, colors:true}) );*/
+
+
+
+module.exports = inspect;