minimark 0.1.0 → 0.2.0

package/README.md

@@ -70,14 +70,83 @@ console.log(stringify(ast));
 
 ## API
 
-### `stringify(node, options?)`
 
-- `node`: The AST node to stringify.
-- `options`: (Optional) Configuration options.
+### `visit(tree, predicate, callback)`
+
+- `tree`: The minimark tree to visit.
+- `predicate`: A function that returns a boolean indicating whether the node should be visited.
+- `callback`: A function that will be called with the node and its children.
+
+```ts
+import { visit } from 'minimark';
+
+const ast = [
+  type: 'minimal',
+  value: [
+    ['h2', { id: 'documentations' }, '🎨 Documentations'], // ...
+  ],
+];
+
+visit(ast, (node) => node[0] === 'h2', (node) => {
+  console.log(node);
+});
+```
+
+### `textContent(node)`
+
+- `node`: The AST node to get the text content of.
+
+```ts
+import { textContent } from 'minimark';
+const ast = [
+  type: 'minimal',
+  value: [
+    ['h2', { id: 'documentations' }, '🎨 Documentations'], // ...
+  ],
+];
+
+console.log(textContent(ast.value[0])); // "🎨 Documentations"
+```
+
+### `toHast(tree)`
+
+- `tree`: The Minimark tree to convert to hast.
+
+```ts
+import { toHast } from 'minimark/hast';
+
+const ast = [
+  type: 'minimal',
+  value: [
+    ['h2', { id: 'documentations' }, '🎨 Documentations'], // ...
+  ],
+];
+
+const hast = toHast(ast);
+console.log(hast);
+```
+
+### `fromHast(tree)`
+
+- `tree`: The hast tree to convert to minimark.
+
+```ts
+
+const hast = {
+  type: 'root',
+  children: [
+    { type: 'element', tag: 'h2', props: { id: 'documentations' }, children: [{ type: 'text', value: '🎨 Documentations' }] },
+  ],
+};
+
+const minimark = fromHast(hast);
+console.log(minimark);
+```
+
 
 ## Contributing
 
-Contributions are welcome! Please open issues or submit pull requests.
+Contributions are welcome! Please open issues and submit pull requests.
 
 ## License
 

package/dist/hast.d.mts

@@ -15,13 +15,13 @@ interface HastNode {
   props?: Record<string, unknown>;
   children?: HastNode[];
 }
-declare function hastToMinimark(input: {
+declare function fromHast(tree: {
   type: 'root';
   children: HastNode[];
 }): MinimarkTree;
-declare function minimarkToHast(input: MinimarkTree): {
+declare function toHast(tree: MinimarkTree): {
   type: 'root';
   children: HastNode[];
 };
 //#endregion
-export { hastToMinimark, minimarkToHast };
+export { fromHast, toHast };

package/dist/hast.mjs

@@ -1,8 +1,8 @@
 //#region src/hast.ts
-function hastToMinimark(input) {
+function fromHast(tree) {
 	return {
 		type: "minimark",
-		value: input.children.map(hastToMinimarkNode).filter((v) => v !== void 0)
+		value: tree.children.map(hastToMinimarkNode).filter((v) => v !== void 0)
 	};
 }
 function hastToMinimarkNode(input) {
@@ -15,10 +15,10 @@ function hastToMinimarkNode(input) {
 		...(input.children || []).map(hastToMinimarkNode).filter((v) => v !== void 0)
 	];
 }
-function minimarkToHast(input) {
+function toHast(tree) {
 	return {
 		type: "root",
-		children: input.value.map(minimarkToHastNode)
+		children: tree.value.map(minimarkToHastNode)
 	};
 }
 function minimarkToHastNode(input) {
@@ -36,4 +36,4 @@ function minimarkToHastNode(input) {
 }
 
 //#endregion
-export { hastToMinimark, minimarkToHast };
+export { fromHast, toHast };

package/dist/stringify.mjs

@@ -1,6 +1,9 @@
 //#region src/utils/index.ts
-function indent(text) {
-	return text.split("\n").map((line) => "  " + line).join("\n");
+function indent(text, { ignoreFirstLine = false } = {}) {
+	return text.split("\n").map((line, index) => {
+		if (ignoreFirstLine && index === 0) return line;
+		return "  " + line;
+	}).join("\n");
 }
 function textContent(node) {
 	if (typeof node === "string") return node;
@@ -99,7 +102,7 @@ function li(node, state) {
 		const input = children.shift();
 		prefix += input[1].checked ? "[x] " : "[ ] ";
 	}
-	const result = children.map((child) => state.one(child, state).trimEnd()).join("").trim();
+	const result = children.map((child) => state.one(child, state)).join("").trim();
 	if (order) state.applyContext({ order: order + 1 });
 	return `${prefix}${result}\n`;
 }

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "minimark",
   "type": "module",
-  "version": "0.1.0",
-  "packageManager": "pnpm@9.15.9+sha512.68046141893c66fad01c079231128e9afb89ef87e2691d69e4d40eee228988295fd4682181bae55b58418c3a253bde65a505ec7c5f9403ece5cc3cd37dcf2531",
+  "version": "0.2.0",
+  "packageManager": "pnpm@10.11.0",
   "description": "MiniMark is a minimal representation of Abstract Syntax Trees (AST)",
   "license": "MIT",
   "repository": {
@@ -12,8 +12,7 @@
   "exports": {
     ".": "./dist/index.mjs",
     "./hast": "./dist/hast.mjs",
-    "./stringify": "./dist/stringify.mjs",
-    "./visit": "./dist/visit.mjs"
+    "./stringify": "./dist/stringify.mjs"
   },
   "files": [
     "dist"
@@ -32,10 +31,10 @@
     "@nuxt/eslint-config": "^1.4.1",
     "@nuxtjs/mdc": "^0.17.0",
     "@release-it/conventional-changelog": "^10.0.1",
-    "eslint": "^9.27.0",
-    "obuild": "^0.2.0",
-    "release-it": "^19.0.2",
+    "eslint": "^9.28.0",
+    "obuild": "^0.2.1",
+    "release-it": "^19.0.3",
     "typescript": "^5.8.3",
-    "vitest": "^3.1.4"
+    "vitest": "^3.2.0"
   }
 }