shortcode-tree - npm Package Compare versions

Comparing version 1.1.1 to 1.2.0

index.js

 module.exports.default = require('./src/index');

package.json

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

README.md

@@ -32,2 +32,3 @@ # shortcode-tree
 - Supports tag properties (with or without string literals)
+- Stringify `Shortcode` objects to shortcode text
 
@@ -55,5 +56,5 @@ ## Installation
 
-A shortcode node contains the following properties:
+A shortcode node contains the following fields:
 
-| Property | Type | Description |
+| Field | Type | Description |
 | --- | --- | --- |
@@ -66,5 +67,7 @@ | `text` | string | The raw text content (code) of this node. |
 
-A parsed shortcode. Typically available through the `shortcode` property of a shortcode node.
+A parsed shortcode. Typically available through the `shortcode` field of a shortcode node.
 
-| Property | Type | Description |
+#### Fields
+
+| Field | Type | Description |
 | --- | --- | --- |
@@ -76,4 +79,13 @@ | `name` | string | Tag name |
 | `codeText` | string | The raw shortcode text, as it was parsed. |
-| `offset` | integer | Offset index, relative to the original input string. | 
+| `offset` | integer | Offset index, relative to the original input string. |
 
+#### Methods
+
+| Signature | Returns | Description |
+| --- | --- | --- |
+| `stringify()` | string | Formats the data in the `Shortcode` object to shortcode text |
+| `hasProperty([string] key)` | boolean | Gets whether property with name `key` exists. |
+| `getProperty([string] key)` | value or null | Gets value of property with name `key`, or NULL if not set. |
+| `setProperty([string] key, value)` | void | Add or update property with given key and value. |  
+
 ### The `TextNode` object
@@ -83,3 +95,3 @@
 
-| Property | Type | Description |
+| Field | Type | Description |
 | --- | --- | --- |
@@ -86,0 +98,0 @@ | `text` | string | Raw text or code |

src/index.js

@@ -5,2 +5,3 @@ module.exports = {
     "ShortcodeExtractor": require('./shortcode-extractor'),
+    "ShortcodeFormatter": require('./shortcode-formatter'),
     "Shortcode": require('./shortcode'),
@@ -7,0 +8,0 @@ "ShortcodeNode": require('./shortcode-node'),

src/shortcode-extractor.js

@@ -0,0 +0,0 @@ let ShortcodeParser = require('./shortcode-parser');

src/shortcode-node.js

@@ -0,0 +0,0 @@ let Shortcode = require('./shortcode');

src/shortcode-parser.js

@@ -0,0 +0,0 @@ let Shortcode = require('./shortcode');

src/shortcode-tree.js

@@ -0,0 +0,0 @@ let ShortcodeExtractor = require('./shortcode-extractor');

src/shortcode.js

@@ -0,1 +1,3 @@
+let ShortcodeFormatter = require('./shortcode-formatter');
+
 class Shortcode {
@@ -26,4 +28,12 @@ constructor (name, content, properties, isSelfClosing, codeText, offset) {
     }
+
+    stringify() {
+        return ShortcodeFormatter.stringify(this);
+    }
+
+    toString() {
+        return this.stringify();
+    }
 }
 
 module.exports = Shortcode;

src/text-node.js

@@ -0,0 +0,0 @@ class TextNode {

test/shortcode-extractor.test.js

@@ -0,0 +0,0 @@ let ShortcodeExtractor = require('../src').ShortcodeExtractor;

test/shortcode-parser.test.js

@@ -0,0 +0,0 @@ let ShortcodeParser = require('../src').ShortcodeParser;

test/shortcode-tree.test.js

@@ -0,0 +0,0 @@ let ShortcodeTree = require('../src').ShortcodeTree;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

55040

increased by11.8%

Number of package files

26

increased by8.33%

Lines of code

929

increased by18.04%

Number of lines in readme file

184

increased by6.98%

No dependency changes