sommark 2.1.2 → 2.2.0

package/core/parser.js

@@ -102,7 +102,6 @@ const updateData = (tokens, i) => {
 	}
 };
 
-
 const errorMessage = (tokens, i, expectedValue, behindValue, frontText) => {
 	const tokensUntilError = tokens.slice(0, i);
 	const contextText = tokensUntilError.map(t => t.value).join("");
@@ -123,7 +122,6 @@ const errorMessage = (tokens, i, expectedValue, behindValue, frontText) => {
 // ========================================================================== //
 function parseKey(tokens, i) {
 	let key = current_token(tokens, i).value.trim();
-	validateName(key);
 	// ========================================================================== //
 	//  consume Key                                                               //
 	// ========================================================================== //
@@ -261,7 +259,12 @@ function parseBlock(tokens, i) {
 				let [key, keyIndex] = parseKey(tokens, i);
 				k = key;
 				i = keyIndex;
+				const prev = current_token(tokens, i);
 				i = parseColon(tokens, i, block_id);
+				if (current_token(tokens, i).type !== TOKEN_TYPES.VALUE && current_token(tokens, i).type !== TOKEN_TYPES.ESCAPE) {
+					parserError(errorMessage(tokens, i, block_value, ":"));
+				}
+				validateName(k);
 				continue;
 			} else if (
 				current_token(tokens, i) &&
@@ -403,6 +406,7 @@ function parseInline(tokens, i) {
 		parserError(errorMessage(tokens, i, inline_value, "("));
 	}
 	inlineNode.value = current_token(tokens, i).value;
+	inlineNode.depth = current_token(tokens, i).depth;
 	// ========================================================================== //
 	//  consume Inline Value                                                      //
 	// ========================================================================== //
@@ -467,11 +471,12 @@ function parseInline(tokens, i) {
 			parserError(errorMessage(tokens, i, inline_value, ":"));
 		}
 		let v = "";
-
 		const pushArg = () => {
 			if (v !== "") {
 				inlineNode.args.push(v);
-				inlineNode.args[v] = v;
+				if (!Number.isInteger(Number(v))) {
+					inlineNode.args[v] = v;
+				}
 				v = "";
 			}
 		};
@@ -519,11 +524,11 @@ function parseInline(tokens, i) {
 					if (current_token(tokens, i) && current_token(tokens, i).type === TOKEN_TYPES.COMMA) {
 						parserError(errorMessage(tokens, i, ",", "", "Found extra"));
 					}
-					if (!current_token(tokens, i) || (
-						current_token(tokens, i) &&
-						current_token(tokens, i).type !== TOKEN_TYPES.VALUE &&
-						current_token(tokens, i).type !== TOKEN_TYPES.ESCAPE
-					)
+					if (
+						!current_token(tokens, i) ||
+						(current_token(tokens, i) &&
+							current_token(tokens, i).type !== TOKEN_TYPES.VALUE &&
+							current_token(tokens, i).type !== TOKEN_TYPES.ESCAPE)
 					) {
 						parserError(errorMessage(tokens, i, inline_value, ","));
 					}
@@ -649,6 +654,10 @@ function parseAtBlock(tokens, i) {
 				k = key;
 				i = keyIndex;
 				i = parseColon(tokens, i, at_id);
+				if (current_token(tokens, i).type !== TOKEN_TYPES.VALUE && current_token(tokens, i).type !== TOKEN_TYPES.ESCAPE) {
+					parserError(errorMessage(tokens, i, at_value, ":"));
+				}
+				validateName(k);
 				continue;
 			} else if (current_token(tokens, i) && current_token(tokens, i).type === TOKEN_TYPES.ESCAPE) {
 				let [escape_character, escapeIndex] = parseEscape(tokens, i);

package/core/transpiler.js

@@ -1,7 +1,9 @@
 import { BLOCK, TEXT, INLINE, ATBLOCK, COMMENT } from "./labels.js";
 import escapeHTML from "../helpers/escapeHTML.js";
 import { transpilerError } from "./errors.js";
-import { textFormat, htmlFormat, markdownFormat, mdxFormat } from "./formats.js";
+import { textFormat, htmlFormat, markdownFormat, mdxFormat, jsonFormat } from "./formats.js";
+
+const expose_for_fmts = [jsonFormat];
 
 // ========================================================================== //
 //  Extracting target identifier                                              //
@@ -26,7 +28,7 @@ function matchedValue(outputs, targetId) {
 	return result;
 }
 
-function validateRules(target, args, content) {
+function validateRules(target, args, content, type = null) {
 	if (!target || !target.options || !target.options.rules) {
 		return;
 	}
@@ -96,6 +98,15 @@ function validateRules(target, args, content) {
 			]);
 		}
 	}
+	// Validate element type
+	if (id && rules.type && type) {
+		if (rules.type !== type) {
+			transpilerError([
+				"{line}<$red:Validation Error:$> ",
+				`<$yellow:Identifier$> <$blue:'${Array.isArray(id) ? id.join(" | ") : id}'$> <$yellow:is expected to be type$> <$green:'${rules.type}'$>{N}<$cyan:Received type: $> <$magenta:'${type}'$>{line}`
+			]);
+		}
+	}
 }
 // ========================================================================== //
 //  +++++++++++++++++++++++++++++                                             //
@@ -104,14 +115,16 @@ async function generateOutput(ast, i, format, mapper_file) {
 	const node = Array.isArray(ast) ? ast[i] : ast;
 	let result = "";
 	let context = "";
-	let target = mapper_file ? matchedValue(mapper_file.outputs, node.id) : "";
+	let target = mapper_file ? matchedValue(mapper_file.outputs, node.id) : null;
+	const block_formats = [htmlFormat, mdxFormat, jsonFormat];
 	if (target) {
-		validateRules(target, node.args, "");
-		result +=
-			format === htmlFormat || format === mdxFormat
-				? `${node.depth > 1 ? " ".repeat(node.depth) : ""}${target.render({ args: node.args, content: "\n<%smark>" })}${node.depth > 1 ? " ".repeat(node.depth) : ""}`
-				: target.render({ args: node.args, content: "" });
-		for (const body_node of node.body) {
+		validateRules(target, node.args, "", node.type);
+		result += block_formats.includes(format)
+			? `${target.render({ args: node.args, content: "<%smark>", ast: expose_for_fmts.includes(format) ? ast[i] : null })}`
+      : target.render({ args: node.args, content: "" });
+    // Body nodes
+		for (let j = 0; j < node.body.length; j++) {
+			const body_node = node.body[j];
 			switch (body_node.type) {
 				// ========================================================================== //
 				//  Text                                                                      //
@@ -119,8 +132,7 @@ async function generateOutput(ast, i, format, mapper_file) {
 				case TEXT:
 					validateRules(target, body_node.args, body_node.text);
 					const shouldEscape = target && target.options && target.options.escape === false ? false : true;
-					context +=
-						(format === htmlFormat || format === mdxFormat) && shouldEscape ? escapeHTML(body_node.text) : body_node.text;
+					context += [htmlFormat, mdxFormat].includes(format) && shouldEscape ? escapeHTML(body_node.text) : body_node.text;
 					break;
 				// ========================================================================== //
 				//  Inline                                                                    //
@@ -128,13 +140,11 @@ async function generateOutput(ast, i, format, mapper_file) {
 				case INLINE:
 					target = matchedValue(mapper_file.outputs, body_node.id);
 					if (target) {
-						validateRules(target, body_node.args, body_node.value);
-						context +=
-							(format === htmlFormat || format === mdxFormat ? "\n" : "") +
-							target.render({
-								args: body_node.args.length > 0 ? body_node.args : "",
-								content: format === htmlFormat || format === mdxFormat ? escapeHTML(body_node.value) : body_node.value
-							});
+						validateRules(target, body_node.args, body_node.value, body_node.type);
+						context += target.render({
+							args: body_node.args.length > 0 ? body_node.args : [],
+							content: format === htmlFormat || format === mdxFormat ? escapeHTML(body_node.value) : body_node.value
+						});
 					}
 					break;
 				// ========================================================================== //
@@ -143,7 +153,7 @@ async function generateOutput(ast, i, format, mapper_file) {
 				case ATBLOCK:
 					target = matchedValue(mapper_file.outputs, body_node.id);
 					if (target) {
-						validateRules(target, body_node.args, body_node.content);
+						validateRules(target, body_node.args, body_node.content, body_node.type);
 						// Escape logic: fallback to options.escape, default true
 						const shouldEscape = target.options?.escape ?? true;
 						if (shouldEscape) {
@@ -171,7 +181,8 @@ async function generateOutput(ast, i, format, mapper_file) {
 					break;
 			}
 		}
-		if (format === htmlFormat || format === mdxFormat) {
+
+		if (format === htmlFormat || format === mdxFormat || format === jsonFormat) {
 			result = result.replace("<%smark>", context);
 		} else {
 			result += context;
@@ -245,6 +256,9 @@ async function transpiler({ ast, format, mapperFile, includeDocument = true }) {
 		const document = `<!DOCTYPE html>\n<html>\n${finalHeader}\n<body>\n${output}\n</body>\n</html>\n`;
 		return document;
 	}
+	if (format === jsonFormat) {
+		output = JSON.parse(JSON.stringify(output));
+	}
 	return output;
 }
 

package/formatter/mark.js

@@ -18,7 +18,7 @@ class MarkdownBuilder {
 			} else if (level < min) {
 				level = min;
 			}
-			return `${"#".repeat(level)} ${text}\n`;
+			return `\n${"#".repeat(level)} ${text}\n`;
 		}
 		return text;
 	}
@@ -29,7 +29,7 @@ class MarkdownBuilder {
 		if (!text && !url) {
 			return "";
 		}
-		return ` ${type === "image" ? "!" : ""}[${text}](${url + (title ? " " : "")}${title}) `;
+		return ` ${type === "image" ? "!" : ""}[${text}](${url + (title ? " " : "")}${title ? JSON.stringify(title) : ""}) `;
 	}
 	// ========================================================================== //
 	//  Bold                                                                      //
@@ -91,10 +91,7 @@ class MarkdownBuilder {
 	//  Horizontal rule                                                           //
 	// ========================================================================== //
 	horizontal(format = "*") {
-		if (!format) {
-			return "\n***\n";
-		}
-		return format === "*" ? "\n***\n" : format === "_" ? "___" : format === "*" ? "***" : "";
+		return `\n${format.repeat(3)}\n`;
 	}
 	// ========================================================================== //
 	//  Escape                                                                    //

package/grammar.ebnf

@@ -12,7 +12,6 @@ EscapeChar     = "\";
 (* 1. Identifiers can be only letters and numbers. *)
 (* 2. Semi-colon is only recognized in Atblock arguments. *)
 (* 3. Colon is a separator in Block and Atblock arguments; must be escaped if part of value. *)
-(* 4. Bodies and Values cannot be empty. *)
 
 (* Comments *)
 Comment = "#", { ? any character except "\n" ? }, "\n";

package/index.js

@@ -5,10 +5,11 @@ import Mapper from "./mappers/mapper.js";
 import HTML from "./mappers/languages/html.js";
 import MARKDOWN from "./mappers/languages/markdown.js";
 import MDX from "./mappers/languages/mdx.js";
+import Json from "./mappers/languages/json.js";
 import TagBuilder from "./formatter/tag.js";
 import MarkdownBuilder from "./formatter/mark.js";
 import { runtimeError } from "./core/errors.js";
-import FORMATS, { textFormat, htmlFormat, markdownFormat, mdxFormat } from "./core/formats.js";
+import FORMATS, { textFormat, htmlFormat, markdownFormat, mdxFormat, jsonFormat } from "./core/formats.js";
 import TOKEN_TYPES from "./core/tokenTypes.js";
 import * as labels from "./core/labels.js";
 class SomMark {
@@ -19,7 +20,7 @@ class SomMark {
 
 		this.Mapper = Mapper;
 		this.includeDocument = includeDocument;
-		const accepted_formats = [textFormat, htmlFormat, markdownFormat, mdxFormat];
+		const accepted_formats = [textFormat, htmlFormat, markdownFormat, mdxFormat, jsonFormat];
 		if (!this.format) {
 			runtimeError(["{line}<$red:Undefined Format$>: <$yellow:Format argument is not defined.$>{line}"]);
 		}
@@ -29,7 +30,7 @@ class SomMark {
 				`{N}<$yellow:Accepted formats are:$> [<$cyan: ${accepted_formats.join(", ")}$>]{line}`
 			]);
 		}
-		const mapperFiles = { [htmlFormat]: HTML, [markdownFormat]: MARKDOWN, [mdxFormat]: MDX };
+		const mapperFiles = { [htmlFormat]: HTML, [markdownFormat]: MARKDOWN, [mdxFormat]: MDX, [jsonFormat]: Json};
 		if (!this.mapperFile && this.format) {
 			this.mapperFile = mapperFiles[this.format];
 		}
@@ -95,7 +96,8 @@ async function transpile(options = {}) {
 export {
 	HTML,
 	MARKDOWN,
-	MDX,
+  MDX,
+  Json,
 	Mapper,
 	TagBuilder,
 	MarkdownBuilder,

package/mappers/languages/html.js

@@ -1,15 +1,56 @@
 import Mapper from "../mapper.js";
 const HTML = new Mapper();
-const { tag, code, list } = HTML;
+const { tag, code, list, safeArg } = HTML;
+
+HTML.register(
+	["Html", "html"],
+	({ args }) => {
+		HTML.pageProps.pageTitle = safeArg(args, undefined, "title", null, null, HTML.pageProps.pageTitle);
+		HTML.pageProps.charset = safeArg(args, undefined, "charset", null, null, HTML.pageProps.charset);
+		HTML.pageProps.tabIcon.src = safeArg(args, undefined, "iconSrc", null, null, HTML.pageProps.tabIcon.src);
+		HTML.pageProps.tabIcon.type = safeArg(args, undefined, "iconType", null, null, HTML.pageProps.tabIcon.type);
+		HTML.pageProps.httpEquiv["X-UA-Compatible"] = safeArg(
+			args,
+			undefined,
+			"httpEquiv",
+			null,
+			null,
+			HTML.pageProps.httpEquiv["X-UA-Compatible"]
+		);
+		HTML.pageProps.viewport = safeArg(args, undefined, "viewport", null, null, HTML.pageProps.viewport);
+		return "";
+	},
+	{
+		rules: {
+			type: "Block"
+		}
+	}
+);
 
 // Block
-HTML.register("Block", ({ content }) => {
-	return content;
-});
+HTML.register(
+	["Block", "block"],
+	({ content }) => {
+		return content;
+	},
+	{
+		rules: {
+			type: "Block"
+		}
+	}
+);
 // Section
-HTML.register("Section", ({ content }) => {
-	return tag("section").body(content);
-});
+HTML.register(
+	["Section", "section"],
+	({ content }) => {
+		return tag("section").body(content);
+	},
+	{
+		rules: {
+			type: "Block"
+		}
+	}
+);
 // Headings
 ["h1", "h2", "h3", "h4", "h5", "h6"].forEach(heading => {
 	HTML.register(heading, ({ content }) => {
@@ -17,44 +58,44 @@ HTML.register("Section", ({ content }) => {
 	});
 });
 // Bold
-HTML.register(["bold", "b"], ({ content }) => {
+HTML.register(["bold", "Bold", "b"], ({ content }) => {
 	return tag("strong").body(content);
 });
 // Italic
 HTML.register(["italic", "i"], ({ content }) => {
 	return tag("i").body(content);
 });
-// Italic
+// Emphasis
 HTML.register(["emphasis", "e"], ({ content }) => {
 	return tag("span").attributes({ style: "font-weight:bold; font-style: italic;" }).body(content);
 });
 // Colored Text
-HTML.register("color", ({ args, content }) => {
+HTML.register(["color", "Color"], ({ args, content }) => {
+	const color = safeArg(args, 0, undefined, null, null, "none");
 	return tag("span")
-		.attributes({ style: `color:${args[0]}` })
+		.attributes({ style: `color:${color}` })
 		.body(content);
 });
 // Link
-HTML.register("link", ({ args, content }) => {
-	return tag("a")
-		.attributes({ href: args[0].trim(), title: args[1] ? args[1].trim() : "" })
-		.body(content);
+HTML.register(["link", "Link"], ({ args, content }) => {
+	const url = safeArg(args, 0, "url", null, null, "");
+	const title = safeArg(args, 1, "title", null, null, "");
+	return tag("a").attributes({ href: url.trim(), title: title.trim(), target: "_blank" }).body(content);
 });
 // Image
 HTML.register(
 	["image", "Image"],
 	({ args }) => {
-		const src = args && args["src"] ? args["src"] : "";
-		const alt = args && args["alt"] ? args["alt"] : "";
-		const width = args && args["width"] ? args["width"] : "",
-			height = args && args["height"] ? args["height"] : "";
+		const src = safeArg(args, undefined, "src", null, null, "");
+		const alt = safeArg(args, undefined, "alt", null, null, "");
+		const width = safeArg(args, undefined, "width", null, null, "");
+		const height = safeArg(args, undefined, "height", null, null, "");
 		return tag("img").attributes({ src, alt, width, height }).selfClose();
 	},
 	{
 		rules: {
-			is_Self_closing: true,
 			args: {
-			required: ["src"]
+				required: ["src"]
 			}
 		}
 	}
@@ -65,7 +106,7 @@ HTML.register(
 	({ args, content }) => {
 		return code(args, content);
 	},
-	{ escape: false }
+	{ escape: false, rules: { type: "AtBlock" } }
 );
 // List
 HTML.register(
@@ -81,7 +122,12 @@ HTML.register(
 	({ content, args }) => {
 		return HTML.htmlTable(content.split(/\n/), args);
 	},
-	{ escape: false }
+	{
+		escape: false,
+		rules: {
+			type: "AtBlock"
+		}
+	}
 );
 // Horizontal Rule
 HTML.register(
@@ -98,9 +144,8 @@ HTML.register(
 // Todo
 HTML.register("todo", ({ args, content }) => {
 	const checked = HTML.todo(content);
-	return tag("div").body(
-		tag("input").attributes({ type: "checkbox", disabled: true, checked }).selfClose() + (args[0] ? args[0] : "")
-	);
+	const task = safeArg(args, 0, undefined, null, null, "");
+	return tag("div").body(tag("input").attributes({ type: "checkbox", disabled: true, checked }).selfClose() + task);
 });
 
 export default HTML;

package/mappers/languages/json.js

@@ -0,0 +1,172 @@
+import Mapper from "../mapper.js";
+import { TEXT } from "../../core/labels.js";
+import { transpilerError } from "../../core/errors.js";
+
+const Json = new Mapper();
+
+// ========================================================================== //
+//  Helpers                                                                   //
+// ========================================================================== //
+
+function escapeString(str) {
+	return JSON.stringify(str);
+}
+
+function processNode(node, parentType = null) {
+	if (!node) return "";
+
+	if (node.id === "Object" || node.id === "Array" || node.id === "Json") {
+		return renderBlock(node, parentType);
+	} else if (["string", "number", "bool", "null", "array", "none"].includes(node.id)) {
+		return renderInline(node, parentType);
+	} else if (node.type === TEXT) {
+		return "";
+	}
+	return "";
+}
+
+function renderBlock(node, parentType) {
+	let output = "";
+	let key = "";
+	let isRoot = node.id === "Json";
+	let type = node.id === "Array" || (isRoot && node.args.includes("array")) ? "array" : "object";
+
+	// ========================================================================== //
+	//  Key                                                                       //
+	// ========================================================================== //
+	if (!isRoot) {
+		if (parentType === "object") {
+			key = node.args && node.args[0] ? escapeString(node.args[0]) : null;
+			if (!key) {
+				key = '"unknown_key"';
+			}
+		}
+	}
+
+	// ========================================================================== //
+	//  Children                                                                  //
+	// ========================================================================== //
+	let children = [];
+	if (node.body && node.body.length > 0) {
+		for (const child of node.body) {
+			const childOutput = processNode(child, type);
+			if (childOutput) {
+				children.push(childOutput);
+			}
+		}
+	}
+
+	let content = children.join(",");
+	let wrapper = type === "array" ? `[${content}]` : `{${content}}`;
+
+	if (key) {
+		return `${key}:${wrapper}`;
+	} else {
+		if (parentType === "object") {
+			if (!node.args || !node.args[0]) {
+				transpilerError([`{line}<$red:JSON Error:$> <$yellow:Blocks inside an Object must have a key argument.$>{line}`]);
+			}
+		}
+		return wrapper;
+	}
+}
+
+function renderInline(node, parentType) {
+	let key = null;
+	let value = "";
+
+	// ========================================================================== //
+	//  Value                                                                     //
+	// ========================================================================== //
+	if (node.id === "string") {
+		if (!node.args || node.args.length === 0) {
+			transpilerError([`{line}<$red:JSON Error:$> <$yellow:String inline must have a value.$>{line}`]);
+		}
+		value = escapeString(node.args[0] || "");
+	} else if (node.id === "number") {
+		if (!node.args || node.args.length === 0 || isNaN(Number(node.args[0]))) {
+			transpilerError([`{line}<$red:JSON Error:$> <$yellow:Invalid or missing number value for inline.$>{line}`]);
+		}
+		value = node.args[0];
+	} else if (node.id === "bool") {
+		if (!node.args || (node.args[0] !== "true" && node.args[0] !== "false")) {
+			transpilerError([`{line}<$red:JSON Error:$> <$yellow:Bool inline must be 'true' or 'false'.$>{line}`]);
+		}
+		value = node.args[0] === "true" ? "true" : "false";
+	} else if (node.id === "null") {
+		value = "null";
+	} else if (node.id === "array") {
+		// ========================================================================== //
+		//  Inline array                                                              //
+		// ========================================================================== //
+		// (data)->(array: 1, 2, 3)
+		// args = ["1", " 2", " 3"]
+		const items = node.args.map(arg => {
+			const trimmed = arg.trim();
+			if (trimmed === "null") return "null";
+			if (trimmed === "true" || trimmed === "false") return trimmed;
+			if (!isNaN(parseFloat(trimmed)) && isFinite(trimmed)) return trimmed;
+			return escapeString(trimmed);
+		});
+		value = `[${items.join(",")}]`;
+	} else if (node.id === "none") {
+		// Special case: (-)->(none: val)
+		if (parentType === "object") {
+			transpilerError([
+				`{line}<$red:JSON Error:$> <$yellow:'none' inline is not allowed directly inside an Object. It must be inside an Array.$>{line}`
+			]);
+			return "";
+		}
+
+		// (-)->(none: 1, 2, null) -> [1, 2, null] -> args.length > 1
+		// (-)->(none: true) -> true -> args.length == 1
+
+		if (node.args.length > 1) {
+			const items = node.args.map(arg => {
+				const trimmed = arg.trim();
+				if (trimmed === "null") return "null";
+				if (trimmed === "true" || trimmed === "false") return trimmed;
+				if (!isNaN(parseFloat(trimmed)) && isFinite(trimmed)) return trimmed;
+				return escapeString(trimmed);
+			});
+			value = `[${items.join(",")}]`;
+		} else {
+			const arg = node.args[0] || "";
+			const trimmed = arg.trim();
+			if (trimmed === "null") value = "null";
+			else if (trimmed === "true" || trimmed === "false") value = trimmed;
+			else if (!isNaN(parseFloat(trimmed)) && isFinite(trimmed)) value = trimmed;
+			else value = escapeString(trimmed);
+		}
+	}
+
+	if (parentType === "object") {
+		if (node.id === "none") return "";
+
+		if (!node.value) {
+			transpilerError([
+				`{line}<$red:JSON Error:$> <$yellow:Inline elements inside an Object must have an identifier (key).$>{line}`
+			]);
+		}
+
+		key = escapeString(node.value);
+		return `${key}:${value}`;
+	} else {
+		return value;
+	}
+}
+
+// ========================================================================== //
+//  Main Registration                                                         //
+// ========================================================================== //
+
+const noop = () => "";
+Json.register(["Object", "Array"], noop);
+Json.register(["string", "number", "bool", "null", "array", "none"], noop);
+
+Json.register("Json", ({ args, content, ast }) => {
+	if (!ast) return "";
+	return processNode(ast, null);
+});
+
+export default Json;