diff --git a/client/homebrew/brewRenderer/brewRenderer.jsx b/client/homebrew/brewRenderer/brewRenderer.jsx
index 9208a2b90..58dd59bee 100644
--- a/client/homebrew/brewRenderer/brewRenderer.jsx
+++ b/client/homebrew/brewRenderer/brewRenderer.jsx
@@ -89,15 +89,16 @@ const BrewRenderer = (props)=>{
}));
};
- const shouldRender = (index)=>{
- if(!state.isMounted) return false;
+ const isInView = (index)=>{
+ if(!state.isMounted)
+ return false;
+
+ if(index == props.currentEditorPage) //Already rendered before this step
+ return false;
if(Math.abs(index - state.viewablePageNumber) <= 3)
return true;
- if(index + 1 == props.currentEditorPage)
- return true;
-
return false;
};
@@ -138,7 +139,7 @@ const BrewRenderer = (props)=>{
return ;
} else {
cleanPageText += `\n\n \n\\column\n `; //Artificial column break at page end to emulate column-fill:auto (until `wide` is used, when column-fill:balance will reappear)
- const html = Markdown.render(cleanPageText);
+ const html = Markdown.render(cleanPageText, index);
return ;
}
};
@@ -150,8 +151,11 @@ const BrewRenderer = (props)=>{
if(rawPages.length != renderedPages.length) // Re-render all pages when page count changes
renderedPages.length = 0;
+ // Render currently-edited page first so cross-page effects (variables, links) can propagate out first
+ renderedPages[props.currentEditorPage] = renderPage(rawPages[props.currentEditorPage], props.currentEditorPage);
+
_.forEach(rawPages, (page, index)=>{
- if((shouldRender(index) || !renderedPages[index]) && typeof window !== 'undefined'){
+ if((isInView(index) || !renderedPages[index]) && typeof window !== 'undefined'){
renderedPages[index] = renderPage(page, index); // Render any page not yet rendered, but only re-render those in PPR range
}
});
diff --git a/client/homebrew/brewRenderer/notificationPopup/notificationPopup.jsx b/client/homebrew/brewRenderer/notificationPopup/notificationPopup.jsx
index 3c706d6f7..5a870c108 100644
--- a/client/homebrew/brewRenderer/notificationPopup/notificationPopup.jsx
+++ b/client/homebrew/brewRenderer/notificationPopup/notificationPopup.jsx
@@ -25,13 +25,10 @@ const NotificationPopup = createClass({
return (
<>
- Broken default logo on CoverPage
- If you have used the Cover Page snippet and notice the Naturalcrit
- logo is showing as a broken image, this is due to some small tweaks
- of this BETA feature. To fix the logo in your cover page, rename
- the image link "/assets/naturalCritLogoRed.svg". Remember
- that any snippet marked "BETA" may have a similar change in the
- future as we encounter any bugs or reworks.
+ Don't store IMAGES in Google Drive
+ Google Drive is not an image service, and will block images from being used
+ in brews if they get more views than expected. Google has confirmed they won't fix
+ this, so we recommend you look for another image hosting service such as imgur, ImgBB or Google Photos.
diff --git a/client/homebrew/pages/basePages/listPage/brewItem/brewItem.jsx b/client/homebrew/pages/basePages/listPage/brewItem/brewItem.jsx
index b5e79e15a..90f9d32f2 100644
--- a/client/homebrew/pages/basePages/listPage/brewItem/brewItem.jsx
+++ b/client/homebrew/pages/basePages/listPage/brewItem/brewItem.jsx
@@ -135,7 +135,11 @@ const BrewItem = createClass({
> : <>>
}
- {brew.authors.map((item) => {item})}
+ {brew.authors?.map((author, index)=>(
+ <>
+ {author}
+ {index < brew.authors.length - 1 && ', '}
+ >))}
diff --git a/client/homebrew/pages/editPage/editPage.jsx b/client/homebrew/pages/editPage/editPage.jsx
index bec60d6a8..d5af310b5 100644
--- a/client/homebrew/pages/editPage/editPage.jsx
+++ b/client/homebrew/pages/editPage/editPage.jsx
@@ -113,7 +113,7 @@ const EditPage = createClass({
brew : { ...prevState.brew, text: text },
isPending : true,
htmlErrors : htmlErrors,
- currentEditorPage : this.refs.editor.getCurrentPage()
+ currentEditorPage : this.refs.editor.getCurrentPage() - 1 //Offset index since Marked starts pages at 0
}), ()=>{if(this.state.autoSave) this.trySave();});
},
diff --git a/client/homebrew/pages/homePage/homePage.jsx b/client/homebrew/pages/homePage/homePage.jsx
index 9802517b1..3d3139e74 100644
--- a/client/homebrew/pages/homePage/homePage.jsx
+++ b/client/homebrew/pages/homePage/homePage.jsx
@@ -31,9 +31,10 @@ const HomePage = createClass({
},
getInitialState : function() {
return {
- brew : this.props.brew,
- welcomeText : this.props.brew.text,
- error : undefined
+ brew : this.props.brew,
+ welcomeText : this.props.brew.text,
+ error : undefined,
+ currentEditorPage : 0
};
},
handleSave : function(){
@@ -53,7 +54,8 @@ const HomePage = createClass({
},
handleTextChange : function(text){
this.setState((prevState)=>({
- brew : { ...prevState.brew, text: text }
+ brew : { ...prevState.brew, text: text },
+ currentEditorPage : this.refs.editor.getCurrentPage() - 1 //Offset index since Marked starts pages at 0
}));
},
renderNavbar : function(){
@@ -85,7 +87,12 @@ const HomePage = createClass({
renderer={this.state.brew.renderer}
showEditButtons={false}
/>
-
+
diff --git a/client/homebrew/pages/newPage/newPage.jsx b/client/homebrew/pages/newPage/newPage.jsx
index 470c90b89..9877651c2 100644
--- a/client/homebrew/pages/newPage/newPage.jsx
+++ b/client/homebrew/pages/newPage/newPage.jsx
@@ -38,11 +38,12 @@ const NewPage = createClass({
const brew = this.props.brew;
return {
- brew : brew,
- isSaving : false,
- saveGoogle : (global.account && global.account.googleId ? true : false),
- error : null,
- htmlErrors : Markdown.validate(brew.text)
+ brew : brew,
+ isSaving : false,
+ saveGoogle : (global.account && global.account.googleId ? true : false),
+ error : null,
+ htmlErrors : Markdown.validate(brew.text),
+ currentEditorPage : 0
};
},
@@ -104,8 +105,9 @@ const NewPage = createClass({
if(htmlErrors.length) htmlErrors = Markdown.validate(text);
this.setState((prevState)=>({
- brew : { ...prevState.brew, text: text },
- htmlErrors : htmlErrors
+ brew : { ...prevState.brew, text: text },
+ htmlErrors : htmlErrors,
+ currentEditorPage : this.refs.editor.getCurrentPage() - 1 //Offset index since Marked starts pages at 0
}));
localStorage.setItem(BREWKEY, text);
},
@@ -220,7 +222,15 @@ const NewPage = createClass({
onMetaChange={this.handleMetaChange}
renderer={this.state.brew.renderer}
/>
-
+
;
diff --git a/package-lock.json b/package-lock.json
index 4aa616e4c..be38f6a32 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -21,6 +21,7 @@
"cookie-parser": "^1.4.6",
"create-react-class": "^15.7.0",
"dedent-tabs": "^0.10.3",
+ "expr-eval": "^2.0.2",
"express": "^4.18.2",
"express-async-handler": "^1.2.0",
"express-static-gzip": "2.1.7",
@@ -35,13 +36,13 @@
"marked-smartypants-lite": "^1.0.2",
"markedLegacy": "npm:marked@^0.3.19",
"moment": "^2.30.1",
- "mongoose": "^8.1.1",
+ "mongoose": "^8.1.3",
"nanoid": "3.3.4",
"nconf": "^0.12.1",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-frame-component": "^4.1.3",
- "react-router-dom": "6.22.0",
+ "react-router-dom": "6.22.1",
"sanitize-filename": "1.6.3",
"superagent": "^8.1.2",
"vitreum": "git+https://git@github.com/calculuschild/vitreum.git"
@@ -2837,9 +2838,9 @@
}
},
"node_modules/@remix-run/router": {
- "version": "1.15.0",
- "resolved": "https://registry.npmjs.org/@remix-run/router/-/router-1.15.0.tgz",
- "integrity": "sha512-HOil5aFtme37dVQTB6M34G95kPM3MMuqSmIRVCC52eKV+Y/tGSqw9P3rWhlAx6A+mz+MoX+XxsGsNJbaI5qCgQ==",
+ "version": "1.15.1",
+ "resolved": "https://registry.npmjs.org/@remix-run/router/-/router-1.15.1.tgz",
+ "integrity": "sha512-zcU0gM3z+3iqj8UX45AmWY810l3oUmXM7uH4dt5xtzvMhRtYVhKGOmgOd1877dOPPepfCjUv57w+syamWIYe7w==",
"engines": {
"node": ">=14.0.0"
}
@@ -6036,6 +6037,11 @@
"node": "^14.15.0 || ^16.10.0 || >=18.0.0"
}
},
+ "node_modules/expr-eval": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/expr-eval/-/expr-eval-2.0.2.tgz",
+ "integrity": "sha512-4EMSHGOPSwAfBiibw3ndnP0AvjDWLsMvGOvWEZ2F96IGk0bIVdjQisOHxReSkE13mHcfbuCiXw+G4y0zv6N8Eg=="
+ },
"node_modules/express": {
"version": "4.18.2",
"resolved": "https://registry.npmjs.org/express/-/express-4.18.2.tgz",
@@ -10453,9 +10459,9 @@
}
},
"node_modules/mongoose": {
- "version": "8.1.1",
- "resolved": "https://registry.npmjs.org/mongoose/-/mongoose-8.1.1.tgz",
- "integrity": "sha512-DbLb0NsiEXmaqLOpEz+AtAsgwhRw6f25gwa1dF5R7jj6lS1D8X6uTdhBSC8GDVtOwe5Tfw2EL7nTn6hiJT3Bgg==",
+ "version": "8.1.3",
+ "resolved": "https://registry.npmjs.org/mongoose/-/mongoose-8.1.3.tgz",
+ "integrity": "sha512-a5MajZSDJiQgy0iQcR+MIpFe7zehGJI4doJ6Dh1MvnGh8/HNNhr5pn07RPA86KCTjP2vuKdffpFmvXxcHiUOjw==",
"dependencies": {
"bson": "^6.2.0",
"kareem": "2.5.1",
@@ -11873,11 +11879,11 @@
"dev": true
},
"node_modules/react-router": {
- "version": "6.22.0",
- "resolved": "https://registry.npmjs.org/react-router/-/react-router-6.22.0.tgz",
- "integrity": "sha512-q2yemJeg6gw/YixRlRnVx6IRJWZD6fonnfZhN1JIOhV2iJCPeRNSH3V1ISwHf+JWcESzLC3BOLD1T07tmO5dmg==",
+ "version": "6.22.1",
+ "resolved": "https://registry.npmjs.org/react-router/-/react-router-6.22.1.tgz",
+ "integrity": "sha512-0pdoRGwLtemnJqn1K0XHUbnKiX0S4X8CgvVVmHGOWmofESj31msHo/1YiqcJWK7Wxfq2a4uvvtS01KAQyWK/CQ==",
"dependencies": {
- "@remix-run/router": "1.15.0"
+ "@remix-run/router": "1.15.1"
},
"engines": {
"node": ">=14.0.0"
@@ -11887,12 +11893,12 @@
}
},
"node_modules/react-router-dom": {
- "version": "6.22.0",
- "resolved": "https://registry.npmjs.org/react-router-dom/-/react-router-dom-6.22.0.tgz",
- "integrity": "sha512-z2w+M4tH5wlcLmH3BMMOMdrtrJ9T3oJJNsAlBJbwk+8Syxd5WFJ7J5dxMEW0/GEXD1BBis4uXRrNIz3mORr0ag==",
+ "version": "6.22.1",
+ "resolved": "https://registry.npmjs.org/react-router-dom/-/react-router-dom-6.22.1.tgz",
+ "integrity": "sha512-iwMyyyrbL7zkKY7MRjOVRy+TMnS/OPusaFVxM2P11x9dzSzGmLsebkCvYirGq0DWB9K9hOspHYYtDz33gE5Duw==",
"dependencies": {
- "@remix-run/router": "1.15.0",
- "react-router": "6.22.0"
+ "@remix-run/router": "1.15.1",
+ "react-router": "6.22.1"
},
"engines": {
"node": ">=14.0.0"
diff --git a/package.json b/package.json
index 265609775..b3b5342e1 100644
--- a/package.json
+++ b/package.json
@@ -26,6 +26,7 @@
"test:coverage": "jest --coverage --silent --runInBand",
"test:dev": "jest --verbose --watch",
"test:basic": "jest tests/markdown/basic.test.js --verbose",
+ "test:variables": "jest tests/markdown/variables.test.js --verbose",
"test:mustache-syntax": "jest '.*(mustache-syntax).*' --verbose --noStackTrace",
"test:mustache-syntax:inline": "jest '.*(mustache-syntax).*' -t '^Inline:.*' --verbose --noStackTrace",
"test:mustache-syntax:block": "jest '.*(mustache-syntax).*' -t '^Block:.*' --verbose --noStackTrace",
@@ -90,6 +91,7 @@
"cookie-parser": "^1.4.6",
"create-react-class": "^15.7.0",
"dedent-tabs": "^0.10.3",
+ "expr-eval": "^2.0.2",
"express": "^4.18.2",
"express-async-handler": "^1.2.0",
"express-static-gzip": "2.1.7",
@@ -104,13 +106,13 @@
"marked-smartypants-lite": "^1.0.2",
"markedLegacy": "npm:marked@^0.3.19",
"moment": "^2.30.1",
- "mongoose": "^8.1.1",
+ "mongoose": "^8.1.3",
"nanoid": "3.3.4",
"nconf": "^0.12.1",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-frame-component": "^4.1.3",
- "react-router-dom": "6.22.0",
+ "react-router-dom": "6.22.1",
"sanitize-filename": "1.6.3",
"superagent": "^8.1.2",
"vitreum": "git+https://git@github.com/calculuschild/vitreum.git"
diff --git a/shared/naturalcrit/markdown.js b/shared/naturalcrit/markdown.js
index 43729a539..79b2c1ce9 100644
--- a/shared/naturalcrit/markdown.js
+++ b/shared/naturalcrit/markdown.js
@@ -4,7 +4,40 @@ const Marked = require('marked');
const MarkedExtendedTables = require('marked-extended-tables');
const { markedSmartypantsLite: MarkedSmartypantsLite } = require('marked-smartypants-lite');
const { gfmHeadingId: MarkedGFMHeadingId } = require('marked-gfm-heading-id');
+const MathParser = require('expr-eval').Parser;
const renderer = new Marked.Renderer();
+const tokenizer = new Marked.Tokenizer();
+
+//Limit math features to simple items
+const mathParser = new MathParser({
+ operators : {
+ // These default to true, but are included to be explicit
+ add : true,
+ subtract : true,
+ multiply : true,
+ divide : true,
+ power : true,
+ round : true,
+ floor : true,
+ ceil : true,
+
+ sin : false, cos : false, tan : false, asin : false, acos : false,
+ atan : false, sinh : false, cosh : false, tanh : false, asinh : false,
+ acosh : false, atanh : false, sqrt : false, cbrt : false, log : false,
+ log2 : false, ln : false, lg : false, log10 : false, expm1 : false,
+ log1p : false, abs : false, trunc : false, join : false, sum : false,
+ '-' : false, '+' : false, exp : false, not : false, length : false,
+ '!' : false, sign : false, random : false, fac : false, min : false,
+ max : false, hypot : false, pyt : false, pow : false, atan2 : false,
+ 'if' : false, gamma : false, roundTo : false, map : false, fold : false,
+ filter : false, indexOf : false,
+
+ remainder : false, factorial : false,
+ comparison : false, concatenate : false,
+ logical : false, assignment : false,
+ array : false, fndef : false
+ }
+});
//Processes the markdown within an HTML block if it's just a class-wrapper
renderer.html = function (html) {
@@ -50,6 +83,11 @@ renderer.link = function (href, title, text) {
return out;
};
+// Disable default reflink behavior, as it steps on our variables extension
+tokenizer.def = function () {
+ return undefined;
+};
+
const mustacheSpans = {
name : 'mustacheSpans',
level : 'inline', // Is this a block-level or inline-level tokenizer?
@@ -288,9 +326,255 @@ const definitionLists = {
}
};
+
+//v=====--------------------< Variable Handling >-------------------=====v// 242 lines
+const replaceVar = function(input, hoist=false, allowUnresolved=false) {
+ const regex = /([!$]?)\[((?!\s*\])(?:\\.|[^\[\]\\])+)\]/g;
+ const match = regex.exec(input);
+
+ const prefix = match[1];
+ const label = match[2];
+
+ //v=====--------------------< HANDLE MATH >-------------------=====v//
+ const mathRegex = /[a-z]+\(|[+\-*/^()]/g;
+ const matches = label.split(mathRegex);
+ const mathVars = matches.filter((match)=>isNaN(match))?.map((s)=>s.trim()); // Capture any variable names
+
+ let replacedLabel = label;
+
+ if(mathVars?.[0] !== label.trim()) {// If there was mathy stuff not captured, let's do math!
+ mathVars?.forEach((variable)=>{
+ const foundVar = lookupVar(variable, globalPageNumber, hoist);
+ if(foundVar && foundVar.resolved && foundVar.content && !isNaN(foundVar.content)) // Only subsitute math values if fully resolved, not empty strings, and numbers
+ replacedLabel = replacedLabel.replaceAll(variable, foundVar.content);
+ });
+
+ try {
+ return mathParser.evaluate(replacedLabel);
+ } catch (error) {
+ return undefined; // Return undefined if invalid math result
+ }
+ }
+ //^=====--------------------< HANDLE MATH >-------------------=====^//
+
+ const foundVar = lookupVar(label, globalPageNumber, hoist);
+
+ if(!foundVar || (!foundVar.resolved && !allowUnresolved))
+ return undefined; // Return undefined if not found, or parially-resolved vars are not allowed
+
+ // url or "title" or 'title' or (title)
+ const linkRegex = /^([^<\s][^\s]*|<.*?>)(?: ("(?:\\"|[^"])*"|'(?:\\'|[^'])*'|\((?:\\\(|\\\)|[^()])*\)))?$/m;
+ const linkMatch = linkRegex.exec(foundVar.content);
+
+ const href = linkMatch ? linkMatch[1] : null; //TODO: TRIM OFF < > IF PRESENT
+ const title = linkMatch ? linkMatch[2]?.slice(1, -1) : null;
+
+ if(!prefix[0] && href) // Link
+ return `[${label}](${href}${title ? ` "${title}"` : ''})`;
+
+ if(prefix[0] == '!' && href) // Image
+ return ``;
+
+ if(prefix[0] == '$') // Variable
+ return foundVar.content;
+};
+
+const lookupVar = function(label, index, hoist=false) {
+ while (index >= 0) {
+ if(globalVarsList[index]?.[label] !== undefined)
+ return globalVarsList[index][label];
+ index--;
+ }
+
+ if(hoist) { //If normal lookup failed, attempt hoisting
+ index = Object.keys(globalVarsList).length; // Move index to start from last page
+ while (index >= 0) {
+ if(globalVarsList[index]?.[label] !== undefined)
+ return globalVarsList[index][label];
+ index--;
+ }
+ }
+
+ return undefined;
+};
+
+const processVariableQueue = function() {
+ let resolvedOne = true;
+ let finalLoop = false;
+ while (resolvedOne || finalLoop) { // Loop through queue until no more variable calls can be resolved
+ resolvedOne = false;
+ for (const item of varsQueue) {
+ if(item.type == 'text')
+ continue;
+
+ if(item.type == 'varDefBlock') {
+ const regex = /[!$]?\[((?!\s*\])(?:\\.|[^\[\]\\])+)\]/g;
+ let match;
+ let resolved = true;
+ let tempContent = item.content;
+ while (match = regex.exec(item.content)) { // regex to find variable calls
+ const value = replaceVar(match[0], true);
+
+ if(value == undefined)
+ resolved = false;
+ else
+ tempContent = tempContent.replaceAll(match[0], value);
+ }
+
+ if(resolved == true || item.content != tempContent) {
+ resolvedOne = true;
+ item.content = tempContent;
+ }
+
+ globalVarsList[globalPageNumber][item.varName] = {
+ content : item.content,
+ resolved : resolved
+ };
+
+ if(resolved)
+ item.type = 'resolved';
+ }
+
+ if(item.type == 'varCallBlock' || item.type == 'varCallInline') {
+ const value = replaceVar(item.content, true, finalLoop); // final loop will just use the best value so far
+
+ if(value == undefined)
+ continue;
+
+ resolvedOne = true;
+ item.content = value;
+ item.type = 'text';
+ }
+ }
+ varsQueue = varsQueue.filter((item)=>item.type !== 'resolved'); // Remove any fully-resolved variable definitions
+
+ if(finalLoop)
+ break;
+ if(!resolvedOne)
+ finalLoop = true;
+ }
+ varsQueue = varsQueue.filter((item)=>item.type !== 'varDefBlock');
+};
+
+function MarkedVariables() {
+ return {
+ hooks : {
+ preprocess(src) {
+ const codeBlockSkip = /^(?: {4}[^\n]+(?:\n(?: *(?:\n|$))*)?)+|^ {0,3}(`{3,}(?=[^`\n]*(?:\n|$))|~{3,})(?:[^\n]*)(?:\n|$)(?:|(?:[\s\S]*?)(?:\n|$))(?: {0,3}\2[~`]* *(?=\n|$))|`[^`]*?`/;
+ const blockDefRegex = /^[!$]?\[((?!\s*\])(?:\\.|[^\[\]\\])+)\]:(?!\() *((?:\n? *[^\s].*)+)(?=\n+|$)/; //Matches 3, [4]:5
+ const blockCallRegex = /^[!$]?\[((?!\s*\])(?:\\.|[^\[\]\\])+)\](?=\n|$)/; //Matches 6, [7]
+ const inlineDefRegex = /([!$]?\[((?!\s*\])(?:\\.|[^\[\]\\])+)\])\(([^\n]+)\)/; //Matches 8, 9[10](11)
+ const inlineCallRegex = /[!$]?\[((?!\s*\])(?:\\.|[^\[\]\\])+)\](?!\()/; //Matches 12, [13]
+
+ // Combine regexes and wrap in parens like so: (regex1)|(regex2)|(regex3)|(regex4)
+ const combinedRegex = new RegExp([codeBlockSkip, blockDefRegex, blockCallRegex, inlineDefRegex, inlineCallRegex].map((s)=>`(${s.source})`).join('|'), 'gm');
+
+ let lastIndex = 0;
+ let match;
+ while ((match = combinedRegex.exec(src)) !== null) {
+ // Format any matches into tokens and store
+ if(match.index > lastIndex) { // Any non-variable stuff
+ varsQueue.push(
+ { type : 'text',
+ varName : null,
+ content : src.slice(lastIndex, match.index)
+ });
+ }
+ if(match[1]) {
+ varsQueue.push(
+ { type : 'text',
+ varName : null,
+ content : match[0]
+ });
+ }
+ if(match[3]) { // Block Definition
+ const label = match[4] ? match[4].trim().replace(/\s+/g, ' ') : null; // Trim edge spaces and shorten blocks of whitespace to 1 space
+ const content = match[5] ? match[5].trim().replace(/[ \t]+/g, ' ') : null; // Trim edge spaces and shorten blocks of whitespace to 1 space
+
+ varsQueue.push(
+ { type : 'varDefBlock',
+ varName : label,
+ content : content
+ });
+ }
+ if(match[6]) { // Block Call
+ const label = match[7] ? match[7].trim().replace(/\s+/g, ' ') : null; // Trim edge spaces and shorten blocks of whitespace to 1 space
+
+ varsQueue.push(
+ { type : 'varCallBlock',
+ varName : label,
+ content : match[0]
+ });
+ }
+ if(match[8]) { // Inline Definition
+ const label = match[10] ? match[10].trim().replace(/\s+/g, ' ') : null; // Trim edge spaces and shorten blocks of whitespace to 1 space
+ let content = match[11] ? match[11].trim().replace(/\s+/g, ' ') : null; // Trim edge spaces and shorten blocks of whitespace to 1 space
+
+ // In case of nested (), find the correct matching end )
+ let level = 0;
+ let i;
+ for (i = 0; i < content.length; i++) {
+ if(content[i] === '\\') {
+ i++;
+ } else if(content[i] === '(') {
+ level++;
+ } else if(content[i] === ')') {
+ level--;
+ if(level < 0)
+ break;
+ }
+ }
+ if(i > -1) {
+ combinedRegex.lastIndex = combinedRegex.lastIndex - (content.length - i);
+ content = content.slice(0, i).trim().replace(/\s+/g, ' ');
+ }
+
+ varsQueue.push(
+ { type : 'varDefBlock',
+ varName : label,
+ content : content
+ });
+ varsQueue.push(
+ { type : 'varCallInline',
+ varName : label,
+ content : match[9]
+ });
+ }
+ if(match[12]) { // Inline Call
+ const label = match[13] ? match[13].trim().replace(/\s+/g, ' ') : null; // Trim edge spaces and shorten blocks of whitespace to 1 space
+
+ varsQueue.push(
+ { type : 'varCallInline',
+ varName : label,
+ content : match[0]
+ });
+ }
+ lastIndex = combinedRegex.lastIndex;
+ }
+
+ if(lastIndex < src.length) {
+ varsQueue.push(
+ { type : 'text',
+ varName : null,
+ content : src.slice(lastIndex)
+ });
+ }
+
+ processVariableQueue();
+
+ const output = varsQueue.map((item)=>item.content).join('');
+ varsQueue = []; // Must clear varsQueue because custom HTML renderer uses Marked.parse which will preprocess again without clearing the array
+ return output;
+ }
+ }
+ };
+};
+//^=====--------------------< Variable Handling >-------------------=====^//
+
+Marked.use(MarkedVariables());
Marked.use({ extensions: [mustacheSpans, mustacheDivs, mustacheInjectInline, definitionLists, superSubScripts] });
Marked.use(mustacheInjectBlock);
-Marked.use({ renderer: renderer, mangle: false });
+Marked.use({ renderer: renderer, tokenizer: tokenizer, mangle: false });
Marked.use(MarkedExtendedTables(), MarkedGFMHeadingId(), MarkedSmartypantsLite());
const nonWordAndColonTest = /[^\w:]/g;
@@ -369,12 +653,28 @@ const processStyleTags = (string)=>{
`${attributes?.length ? ` ${attributes.join(' ')}` : ''}`;
};
+const globalVarsList = {};
+let varsQueue = [];
+let globalPageNumber = 0;
+
module.exports = {
marked : Marked,
- render : (rawBrewText)=>{
+ render : (rawBrewText, pageNumber=1)=>{
+ globalVarsList[pageNumber] = {}; //Reset global links for current page, to ensure values are parsed in order
+ varsQueue = []; //Could move into MarkedVariables()
+ globalPageNumber = pageNumber;
+
rawBrewText = rawBrewText.replace(/^\\column$/gm, `\n\n`)
.replace(/^(:+)$/gm, (match)=>`${``.repeat(match.length)}\n`);
- return Marked.parse(rawBrewText);
+ const opts = Marked.defaults;
+
+ rawBrewText = opts.hooks.preprocess(rawBrewText);
+ const tokens = Marked.lexer(rawBrewText, opts);
+
+ Marked.walkTokens(tokens, opts.walkTokens);
+
+ const html = Marked.parser(tokens, opts);
+ return opts.hooks.postprocess(html);
},
validate : (rawBrewText)=>{
diff --git a/tests/markdown/variables.test.js b/tests/markdown/variables.test.js
new file mode 100644
index 000000000..c909dafec
--- /dev/null
+++ b/tests/markdown/variables.test.js
@@ -0,0 +1,373 @@
+/* eslint-disable max-lines */
+
+const dedent = require('dedent-tabs').default;
+const Markdown = require('naturalcrit/markdown.js');
+
+// Marked.js adds line returns after closing tags on some default tokens.
+// This removes those line returns for comparison sake.
+String.prototype.trimReturns = function(){
+ return this.replace(/\r?\n|\r/g, '').trim();
+};
+
+renderAllPages = function(pages){
+ const outputs = [];
+ pages.forEach((page, index)=>{
+ const output = Markdown.render(page, index);
+ outputs.push(output);
+ });
+
+ return outputs;
+};
+
+// Adding `.failing()` method to `describe` or `it` will make failing tests "pass" as long as they continue to fail.
+// Remove the `.failing()` method once you have fixed the issue.
+
+describe('Block-level variables', ()=>{
+ it('Handles variable assignment and recall with simple text', function() {
+ const source = dedent`
+ [var]: string
+
+ $[var]
+ `;
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe('string
');
+ });
+
+ it('Handles variable assignment and recall with multiline string', function() {
+ const source = dedent`
+ [var]: string
+ across multiple
+ lines
+
+ $[var]`;
+ const rendered = Markdown.render(source).replace(/\s/g, ' ').trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe('string across multiple lines
');
+ });
+
+ it('Handles variable assignment and recall with tables', function() {
+ const source = dedent`
+ [var]:
+ ##### Title
+ | H1 | H2 |
+ |:---|:--:|
+ | A | B |
+ | C | D |
+
+ $[var]`;
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe(dedent`
+ Title
+ | H1 |
+ H2 |
+
|---|
| A |
+ B |
+
| C |
+ D |
+
`.trimReturns());
+ });
+
+ it('Hoists undefined variables', function() {
+ const source = dedent`
+ $[var]
+
+ [var]: string`;
+ const rendered = Markdown.render(source).replace(/\s/g, ' ').trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe('string
');
+ });
+
+ it('Hoists last instance of variable', function() {
+ const source = dedent`
+ $[var]
+
+ [var]: string
+
+ [var]: new string`;
+ const rendered = Markdown.render(source).replace(/\s/g, ' ').trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe('new string
');
+ });
+
+ it('Handles complex hoisting', function() {
+ const source = dedent`
+ $[titleAndName]: $[title] $[fullName]
+
+ $[title]: Mr.
+
+ $[fullName]: $[firstName] $[lastName]
+
+ [firstName]: Bob
+
+ Welcome, $[titleAndName]!
+
+ [lastName]: Jacob
+
+ [lastName]: $[lastName]son
+ `;
+ const rendered = Markdown.render(source).replace(/\s/g, ' ').trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe('Welcome, Mr. Bob Jacobson!
');
+ });
+
+ it('Handles variable reassignment', function() {
+ const source = dedent`
+ [var]: one
+
+ $[var]
+
+ [var]: two
+
+ $[var]
+ `;
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe('one
two
'.trimReturns());
+ });
+
+ it('Handles variable reassignment with hoisting', function() {
+ const source = dedent`
+ $[var]
+
+ [var]: one
+
+ $[var]
+
+ [var]: two
+
+ $[var]
+ `;
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe('two
one
two
'.trimReturns());
+ });
+
+ it('Ignores undefined variables that can\'t be hoisted', function() {
+ const source = dedent`
+ $[var](My name is $[first] $[last])
+
+ $[last]: Jones
+ `;
+ const rendered = Markdown.render(source).replace(/\s/g, ' ').trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe(`My name is $[first] Jones
`.trimReturns());
+ });
+});
+
+describe('Inline-level variables', ()=>{
+ it('Handles variable assignment and recall with simple text', function() {
+ const source = dedent`
+ $[var](string)
+
+ $[var]
+ `;
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe('string
string
');
+ });
+
+ it('Hoists undefined variables when possible', function() {
+ const source = dedent`
+ $[var](My name is $[name] Jones)
+
+ [name]: Bob`;
+ const rendered = Markdown.render(source).replace(/\s/g, ' ').trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe('My name is Bob Jones
');
+ });
+
+ it('Hoists last instance of variable', function() {
+ const source = dedent`
+ $[var](My name is $[name] Jones)
+
+ $[name](Bob)
+
+ [name]: Bill`;
+ const rendered = Markdown.render(source).replace(/\s/g, ' ').trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe(`My name is Bill Jones
Bob
`.trimReturns());
+ });
+
+ it('Only captures nested parens if balanced', function() {
+ const source = dedent`
+ $[var1](A variable (with nested parens) inside)
+
+ $[var1]
+
+ $[var2](A variable ) with unbalanced parens)
+
+ $[var2]`;
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe(dedent`
+ A variable (with nested parens) inside
+ A variable (with nested parens) inside
+ A variable with unbalanced parens)
+ A variable
+ `.trimReturns());
+ });
+});
+
+describe('Math', ()=>{
+ it('Handles simple math using numbers only', function() {
+ const source = dedent`
+ $[1 + 3 * 5 - (1 / 4)]
+ `;
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe('15.75
');
+ });
+
+ it('Handles round function', function() {
+ const source = dedent`
+ $[round(1/4)]`;
+ const rendered = Markdown.render(source).replace(/\s/g, ' ').trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe('0
');
+ });
+
+ it('Handles floor function', function() {
+ const source = dedent`
+ $[floor(0.6)]`;
+ const rendered = Markdown.render(source).replace(/\s/g, ' ').trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe('0
');
+ });
+
+ it('Handles ceil function', function() {
+ const source = dedent`
+ $[ceil(0.2)]`;
+ const rendered = Markdown.render(source).replace(/\s/g, ' ').trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe('1
');
+ });
+
+ it('Handles nested functions', function() {
+ const source = dedent`
+ $[ceil(floor(round(0.6)))]`;
+ const rendered = Markdown.render(source).replace(/\s/g, ' ').trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe('1
');
+ });
+
+ it('Handles simple math with variables', function() {
+ const source = dedent`
+ $[num1]: 5
+
+ $[num2]: 4
+
+ Answer is $[answer]($[1 + 3 * num1 - (1 / num2)]).
+ `;
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe('Answer is 15.75.
');
+ });
+
+ it('Handles variable incrementing', function() {
+ const source = dedent`
+ $[num1]: 5
+
+ Increment num1 to get $[num1]($[num1 + 1]) and again to $[num1]($[num1 + 1]).
+ `;
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe('Increment num1 to get 6 and again to 7.
');
+ });
+});
+
+describe('Code blocks', ()=>{
+ it('Ignores all variables in fenced code blocks', function() {
+ const source = dedent`
+ \`\`\`
+ [var]: string
+
+ $[var]
+
+ $[var](new string)
+ \`\`\`
+ `;
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe(dedent`
+
+ [var]: string
+
+ $[var]
+
+ $[var](new string)
+
`.trimReturns());
+ });
+
+ it('Ignores all variables in indented code blocks', function() {
+ const source = dedent`
+ test
+
+ [var]: string
+
+ $[var]
+
+ $[var](new string)
+ `;
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe(dedent`
+ test
+
+
+ [var]: string
+
+ $[var]
+
+ $[var](new string)
+
`.trimReturns());
+ });
+
+ it('Ignores all variables in inline code blocks', function() {
+ const source = '[var](Hello) `[link](url)`. This `[var] does not work`';
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe(dedent`
+ var [link](url). This [var] does not work
`.trimReturns());
+ });
+});
+
+describe('Normal Links and Images', ()=>{
+ it('Renders normal images', function() {
+ const source = ``;
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe(dedent`
+ 
`.trimReturns());
+ });
+
+ it('Renders normal images with a title', function() {
+ const source = 'An image !';
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe(dedent`
+ An image
!
`.trimReturns());
+ });
+
+ it('Applies curly injectors to images', function() {
+ const source = `{width:100px}`;
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe(dedent`
+ 
`.trimReturns());
+ });
+
+ it('Renders normal links', function() {
+ const source = 'A Link to my [website](url)!';
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe(dedent`
+ A Link to my website!
`.trimReturns());
+ });
+
+ it('Renders normal links with a title', function() {
+ const source = 'A Link to my [website](url "and title")!';
+ const rendered = Markdown.render(source).trimReturns();
+ expect(rendered, `Input:\n${source}`, { showPrefix: false }).toBe(dedent`
+ A Link to my website!
`.trimReturns());
+ });
+});
+
+describe('Cross-page variables', ()=>{
+ it('Handles variable assignment and recall across pages', function() {
+ const source0 = `[var]: string`;
+ const source1 = `$[var]`;
+ const rendered = renderAllPages([source0, source1]).join('\n\\page\n').trimReturns();
+ expect(rendered, `Input:\n${[source0, source1].join('\n\\page\n')}`, { showPrefix: false }).toBe('\\pagestring
');
+ });
+
+ it('Handles hoisting across pages', function() {
+ const source0 = `$[var]`;
+ const source1 = `[var]: string`;
+ renderAllPages([source0, source1]).join('\n\\page\n').trimReturns(); //Requires one full render of document before hoisting is picked up
+ const rendered = renderAllPages([source0, source1]).join('\n\\page\n').trimReturns();
+ expect(rendered, `Input:\n${[source0, source1].join('\n\\page\n')}`, { showPrefix: false }).toBe('string
\\page');
+ });
+
+ it('Handles reassignment and hoisting across pages', function() {
+ const source0 = `$[var]\n\n[var]: one\n\n$[var]`;
+ const source1 = `[var]: two\n\n$[var]`;
+ renderAllPages([source0, source1]).join('\n\\page\n').trimReturns(); //Requires one full render of document before hoisting is picked up
+ const rendered = renderAllPages([source0, source1]).join('\n\\page\n').trimReturns();
+ expect(rendered, `Input:\n${[source0, source1].join('\n\\page\n')}`, { showPrefix: false }).toBe('two
one
\\pagetwo
');
+ });
+});
\ No newline at end of file