@hewes/shortcode v0.1.2

A Simple ShortCode Parser

Tokenize a string to an AST (sic) of shortcode/text nodes

When rendering an AST of "content" you end up with text nodes, that may contain so called "shortcodes". You would like to handle these shortcodes differently than text nodes. You can use this to parse the text node into text and shortcode nodes to continue the rendering.

Features

• Attribute support
  • String attribute values (i.e. quoted string value)
  • Number attribute values (i.e. unquoted number value)
  • Boolean attribute values (i.e. unquoted boolean value)
    • Default Boolean value (i.e. without a value is true)
• Customizable start/end tags

Usage

Install

npm install @hewes/shortcode

Use

import { parse } from "@hewes/shortcode"

const nodes = parse("[shortcode]");

Produces

[
  {
    "type": "shortcode",
    "token": "[shortcode]",
    "name": "shortcode"
  }
]

Examples

See Examples

Credits

• @borgar for https://gist.github.com/borgar/451393/7698c95178898c9466214867b46acb2ab2f56d68 (currently used to get it going)