feat: serialize AST node back to wikitext string

core/modules/parsers/parseutils.js

@@ -385,4 +385,35 @@ exports.parseAttribute = function(source,pos) {
 	return node;
 };
 
+/*
+Given a parsed attribute node, serialize it back into its source string representation.
+*/
+exports.serializeAttribute = function(node) {
+	if(!node || typeof node !== 'object' || !node.name || !node.type) {
+			return null;
+	}
+
+	var attributeString = node.name;
+
+	if(node.type === 'string') {
+			if(node.value === 'true') {
+					return attributeString;
+			}
+			attributeString += '="' + node.value + '"';
+	} else if(node.type === 'filtered') {
+			attributeString += '={{{' + node.filter + '}}}';
+	} else if(node.type === 'indirect') {
+			attributeString += '={{' + node.textReference + '}}';
+	} else if(node.type === 'substituted') {
+			attributeString += '=`' + node.rawValue + '`';
+	} else if(node.type === 'macro') {
+			// Assuming macro serialization is complex and handled elsewhere
+			attributeString += '=' + node.value.serialize();
+	} else {
+			return null; // Unsupported type
+	}
+
+	return attributeString;
+};
+
 })();

core/modules/parsers/wikiparser/rules/codeblock.js

@@ -57,4 +57,8 @@ exports.parse = function() {
 	}];
 };
 
+exports.serialize = function(tree,serialize) {
+	return "\n```" + tree.attributes.language.value + "\n" + tree.attributes.code.value + "\n```\n";
+}
+
 })();

core/modules/parsers/wikiparser/rules/codeinline.js

@@ -55,4 +55,8 @@ exports.parse = function() {
 	}];
 };
 
+exports.serialize = function(tree,serialize) {
+	return "`" + serialize(tree.children) + "`";
+}
+
 })();

core/modules/parsers/wikiparser/rules/commentblock.js

@@ -25,7 +25,7 @@ Note that the syntax for comments is simplified to an opening "<!--" sequence an
 "use strict";
 
 exports.name = "commentblock";
-exports.types = {block:true, pragma:true};
+exports.types = {block:true};
 
 exports.init = function(parser) {
 	this.parser = parser;
@@ -46,11 +46,24 @@ exports.findNextMatch = function(startPos) {
 	return undefined;
 };
 
+
 exports.parse = function() {
 	// Move past the match
 	this.parser.pos = this.endMatchRegExp.lastIndex;
-	// Don't return any elements
-	return [];
+	// Return a node representing the comment that is not rendered
+	var commentStart = this.match.index;
+	var commentEnd = this.endMatch.index + this.endMatch[0].length;
+	var commentText = this.parser.source.slice(commentStart, commentEnd);
+	return [{
+			type: "commentblock",
+			text: commentText,
+			start: commentStart,
+			end: commentEnd
+	}];
+};
+
+exports.serialize = function(tree, serialize) {
+	return tree.text + "\n\n";
 };
 
 })();

core/modules/parsers/wikiparser/rules/commentinline.js

@@ -43,8 +43,20 @@ exports.findNextMatch = function(startPos) {
 exports.parse = function() {
 	// Move past the match
 	this.parser.pos = this.endMatchRegExp.lastIndex;
-	// Don't return any elements
-	return [];
+	// Return a node representing the inline comment
+	var commentStart = this.match.index;
+	var commentEnd = this.endMatch.index + this.endMatch[0].length;
+	var commentText = this.parser.source.slice(commentStart, commentEnd);
+	return [{
+			type: "commentinline",
+			text: commentText,
+			start: commentStart,
+			end: commentEnd
+	}];
+};
+
+exports.serialize = function(tree) {
+	return tree.text;
 };
 
 })();

core/modules/parsers/wikiparser/rules/conditional.js

@@ -117,4 +117,29 @@ exports.parseIfClause = function(filterCondition) {
 	return [listWidget];
 };
 
+exports.serialize = function(tree, serialize) {
+	var filterCondition = tree.attributes.filter.value;
+	var ifClause = serialize(tree.children[0].children);
+	var elseClause = tree.children[1].children;
+	var serialized = '<% if ' + filterCondition + '%>' + ifClause;
+
+	if(elseClause && elseClause.length > 0) {
+		for(var i = 0; i < elseClause.length; i++) {
+			if(elseClause[i].type === 'list' && elseClause[i].attributes.filter) {
+				// Handle elseif clause
+				var elseifCondition = elseClause[i].attributes.filter.value;
+				var elseifClause = serialize(elseClause[i].children[0]);
+				serialized += '<% elseif ' + elseifCondition + '%>' + elseifClause;
+			}
+			if(elseClause[i].children[1]) {
+				var elseClauseText = serialize(elseClause[i].children[1]);
+				serialized += '<% else %>' + elseClauseText;
+			}
+		}
+	}
+
+	serialized += '<% endif %>';
+	return serialized;
+};
+
 })();

