Elder.js Shortcode Parser

> This is a fork of meta-shortcodes which adds async support and has updated the tests to support async.

Generic shortcodes parser with support of attributes and single/pair tags.

Usage

``javascript
var should = require("should");
var ShortcodeParser = require("meta-shortcodes");

var parser = ShortcodeParser();

parser.add("test", async function (opts, content) {
return content.toUpperCase();
});

parser.add("nested", async function (opts, content) {
if (!opts.multiply) return "Missing multiply attribute!";

var out = [];

for (var i = 0; i < opts.length; i++)
out.push(opts[i] * parseFloat(opts.multiply));

return out.join(" ");
});

var input =
"Sample [test]shortcode content [nested multiply=2 2 4/] is upper[/test] case!";
var output = await parser.parse(input);

output.should.eql("Sample SHORTCODE CONTENT 4 8 IS UPPER case!");
`

Instalation

`sh
npm install meta-shortcodes
`

API

$3

`javascript
opts = {
openPattern: "\\[",
closePattern: "\\]",
};
`

$3

Registers new shortcode

| Param | Type | Description |
| --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| shortcodeName | string | Name of shortcode tag |
| handlerFunction | function | Function/async function that returns replacement for shortcode. Accepts two arguments - options object and content string. |

$3

Registers new shortcode

| Param | Type | Description |
| -------- | ------ | ------------------------------------------------- |
| inputStr | string | Input string where shortcodes should be replaced. |

Shortcode examples

`text
#Self-closing
[name argument1 argument2 key=value key=value/]

#Pair
[name]content[/name]

#Quoted arguments
[name "argument 1" 'argument 2' "key is"="long value"/]

#Escaping quotes in arguments
[name "argu\"ment" "ke\"y"='val\'ue']

#Escaping of entire shortcode
\\[this shortcode is not processed /]
`

Testing

`sh
npm install --dev
npm test
`

Current code-coverage 97%

Using alternative brackets

`javascript
var should = require("should");
var ShortcodeParser = require("meta-shortcodes");

var parser = ShortcodeParser({
openPattern: "\\{{",
closePattern: "\\}}",
});

parser.add("test", function (opts, content) {
return content.toUpperCase();
});

var output = parser
.parse("Sample {{test}}upper{{/test}} case!")
.should.eql("Sample UPPER case!");
``

License

See License file.