sommark 2.0.0 → 2.0.2

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## v2.0.2 (2026-02-03)
+
+### Features
+- **Exports**: Exposed `TOKEN_TYPES` and `labels` from core for advanced usage.
+
+### Refactoring
+- **Config**: Removed unused `custom_html` import from `smark.config.js`.
+
+### Fixes
+- **CLI**: Fixed typo in help message.
+- **Cleanup**: Cleaned up `.npmignore`.
+
+## v2.0.1 (2026-02-02)
+
+### Refactoring
+- **Highlight System**: Removed dependency on filesystem loading for themes. Bundled `atom-one-dark` theme by default.
+- **Theme Registry**: Introduced `registerHighlightTheme` and `selectHighlightTheme` for easier theme management.
+- **Auto-Detection**: Removed `hasCode` property. The transpiler now auto-detects code blocks for style injection if `enable_highlightTheme` is true.
+
+### Documentation
+- **API Reference**: Complete overhaul of `docs/api` with renumbered files and new methods.
+- **Syntax Guide**: Added comprehensive documentation for Block, Inline, and AtBlock syntax with examples.
+- **Mappers**: Added `default_mappers.md` listing all built-in HTML, Markdown, and MDX mappings.
+- **Escape Characters**: Added `escape_character.md` guide.
+
+### Fixes
+- **Browser Compatibility**: Fixed `loadCss` to work correctly in browser environments using `fetch`.
+- **Path Resolution**: Fixed path resolution issues for theme loading.
+
 ## v2.0.0 (2026-02-01)
 
 > [!WARNING]

package/README.md

@@ -13,7 +13,7 @@
 <img src="https://img.shields.io/badge/mdx-supported-lightblue?style=flat-square" />
 </p>
 
-# SomMark v2.0.0
+# SomMark v2
 
 > [!WARNING]
 > Old version is no longer supported.
@@ -151,7 +151,8 @@ Detailed guides and API references are available in the `docs/` directory:
 *   **[Core API](docs/core.md)**: Programmatic usage of the library (`transpile`, `lex`, `parse`).
 *   **[Mapper API](docs/mapper.md)**: Guide for creating custom mappers and rules.
 *   **[CLI Reference](docs/cli.md)**: Command line options and configurations.
-*   **[API Quick Reference](docs/api.md)**: Fast lookup for all classes and functions.
+*   **[API Quick Reference](docs/api)**: Fast lookup for all classes and functions.
+*   **[Configuration Reference](docs/config.md)**: Guide for creating custom configurations.
 
 
 