core/modules/parsers/wikiparser/rules/dash.js

@@ -37,4 +37,9 @@ exports.parse = function() {
 	}];
 };
 
+exports.serialize = function(tree) {
+	var dash = tree.entity === "–" ? "--" : "---";
+	return dash;
+};
+
 })();

core/modules/parsers/wikiparser/rules/emphasis/bold.js

@@ -47,4 +47,17 @@ exports.parse = function() {
 	}];
 };
 
+exports.serialize = function(tree, serialize) {
+	// tree: { type: 'element', tag: 'strong', children: [{ type: 'text', text: 'bold' }] }
+	// serialize: function that accepts array of nodes or a node and returns a string
+	// Initialize the serialized string with the opening delimiter
+	var serialized = "''";
+	// Serialize the children of the bold element
+	serialized += serialize(tree.children);
+	// Close the serialized string with the closing delimiter
+	serialized += "''";
+	// Return the complete serialized string
+	return serialized;
+};
+
 })();

core/modules/parsers/wikiparser/rules/emphasis/italic.js

@@ -47,4 +47,17 @@ exports.parse = function() {
 	}];
 };
 
+exports.serialize = function(tree, serialize) {
+	// tree: { type: 'element', tag: 'em', children: [{ type: 'text', text: 'italic' }] }
+	// serialize: function that accepts array of nodes or a node and returns a string
+	// Initialize the serialized string with the opening delimiter
+	var serialized = "//";
+	// Serialize the children of the italic element
+	serialized += serialize(tree.children);
+	// Close the serialized string with the closing delimiter
+	serialized += "//";
+	// Return the complete serialized string
+	return serialized;
+};
+
 })();

core/modules/parsers/wikiparser/rules/emphasis/strikethrough.js

@@ -47,4 +47,17 @@ exports.parse = function() {
 	}];
 };
 
+exports.serialize = function(tree, serialize) {
+	// tree: { type: 'element', tag: 'strike', children: [{ type: 'text', text: 'strikethrough' }] }
+	// serialize: function that accepts array of nodes or a node and returns a string
+	// Initialize the serialized string with the opening delimiter
+	var serialized = "~~";
+	// Serialize the children of the strikethrough element
+	serialized += serialize(tree.children);
+	// Close the serialized string with the closing delimiter
+	serialized += "~~";
+	// Return the complete serialized string
+	return serialized;
+};
+
 })();

core/modules/parsers/wikiparser/rules/emphasis/subscript.js

@@ -47,4 +47,17 @@ exports.parse = function() {
 	}];
 };
 
+exports.serialize = function(tree, serialize) {
+	// tree: { type: 'element', tag: 'sub', children: [{ type: 'text', text: 'subscript' }] }
+	// serialize: function that accepts array of nodes or a node and returns a string
+	// Initialize the serialized string with the opening delimiter
+	var serialized = ",,";
+	// Serialize the children of the subscript element
+	serialized += serialize(tree.children);
+	// Close the serialized string with the closing delimiter
+	serialized += ",,";
+	// Return the complete serialized string
+	return serialized;
+};
+
 })();

core/modules/parsers/wikiparser/rules/emphasis/superscript.js

@@ -47,4 +47,17 @@ exports.parse = function() {
 	}];
 };
 
+exports.serialize = function(tree, serialize) {
+	// tree: { type: 'element', tag: 'sup', children: [{ type: 'text', text: 'superscript' }] }
+	// serialize: function that accepts array of nodes or a node and returns a string
+	// Initialize the serialized string with the opening delimiter
+	var serialized = "^^";
+	// Serialize the children of the superscript element
+	serialized += serialize(tree.children);
+	// Close the serialized string with the closing delimiter
+	serialized += "^^";
+	// Return the complete serialized string
+	return serialized;
+};
+
 })();

core/modules/parsers/wikiparser/rules/emphasis/underscore.js

@@ -47,4 +47,17 @@ exports.parse = function() {
 	}];
 };
 
+exports.serialize = function(tree, serialize) {
+	// tree: { type: 'element', tag: 'u', children: [{ type: 'text', text: 'underscore' }] }
+	// serialize: function that accepts array of nodes or a node and returns a string
+	// Initialize the serialized string with the opening delimiter
+	var serialized = "__";
+	// Serialize the children of the underscore element
+	serialized += serialize(tree.children);
+	// Close the serialized string with the closing delimiter
+	serialized += "__";
+	// Return the complete serialized string
+	return serialized;
+};
+
 })();

core/modules/parsers/wikiparser/rules/entity.js

