shelving 1.51.0 → 1.51.1

package/markup/render.js

@@ -15,12 +15,12 @@ function renderString(content, options) {
         let matchedRule = undefined;
         let matchedResult = undefined;
         for (const rule of options.rules) {
-            const { priority = 0, match, contexts } = rule;
+            const { priority = 0, match, regexp, contexts } = rule;
             // Only apply this rule if both:
             // 1. The priority is equal or higher to the current priority.
             // 2. The rule is allowed in the current context.
             if (priority >= matchedPriority && contexts.includes(options.context)) {
-                const result = match(content, options);
+                const result = match ? match(content, options) : regexp ? content.match(regexp) : null;
                 // If this matched and has an index (it might not if it's a `/g` global RegExp, which would be a mistake).
                 if (result && typeof result.index === "number") {
                     const index = result.index;

package/markup/rules.js

@@ -3,8 +3,6 @@ import { formatUrl, toURL, getLineRegExp, MATCH_LINE, getBlockRegExp, MATCH_BLOC
 const BULLETS = "-*•+"; // Anything that can be a bullet (used for unordered lists and horizontal rules).
 // Regular expressions.
 const REPLACE_INDENT = /^ {1,2}/gm;
-// Regular expression makers.
-const getMatcher = regexp => content => content.match(regexp);
 /**
  * Headings are single line only (don't allow multiline).
  * - 1-6 hashes then 1+ spaces, then the title.
@@ -12,7 +10,7 @@ const getMatcher = regexp => content => content.match(regexp);
  * - Markdown's underline syntax is not supported (for simplification).
  */
 export const HEADING_RULE = {
-    match: getMatcher(getLineRegExp(`(#{1,6}) +(${MATCH_LINE})`)),
+    regexp: getLineRegExp(`(#{1,6}) +(${MATCH_LINE})`),
     render: ([, prefix = "", children = ""]) => ({ type: `h${prefix.length}`, key: null, props: { children } }),
     contexts: ["block"],
     childContext: "inline",
@@ -25,7 +23,7 @@ export const HEADING_RULE = {
  * - Might have infinite number of spaces between the characters.
  */
 export const HORIZONTAL_RULE = {
-    match: getMatcher(getLineRegExp(`([${BULLETS}])(?: *\\1){2,}`)),
+    regexp: getLineRegExp(`([${BULLETS}])(?: *\\1){2,}`),
     render: () => ({ type: "hr", key: null, props: {} }),
     contexts: ["block"],
 };
@@ -38,7 +36,7 @@ export const HORIZONTAL_RULE = {
  */
 const UNORDERED = `[${BULLETS}] +`; // Anything that can be a bullet (used for unordered lists and horizontal rules).
 export const UNORDERED_LIST_RULE = {
-    match: getMatcher(getBlockRegExp(`${UNORDERED}(${MATCH_BLOCK})`)),
+    regexp: getBlockRegExp(`${UNORDERED}(${MATCH_BLOCK})`),
     render: ([, list = ""]) => {
         const children = list.split(SPLIT_UL_ITEMS).map(mapUnorderedItem);
         return { type: "ul", key: null, props: { children } };
@@ -58,7 +56,7 @@ const mapUnorderedItem = (item, key) => {
  */
 const ORDERED = "[0-9]+[.):] +"; // Number for a numbered list (e.g. `1.` or `2)` or `3:`)
 export const ORDERED_LIST_RULE = {
-    match: getMatcher(getBlockRegExp(`(${ORDERED}${MATCH_BLOCK})`)),
+    regexp: getBlockRegExp(`(${ORDERED}${MATCH_BLOCK})`),
     render: ([, list = ""]) => {
         const children = list.split(SPLIT_OL_ITEMS).map(mapOrderedItem);
         return { type: "ol", key: null, props: { children } };
@@ -83,7 +81,7 @@ const mapOrderedItem = (item, key) => {
  * - Quote indent symbol can be followed by zero or more spaces.
  */
 export const BLOCKQUOTE_RULE = {
-    match: getMatcher(getLineRegExp(`(>${MATCH_LINE}(?:\\n>${MATCH_LINE})*)`)),
+    regexp: getLineRegExp(`(>${MATCH_LINE}(?:\\n>${MATCH_LINE})*)`),
     render: ([, quote = ""]) => ({
         type: "blockquote",
         key: null,
@@ -102,7 +100,7 @@ const BLOCKQUOTE_LINES = /^>/gm;
  */
 export const FENCED_CODE_RULE = {
     // Matcher has its own end that only stops when it reaches a matching closing fence or the end of the string.
-    match: getMatcher(getBlockRegExp(`(\`{3,}|~{3,}) *(${MATCH_LINE})\\n(${MATCH_BLOCK})`, `\\n\\1\\n+|\\n\\1$|$`)),
+    regexp: getBlockRegExp(`(\`{3,}|~{3,}) *(${MATCH_LINE})\\n(${MATCH_BLOCK})`, `\\n\\1\\n+|\\n\\1$|$`),
     render: ([, , file, children]) => ({
         type: "pre",
         key: null,
@@ -121,7 +119,7 @@ export const FENCED_CODE_RULE = {
  * - When ordering rules, paragraph should go after other "block" context elements (because it has a very generous capture).
  */
 export const PARAGRAPH_RULE = {
-    match: getMatcher(getBlockRegExp(` *(${MATCH_BLOCK})`)),
+    regexp: getBlockRegExp(` *(${MATCH_BLOCK})`),
     render: ([, children]) => ({ type: `p`, key: null, props: { children } }),
     contexts: ["block"],
     childContext: "inline",
@@ -137,8 +135,9 @@ export const PARAGRAPH_RULE = {
  */
 export const LINK_MARKUP = {
     // Custom matcher to check the URL against the allowed schemes.
+    regexp: /\[([^\]]*?)\]\(([^)]*?)\)/,
     match: (content, { schemes, url: base }) => {
-        const matches = content.match(MATCH_LINK);
+        const matches = content.match(LINK_MARKUP.regexp);
         if (matches && typeof matches.index === "number") {
             const [, title = "", href = ""] = matches;
             const url = toURL(href, base);
@@ -157,7 +156,6 @@ export const LINK_MARKUP = {
     contexts: ["inline", "list"],
     childContext: "link",
 };
-const MATCH_LINK = /\[([^\]]*?)\]\(([^)]*?)\)/;
 /**
  * Autolinked URL starts with `http:` or `https:` and matches an unlimited number of non-space characters.
  * - If followed by space and then text in `()` round or `[]` square brackets that will be used as the title, e.g. `http://google.com/maps (Google Maps)` or `http://google.com/maps [Google Maps]` (this syntax is from Todoist and maybe other things too).
@@ -167,8 +165,9 @@ const MATCH_LINK = /\[([^\]]*?)\]\(([^)]*?)\)/;
  */
 export const AUTOLINK_RULE = {
     // Custom matcher to check the URL against the allowed schemes.
+    regexp: /([a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]:\S+)(?: +(?:\(([^)]*?)\)|\[([^\]]*?)\]))?/,
     match: (content, { schemes, url: base }) => {
-        const matches = content.match(MATCH_AUTOLINK);
+        const matches = content.match(AUTOLINK_RULE.regexp);
         if (matches && typeof matches.index === "number") {
             const [, href = "", title1 = "", title2 = ""] = matches;
             const url = toURL(href, base);
@@ -183,7 +182,6 @@ export const AUTOLINK_RULE = {
     contexts: ["inline", "list"],
     childContext: "link",
 };
-const MATCH_AUTOLINK = /([a-z][a-z0-9-]*[a-z0-9]:\S+)(?: +(?:\(([^)]*?)\)|\[([^\]]*?)\]))?/i;
 /**
  * Inline code.
  * - Text surrounded by one or more "`" backtick tilde characters.
@@ -192,7 +190,7 @@ const MATCH_AUTOLINK = /([a-z][a-z0-9-]*[a-z0-9]:\S+)(?: +(?:\(([^)]*?)\)|\[([^\
  * - Same as Markdown syntax.
  */
 export const CODE_RULE = {
-    match: getMatcher(getWrapRegExp("`+", MATCH_BLOCK)),
+    regexp: getWrapRegExp("`+", MATCH_BLOCK),
     render: ([, , children]) => ({ type: "code", key: null, props: { children } }),
     contexts: ["inline", "list"],
     priority: 10, // Higher priority than other inlines so it matches first before e.g. `strong` or `em` (from CommonMark spec: "Code span backticks have higher precedence than any other inline constructs except HTML tags and autolinks.")
@@ -206,7 +204,7 @@ export const CODE_RULE = {
  * - Different to Markdown: strong is always surrounded by `*asterisks*` and emphasis is always surrounded by `_underscores_` (strong isn't 'double emphasis').
  */
 export const STRONG_MARKUP = {
-    match: getMatcher(getWrapRegExp("\\*+")),
+    regexp: getWrapRegExp("\\*+"),
     render: ([, , children]) => ({ type: "strong", key: null, props: { children } }),
     contexts: ["inline", "list", "link"],
     childContext: "inline",
@@ -220,7 +218,7 @@ export const STRONG_MARKUP = {
  * - Different to Markdown: strong is always surrounded by `*asterisks*` and emphasis is always surrounded by `_underscores_` (strong isn't 'double emphasis').
  */
 export const EMPHASIS_RULE = {
-    match: getMatcher(getWrapRegExp("_+")),
+    regexp: getWrapRegExp("_+"),
     render: ([, , children]) => ({ type: "em", key: null, props: { children } }),
     contexts: ["inline", "list", "link"],
     childContext: "inline",
@@ -234,7 +232,7 @@ export const EMPHASIS_RULE = {
  * - Markdown doesn't have this.
  */
 export const INSERT_RULE = {
-    match: getMatcher(getWrapRegExp("\\+\\++")),
+    regexp: getWrapRegExp("\\+\\++"),
     render: ([, , children]) => ({ type: "ins", key: null, props: { children } }),
     contexts: ["inline", "list", "link"],
     childContext: "inline",
@@ -248,7 +246,7 @@ export const INSERT_RULE = {
  * - Markdown doesn't have this.
  */
 export const DELETE_RULE = {
-    match: getMatcher(getWrapRegExp("--+|~~+")),
+    regexp: getWrapRegExp("--+|~~+"),
     render: ([, , children]) => ({ type: "del", key: null, props: { children } }),
     contexts: ["inline", "list", "link"],
     childContext: "inline",
@@ -262,7 +260,7 @@ export const DELETE_RULE = {
  *   - This works better with textareas that wrap text (since manually breaking up long lines is no longer necessary).
  */
 export const LINEBREAK_RULE = {
-    match: getMatcher(/\n/),
+    regexp: /\n/,
     render: () => ({ type: "br", key: null, props: {} }),
     contexts: ["inline", "list", "link"],
     childContext: "inline",

package/markup/types.d.ts

@@ -18,8 +18,10 @@ export declare type MarkupElementProps = {
 export declare type MarkupNode = undefined | null | string | MarkupElement | MarkupNode[];
 /** A single markup parsing rule. */
 export declare type MarkupRule = {
-    /** RegExp that matches this rule. */
-    readonly match: MarkupRuleMatcher;
+    /** RegExp for matching this rule. */
+    readonly regexp: RegExp;
+    /** Custom matching function for this rule (overrides `regexp` if present. */
+    readonly match?: (content: string, options: MarkupOptions) => RegExpMatchArray | null | undefined | void;
     /**
      * Return a corresponding JSX element for the match.
      * @param ...matches The matches from `match` RegExp (without the `0` zeroeth "whole match").
@@ -27,7 +29,7 @@ export declare type MarkupRule = {
      *   - The `key` property is not required (will be set automatically).
      *   - e.g. `{ type: "a", props: { href: "/example.html", className: "strong", children: "Children *can* include _syntax_" } }`
      */
-    readonly render: MarkupRuleRenderer;
+    readonly render: (matches: RegExpMatchArray, options: MarkupOptions) => MarkupElement;
     /** Apply the rule only when in certain contexts, e.g. `["block", "inline", "list"]` */
     readonly contexts: string[];
     /** Context any string children returned from `render()` should be rendered with. */
@@ -42,8 +44,6 @@ export declare type MarkupRule = {
      */
     readonly priority?: number;
 };
-export declare type MarkupRuleMatcher = (content: string, options: MarkupOptions) => RegExpMatchArray | null | undefined | void;
-export declare type MarkupRuleRenderer = (matches: RegExpMatchArray, options: MarkupOptions) => MarkupElement;
 /** A set of parse rules (as an object or array). */
 export declare type MarkupRules = Iterable<MarkupRule>;
 /** The current parsing options (represents the current state of the parsing). */
@@ -59,5 +59,3 @@ export declare type MarkupOptions = {
     /** Valid URL schemes/protocols for links (including trailing commas), defaults to `[`http:`, `https:`]` */
     readonly schemes: string[];
 };
-/** The create element function. */
-export declare type MarkupElementCreator = (type: string, props?: MarkupElementProps | null) => MarkupElement;

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.51.0",
+	"version": "1.51.1",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",