shortcode-tree - npm Package Compare versions

Comparing version 1.4.4 to 1.4.5

dist/shortcode-parser.js

@@ -58,8 +58,4 @@ "use strict";
 
-        var predictedAsSelfClosing = input.indexOf(closingTagExpected) === -1;
-
-        if (predictedAsSelfClosing) {
-            shortcode.isSelfClosing = true;
-        } else {
-            shortcode.isSelfClosing = false;
+        if (options.predictSelfClosing) {
+            shortcode.isSelfClosing = input.indexOf(closingTagExpected) === -1;
         }
@@ -127,4 +123,8 @@
                         var blockName = nextBlockInfo.name;
-                        // console.log(nextBlockInfo);
 
+                        if (options.predictSelfClosing) {
+                            var nextClosingTagExpected = "[/" + blockName + "]";
+                            nextBlockInfo.isSelfClosing = bufferRemainder.indexOf(nextClosingTagExpected) === -1;
+                        }
+
                         if (!nextBlockInfo.isSelfClosing) {
@@ -307,6 +307,8 @@ stackLevel++;
 
-        if (!shortcode.isSelfClosing && options.selfClosingTags.indexOf(shortcode.name) > -1) {
-            // Explicitly listed in options as a naughty, misbehaving self-closing tag
-            // This is one unfortunate scenario where we simply cannot parse blindly :-(
-            shortcode.isSelfClosing = true;
+        if (!options.predictSelfClosing) {
+            if (!shortcode.isSelfClosing && options.selfClosingTags.indexOf(shortcode.name) > -1) {
+                // Explicitly listed in options as a naughty, misbehaving self-closing tag
+                // This is one unfortunate scenario where we simply cannot parse blindly :-(
+                shortcode.isSelfClosing = true;
+            }
         }
@@ -366,5 +368,13 @@ }
      */
-    selfClosingTags: []
+    selfClosingTags: [],
+
+    /**
+     * If enabled, self-closing tags will be predicted by checking if any closing tags can be found.
+     * This generally improves stability, but will break horribly if your tags are only "sometimes" self-closing.
+     *
+     * @type boolean
+     */
+    predictSelfClosing: true
 };
 
 module.exports = ShortcodeParser;

package.json

 {
   "name": "shortcode-tree",
-  "version": "1.4.4",
+  "version": "1.4.5",
   "description": "Parser library for reading short codes (BB codes) into a tree structure",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -153,3 +153,4 @@ # shortcode-tree
 | `precise` | boolean | `false` | If things aren't working as expected, enable this for deep recursive parsing. Reduces performance exponentially. |
-| `selfClosingTags` | array | `[]` | You can specify a list of tags that should always be treated as self-closing. Needed when they don't use the "[selfcloser/]" syntax. |    
+| `selfClosingTags` | array | `[]` | You can specify a list of tags that should always be treated as self-closing. Needed when they don't use the "[selfcloser/]" syntax. |
+| `predictSelfClosing` | bool | `true` | If enabled, self-closing tags will be predicted by checking if any closing tags can be found anywhere in the input buffer. Improves stability in most situations, but breaks if your tags are "sometimes" self closing. |    
 
@@ -156,0 +157,0 @@ The default options are defined in `ShortcodeParser.DEFAULT_OPTIONS`.

test/shortcode-tree.test.js

@@ -121,2 +121,12 @@ let ShortcodeTree = require('../src').ShortcodeTree;
     });
+
+    it('parses nested, self-closing tags with inconsistent syntax, and without options entry, correctly (prediction)', function () {
+        let testInput = `[vc_row_inner][mk_image_slideshow][/vc_row_inner]`;
+
+        let parsed = ShortcodeTree.parse(testInput);
+        expect(parsed.children.length).to.equal(1);
+
+        let columnNode = parsed.children[0];
+        expect(columnNode.children.length).to.equal(1);
+    });
 });
@@ -123,0 +133,0 @@

No alert changes

Improved metrics

Total package byte prevSize

69346

increased by1.74%

Lines of code

1211

increased by1.34%

Number of lines in readme file

198

increased by0.51%

No dependency changes