@@ -282,7 +283,15 @@ const { tag } = myMapper;
 
 myMapper.register("Code", ({ content }) => {
     return tag("pre").body(content);
-});
+}, {
+    escape: false,
+    rules: {
+        args: {
+            min: 1,           
+            required: ["id"]
+        }
+    }
+    }); // options
 ```
 
 # License

package/cli/commands/help.js

@@ -8,14 +8,14 @@ import { options } from "../constants.js";
 export function getHelp(unknown_option = true) {
     const msg = [
         `${unknown_option && process.argv[2] ? `<$red:Unrecognized option$> <$blue: '${process.argv[2]}'$>` : ""}`,
-        "{N}<$yellow:Usage:$> <$blue:smark [option]$>",
+        "{N}<$yellow:Usage:$> <$blue:sommark [option]$>",
 
         "{N}{N}<$yellow:Global Options:$>",
         "{N}  <$green:-h, --help$>     <$cyan: Show help message$>",
         "{N}  <$green:-v, --version$>  <$cyan: Show version information$>",
 
         "{N}{N}<$yellow:Transpilation Options:$>",
-        "{N}<$yellow:Usage:$> <$blue:smark [option] [targetFile] [option] [outputFile] [outputDir]$>",
+        "{N}<$yellow:Usage:$> <$blue:sommark [option] [targetFile] [option] [outputFile] [outputDir]$>",
         "{N}  <$green:--html$>         <$cyan: Transpile to HTML$>",
         "{N}  <$green:--markdown$>     <$cyan: Transpile to Markdown$>",
         "{N}  <$green:--mdx$>          <$cyan: Transpile to MDX$>",
@@ -26,9 +26,9 @@ export function getHelp(unknown_option = true) {
         "{N}  <$green:-o$>             <$cyan: Specify output filename (and optionally directory)$>",
 
         "{N}{N}<$yellow:Examples:$>",
-        "{N}  <$magenta:1. Basic usage:$> <$blue:smark --html input.smark$>",
-        "{N}  <$magenta:2. Print to console:$> <$blue:smark --html -p input.smark$>",
-        "{N}  <$magenta:3. Custom output:$> <$blue:smark --html input.smark -o myOutput ./dist/$>"
+        "{N}  <$magenta:1. Basic usage:$> <$blue:sommark --html input.smark$>",
+        "{N}  <$magenta:2. Print to console:$> <$blue:sommark --html -p input.smark$>",
+        "{N}  <$magenta:3. Custom output:$> <$blue:sommark --html input.smark -o myOutput ./dist/$>"
     ].join("");
     const help_msg = formatMessage(msg);
 

package/core/formats.js

@@ -6,3 +6,4 @@ const formats = {
 };
 
 export const {textFormat, htmlFormat, markdownFormat, mdxFormat} = formats;
+export default formats;

package/core/transpiler.js

@@ -199,7 +199,6 @@ async function generateOutput(ast, i, format, mapper_file) {
 
 async function transpiler({ ast, format, mapperFile, includeDocument = true }) {
 	let output = "";
-	mapperFile ? (mapperFile.hasCode = false) : null;
 	for (let i = 0; i < ast.length; i++) {
 		if (ast[i].type === BLOCK) {
 			output += await generateOutput(ast, i, format, mapperFile);
@@ -214,25 +213,17 @@ async function transpiler({ ast, format, mapperFile, includeDocument = true }) {
 	if (includeDocument && format === htmlFormat) {
 		let finalHeader = mapperFile.header;
 
-		if (mapperFile.hasCode && mapperFile.enable_highlight_link_Style && mapperFile.getHighlightTheme) {
-			const linkTag = `<link rel="stylesheet" href="node_modules/highlight.js/styles/${mapperFile.getHighlightTheme(mapperFile.highlightTheme)}.css">`;
-			if (linkTag && !finalHeader.includes(linkTag)) {
-				finalHeader += linkTag + "\n";
-			}
-		}
-
-		if (
-			(mapperFile.hasCode || (mapperFile.styles && mapperFile.styles.length > 0)) &&
-			mapperFile.loadStyles
-		) {
-			const styles = await mapperFile.loadStyles();
-			if (styles && styles.trim()) {
-				const styleTag = `<style>\n${styles}\n</style>`;
+		// Inject Style Tag if code blocks exist
+		if (mapperFile.enable_highlightTheme && (output.includes("<pre") || output.includes("<code")) && mapperFile.getStyle) {
+			const styleContent = mapperFile.getStyle();
+			if (styleContent) {
+				const styleTag = `<style>\n${styleContent}\n</style>`;
 				if (!finalHeader.includes(styleTag)) {
 					finalHeader += styleTag + "\n";
 				}
 			}
 		}
+
 		const document = `<!DOCTYPE html>\n<html>\n${finalHeader}\n<body>\n${output}\n</body>\n</html>\n`;
 		return document;
 	}

package/debug.js

@@ -1,10 +1,9 @@
 import fs from "node:fs/promises";
 import SomMark from "./index.js";
-import custom_html from "./custom.smark.js";
 
 const buffer = await fs.readFile("./example.smark");
 const file_content = buffer.toString();
-let smark = new SomMark({ src: file_content, format: "html", includeDocument: false });
+let smark = new SomMark({ src: file_content, format: "html", includeDocument: true });
 
 // console.log(JSON.stringify(smark.parse(), null, 2));
 // console.log(smark.lex());

package/helpers/defaultTheme.js

@@ -0,0 +1,3 @@
+const atomOneDark = `pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}.hljs{color:#abb2bf;background:#282c34}.hljs-comment,.hljs-quote{color:#5c6370;font-style:italic}.hljs-doctag,.hljs-formula,.hljs-keyword{color:#c678dd}.hljs-deletion,.hljs-name,.hljs-section,.hljs-selector-tag,.hljs-subst{color:#e06c75}.hljs-literal{color:#56b6c2}.hljs-addition,.hljs-attribute,.hljs-meta .hljs-string,.hljs-regexp,.hljs-string{color:#98c379}.hljs-attr,.hljs-number,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-pseudo,.hljs-template-variable,.hljs-type,.hljs-variable{color:#d19a66}.hljs-bullet,.hljs-link,.hljs-meta,.hljs-selector-id,.hljs-symbol,.hljs-title{color:#61aeee}.hljs-built_in,.hljs-class .hljs-title,.hljs-title.class_{color:#e6c07b}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700}.hljs-link{text-decoration:underline}`;
+
+export default atomOneDark;

package/index.js

@@ -8,8 +8,9 @@ import MDX from "./mappers/languages/mdx.js";
 import TagBuilder from "./formatter/tag.js";
 import MarkdownBuilder from "./formatter/mark.js";
 import { runtimeError } from "./core/errors.js";
-import { textFormat, htmlFormat, markdownFormat, mdxFormat } from "./core/formats.js";
-
+import FORMATS, { textFormat, htmlFormat, markdownFormat, mdxFormat } from "./core/formats.js";
+import TOKEN_TYPES from "./core/tokenTypes.js";
+import * as labels from "./core/labels.js";
 class SomMark {
 	constructor({ src, format, mapperFile = null, includeDocument = true }) {
 		this.src = src;
@@ -91,5 +92,18 @@ async function transpile(options = {}) {
 	return await transpiler({ ast, format, mapperFile, includeDocument });
 }
 
-export { HTML, MARKDOWN, MDX, Mapper, TagBuilder, MarkdownBuilder, lex, parse, transpile };
+export {
+	HTML,
+	MARKDOWN,
+	MDX,
+	Mapper,
+	TagBuilder,
+	MarkdownBuilder,
+	FORMATS,
+	lex,
+	parse,
+	transpile,
+	TOKEN_TYPES,
+	labels
+};
 export default SomMark;

package/lib/highlight.js

@@ -6,178 +6,6 @@ function highlightCode(code, language = "plaintext") {
     }
     return hljs.highlight(code, { language }).value;
 }
-const HighlightThemes = [
-    "gradient-dark",
-    "qtcreator-light",
-    "sunburst",
-    "intellij-light",
-    "rose-pine-moon.min",
-    "default.min",
-    "stackoverflow-light",
-    "rose-pine-moon",
-    "stackoverflow-light.min",
-    "magula.min",
-    "qtcreator-light.min",
-    "srcery.min",
-    "nord",
-    "purebasic",
-    "atom-one-dark-reasonable.min",
-    "a11y-light",
-    "monokai-sublime.min",
-    "cybertopia-dimmer.min",
-    "arduino-light.min",
-    "routeros",
-    "shades-of-purple.min",
-    "lioshi",
-    "isbl-editor-dark",
-    "monokai-sublime",
-    "docco",
-    "xcode",
-    "lioshi.min",
-    "foundation",
-    "github-dark-dimmed",
-    "far.min",
-    "night-owl.min",
-    "routeros.min",
-    "atom-one-light",
-    "1c-light.min",
-    "kimbie-light",
-    "ascetic.min",
-    "tokyo-night-dark.min",
-    "nnfx-dark",
-    "school-book.min",
-    "agate",
-    "lightfair.min",
-    "mono-blue.min",
-    "an-old-hope.min",
-    "a11y-dark.min",
-    "panda-syntax-dark",
-    "mono-blue",
-    "obsidian.min",
-    "gradient-light",
-    "tomorrow-night-bright",
-    "qtcreator-dark",
-    "gml.min",
-    "grayscale.min",
-    "panda-syntax-light",
-    "atom-one-dark-reasonable",
-    "xt256", "monokai",
-    "sunburst.min",
-    "gradient-light.min",
-    "arta",
-    "felipec.min",
-    "srcery",
-    "stackoverflow-dark.min",
-    "codepen-embed.min",
-    "docco.min",
-    "shades-of-purple",
-    "github.min",
-    "cybertopia-icecap",
-    "felipec",
-    "paraiso-dark.min",
-    "arta.min",
-    "gml",
-    "vs2015.min",
-    "a11y-dark",
-    "github-dark-dimmed.min",
-    "tokyo-night-dark",
-    "vs2015",
-    "rose-pine-dawn",
-    "ir-black.min",
-    "googlecode.min",
-    "cybertopia-saturated.min",
-    "color-brewer.min",
-    "night-owl",
-    "rose-pine",
-    "tomorrow-night-bright.min",
-    "a11y-light.min",
-    "brown-paper.min",
-    "panda-syntax-dark.min",
-    "dark.min",
-    "school-book",
-    "obsidian",
-    "stackoverflow-dark",
-    "1c-light",
-    "nord.min",
-    "kimbie-dark",
-    "brown-paper",
-    "nnfx-light.min",
-    "rainbow",
-    "cybertopia-icecap.min",
-    "gradient-dark.min",
-    "isbl-editor-light",
-    "paraiso-light.min",
-    "cybertopia-cherry",
-    "foundation.min",
-    "purebasic.min",
-    "xt256.min",
-    "pojoaque.min",
-    "lightfair",
-    "nnfx-dark.min",
-    "isbl-editor-light.min",
-    "tomorrow-night-blue",
-    "rainbow.min",
-    "ir-black",
-    "androidstudio",
-    "github",
-    "googlecode",
-    "paraiso-dark",
-    "codepen-embed",
-    "vs",
-    "cybertopia-dimmer",
-    "devibeans",
-    "tokyo-night-light",
-    "isbl-editor-dark.min",
-    "idea",
-    "github-dark",
-    "hybrid.min",
-    "idea.min",
-    "dark",
-    "atom-one-light.min",
-    "an-old-hope",
-    "atom-one-dark.min",
-    "agate.min",
-    "github-dark.min",
-    "qtcreator-dark.min",
-    "devibeans.min",
-    "magula",
-    "rose-pine-dawn.min",
-    "ascetic",
-    "vs.min",
-    "far",
-    "rose-pine.min",
-    "hybrid",
-    "nnfx-light",
-    "atom-one-dark",
-    "paraiso-light",
-    "intellij-light.min",
-    "grayscale",
-    "xcode.min",
-    "arduino-light",
-    "panda-syntax-light.min",
-    "tomorrow-night-blue.min",
-    "tokyo-night-light.min",
-    "kimbie-light.min",
-    "cybertopia-cherry.min",
-    "androidstudio.min",
-    "default",
-    "color-brewer",
-    "monokai.min",
-    "pojoaque",
-    "kimbie-dark.min",
-    "cybertopia-saturated"];
-
-let highlightTheme = "atom-one-dark.min";
-function getHighlightTheme(theme = highlightTheme) {
-    if (!HighlightThemes.includes(theme)) {
-        theme = "atom-one-dark.min";
-    }
-    return theme;
-}
-
 export {
     highlightCode,
-    getHighlightTheme,
-    highlightTheme,
-    HighlightThemes,
 };

package/mappers/mapper.js

@@ -1,9 +1,8 @@
 import TagBuilder from "../formatter/tag.js";
 import MarkdownBuilder from "../formatter/mark.js";
-import { highlightCode, getHighlightTheme, highlightTheme, HighlightThemes } from "../lib/highlight.js";
+import { highlightCode } from "../lib/highlight.js";
 import escapeHTML from "../helpers/escapeHTML.js";
-import loadHighlightStyle from "../helpers/loadHighlightStyle.js";
-import loadCss from "../helpers/loadCss.js";
+import atomOneDark from "../helpers/defaultTheme.js";
 
 class Mapper {
 	#customHeaderContent;
@@ -12,7 +11,7 @@ class Mapper {
 	// ========================================================================== //
 	constructor() {
 		this.outputs = [];
-		this.hasCode = false;
+		this.enable_highlightTheme = true;
 		this.md = new MarkdownBuilder();
 
 		this.pageProps = {
@@ -29,38 +28,40 @@ class Mapper {
 		this.#customHeaderContent = "";
 
 		this.highlightCode = highlightCode;
-		this.getHighlightTheme = getHighlightTheme;
-		this.highlightTheme = highlightTheme;
 		this.escapeHTML = escapeHTML;
-		this.enable_highlight_style_tag = true;
-		this.enable_highlight_link_Style = false;
-		this.enable_table_styles = true;
 		this.styles = [];
 		this.env = "node";
-		this.loadStyles = async () => {
-			let styles = "";
-			if (this.enable_highlight_style_tag) {
-				styles = await loadHighlightStyle(this.env, this.highlightTheme);
-			}
-			const allStyles = (styles ? styles + "\n" : "") + this.styles.join("\n");
-			return allStyles;
+
+		// Theme Registry
+		this.themes = {
+			"atom-one-dark": atomOneDark
 		};
+		this.currentTheme = "atom-one-dark";
 	}
 
-	// ========================================================================== //
-	//  Style Management                                                          //
-	// ========================================================================== //
-	get HighlightThemes() {
-		return this.enable_highlight_link_Style || this.enable_highlight_style_tag ? HighlightThemes : [];
+	registerHighlightTheme(themes) {
+		this.themes = { ...this.themes, ...themes };
 	}
 
-	async loadCss(path) {
-		const css = await loadCss(this.env, path);
-		if (css && css.trim()) {
-			this.addStyle(css);
+	selectHighlightTheme(themeName) {
+		if (this.themes[themeName]) {
+			this.currentTheme = themeName;
+		} else {
+			console.warn(`Theme '${themeName}' not found in registry.`);
 		}
 	}
 
+	getStyle() {
+		const themeCss = this.themes[this.currentTheme] || "";
+		const customCss = this.styles.join("\n");
+		return (themeCss + "\n" + customCss).trim();
+	}
+
+	// ========================================================================== //
+	//  Style Management                                                          //
+	// ========================================================================== //
+
+
 	addStyle(css) {
 		if (typeof css === "object" && css !== null) {
 			let styleString = "";
@@ -171,7 +172,6 @@ class Mapper {
 	//  Formatters                                                                //
 	// ========================================================================== //
 	code = (args, content) => {
-		this.hasCode = true;
 		const value = highlightCode(content, args && args[0] ? args[0].trim() : "text");
 		return this.tag("pre").body(
 			this.tag("code")

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "sommark",
-	"version": "2.0.0",
+	"version": "2.0.2",
 	"description": "SomMark is a structural markup language for writing structured documents and converting them into HTML or Markdown or MDX(only ready components).",
 	"main": "index.js",
 	"directories": {
@@ -48,4 +48,4 @@
 	"devDependencies": {
 		"vitest": "^4.0.16"
 	}
-}
+}

package/helpers/loadHighlightStyle.js

@@ -1,28 +0,0 @@
-export async function loadHighlightStyle(env, theme = "atom-one-dark.min", targetPath = "./node_modules/highlight.js/styles/") {
-	if (!env) {
-		env = typeof window !== "undefined" && typeof window.document !== "undefined" ? "browser" : "node";
-	}
-
-	try {
-		if (env === "node") {
-			const fs = await import("fs/promises");
-			const path = await import("path");
-			const stylePath = path.join(process.cwd(), targetPath, theme + ".css");
-			return await fs.readFile(stylePath, "utf-8");
-		} else if (env === "browser") {
-			const url = new URL("../" + targetPath + theme + ".css", import.meta.url);
-			const response = await fetch(url);
-			if (!response.ok) {
-				throw new Error(`Failed to fetch style: ${response.statusText}`);
-			}
-			return await response.text();
-		} else {
-			throw new Error("Invalid environment");
-		}
-	} catch (error) {
-		console.error("Error loading style:", error);
-		return "";
-	}
-}
-
-export default loadHighlightStyle;