@@ -37,4 +37,9 @@ exports.parse = function() {
 	return [{type: "entity", entity: this.match[0]}];
 };
 
+// Serialize method for the entity rule
+exports.serialize = function(tree, serialize) {
+	return tree.entity;
+};
+
 })();

core/modules/parsers/wikiparser/rules/extlink.js

@@ -31,11 +31,11 @@ exports.init = function(parser) {
 
 exports.parse = function() {
 	// Move past the match
-    var start = this.parser.pos;
+	var start = this.parser.pos;
 	this.parser.pos = this.matchRegExp.lastIndex;
 	// Create the link unless it is suppressed
 	if(this.match[0].substr(0,1) === "~") {
-		return [{type: "text", text: this.match[0].substr(1)}];
+		return [{type: "text", text: this.match[0].substr(1), start: start, end: this.parser.pos}];
 	} else {
 		return [{
 			type: "element",
@@ -53,4 +53,12 @@ exports.parse = function() {
 	}
 };
 
+exports.serialize = function(tree, serialize) {
+	if(tree.type === "text") {
+			return "~" + tree.text;
+	} else if(tree.type === "element" && tree.tag === "a") {
+			return tree.attributes.href.value;
+	}
+};
+
 })();

core/modules/parsers/wikiparser/rules/filteredtranscludeblock.js

@@ -71,4 +71,20 @@ exports.parse = function() {
 	return [node];
 };
 
+exports.serialize = function(tree) {
+	// Filter expression
+	var serialized = "{{{" + tree.attributes.filter.value;
+	// Tooltip text
+	if(tree.attributes.tooltip) serialized += "|" + tree.attributes.tooltip.value;
+	// Template title
+	if(tree.attributes.template) serialized += "||" + tree.attributes.template.value;
+	serialized += "}}";
+	// Inline styles
+	if(tree.attributes.style) serialized += tree.attributes.style.value;
+	serialized += "}"
+	// CSS classes
+	if(tree.attributes.itemClass) serialized += "." + tree.attributes.itemClass.value.split(" ").join(".");
+	return serialized + "\n";
+};
+
 })();

core/modules/parsers/wikiparser/rules/filteredtranscludeinline.js

@@ -70,4 +70,20 @@ exports.parse = function() {
 	return [node];
 };
 
+exports.serialize = function(tree) {
+	// Filter expression
+	var serialized = "{{{" + tree.attributes.filter.value;
+	// Tooltip text
+	if(tree.attributes.tooltip) serialized += "|" + tree.attributes.tooltip.value;
+	// Template title
+	if(tree.attributes.template) serialized += "||" + tree.attributes.template.value;
+	serialized += "}}";
+	// Inline styles
+	if(tree.attributes.style) serialized += tree.attributes.style.value;
+	serialized += "}"
+	// CSS classes
+	if(tree.attributes.itemClass) serialized += "." + tree.attributes.itemClass.value.split(" ").join(".");
+	return serialized;
+};
+
 })();

core/modules/parsers/wikiparser/rules/fnprocdef.js

@@ -93,5 +93,20 @@ exports.parse = function() {
 	return parseTreeNodes;
 };
 
+exports.serialize = function(tree, serialize) {
+	// Type of definition: "function", "procedure", or "widget"
+	var type = tree.isFunctionDefinition ? "function" : (tree.isProcedureDefinition ? "procedure" : "widget");
+	// Name of the function, procedure, or widget
+	var name = tree.attributes.name.value;
+	// Parameters with default values
+	var params = tree.params.map(function(param) {
+			return param.name + (param.default ? ":" + param.default : "");
+	}).join(",");
+	// Definition text
+	var definition = tree.attributes.value.value;
+	// Construct the serialized string, concat the children because pragma rule wrap everything below it as children
+	return "\\" + type + " " + name + "(" + params + ")\n" + definition + "\n\\end\n\n" + serialize(tree.children) + "\n";
+};
+
 })();
 

core/modules/parsers/wikiparser/rules/hardlinebreaks.js

@@ -53,8 +53,22 @@ exports.parse = function() {
 			}
 		}
 	} while(match && !match[1]);
-	// Return the nodes
+	// Mark first and last node, and return the nodes
+	if(tree[0]) tree[0].isRuleStart = true;
+	if(tree[tree.length-1]) tree[tree.length-1].isRuleEnd = true;
 	return tree;
 };
 
+exports.serialize = function(tree,serialize) {
+	// we get each of element on tree from `parse` one by one here.
+	var text = tree.tag === 'br' ? '\n' : tree.text;
+	if(tree.isRuleStart) {
+		return '"""\n' + text;
+	}
+	if(tree.isRuleEnd) {
+		return text + '"""';
+	}
+	return text;
+};
+
 })();