Added block comment support

pugjs · Mar 4, 2011 · a524ef1 · a524ef1
1 parent 916724a
commit a524ef1
Show file tree

Hide file tree

Showing 5 changed files with 77 additions and 0 deletions.
diff --git a/Readme.md b/Readme.md
@@ -17,6 +17,7 @@
   - parse tree manipulation via _filters_
   - supports [Express JS](http://expressjs.com) out of the box
   - transparent iteration over objects, arrays, and even non-enumerables via `- each`
+  - block comments
   - no tag prefix
   - filters
     - :sass must have [sass.js](http://github.com/visionmedia/sass.js) installed
@@ -184,6 +185,25 @@ outputting
     <p>foo</p>
     <p>bar</p>
 
+### Block Comments
+
+ A block comment is the `/` character followed by a block.
+
+      body
+        /
+          #content
+            h1 Example
+
+outputting
+
+    <body>
+      <!--
+      <div id="content">
+        <h1>Example</h1>
+      </div>
+      -->
+    </body>
+
 ### Nesting
 
     ul

diff --git a/lib/compiler.js b/lib/compiler.js
@@ -198,6 +198,19 @@ Compiler.prototype = {
     this.buffer('<!--' + utils.escape(comment.val) + '-->');
   },
 
+  /**
+   * Visit a `BlockComment`.
+   *
+   * @param {Comment} comment
+   * @api public
+   */
+
+  visitBlockComment: function(comment){
+    this.buffer('<!--');
+    this.visit(comment.block);
+    this.buffer('-->');
+  },
+
   /**
    * Visit `code`, respecting buffer / escape flags.
    * If the code is followed by a block, wrap it in

diff --git a/lib/nodes/block-comment.js b/lib/nodes/block-comment.js
@@ -0,0 +1,29 @@
+
+/*!
+ * Jade - nodes - BlockComment
+ * Copyright(c) 2010 TJ Holowaychuk <tj@vision-media.ca>
+ * MIT Licensed
+ */
+
+/**
+ * Module dependencies.
+ */
+
+var Node = require('./node');
+
+/**
+ * Initialize a `BlockComment` with the given `block`.
+ *
+ * @param {Block} block
+ * @api public
+ */
+
+var BlockComment = module.exports = function BlockComment(block) {
+  this.block = block;
+};
+
+/**
+ * Inherit from `Node`.
+ */
+
+BlockComment.prototype.__proto__ = Node.prototype;
diff --git a/lib/nodes/index.js b/lib/nodes/index.js
@@ -13,4 +13,5 @@ exports.Text = require('./text');
 exports.Block = require('./block');
 exports.Filter = require('./filter');
 exports.Comment = require('./comment');
+exports.BlockComment = require('./block-comment');
 exports.Doctype = require('./doctype');
diff --git a/lib/parser.js b/lib/parser.js
@@ -161,6 +161,8 @@ Parser.prototype = {
         return this.parseFilter();
       case 'comment':
         return this.parseComment();
+      case 'block-comment':
+        return this.parseBlockComment();
       case 'text':
         return this.parseText();
       case 'each':
@@ -202,6 +204,18 @@ Parser.prototype = {
     }
     return node;
   },
+
+  /**
+   * block comment
+   */
+
+  parseBlockComment: function(){
+    var tok = this.expect('block-comment')
+      , node = new nodes.BlockComment(this.parseBlock());
+    node.line = this.line;
+    return node;
+  },
+
 
   /**
    * comment