catmdx 0.1.0

package/README.md

@@ -0,0 +1,26 @@
+# CatMdX CLI
+
+Read markdown efficiently.
+
+## Usage
+
+```bash
+# read metadata, TOC and the '#Usage' section from target markdown
+npx catmdx README.md --metadata --toc --section 'Usage'
+```
+
+## Options
+
+```
+catmdx [file] [options]
+
+Arguments:
+  path                     Path to the markdown file, optional with --content or --stdin flag
+
+Options:
+  -c, --content <content>  Markdown content provided as a string
+  -i, --stdin              Read markdown content from stdin
+  -m, --metadata           Print metadata from markdown content
+  -t, --toc                Print table of contents from markdown content
+  -s, --section <section>  Print specific section from markdown content (e.g. "Introduction" or "#2")
+```

package/bin/cli.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import '../dist/cli.js';

package/dist/cli.d.ts

@@ -0,0 +1 @@
+export { };

package/dist/cli.js

@@ -0,0 +1,37 @@
+import { n as getTOC, r as walkMarkdown, t as getSection } from "./section-Cw5XNpYg.js";
+import { program } from "commander";
+import { readFile } from "node:fs/promises";
+import { resolve } from "node:path";
+
+//#region src/reader.ts
+async function getContent(options) {
+	if (options.file) return await readFile(resolve(options.file), "utf-8");
+	if (options.content) return options.content;
+	const chunks = [];
+	for await (const chunk of process.stdin) chunks.push(chunk);
+	return Buffer.concat(chunks).toString("utf8");
+}
+
+//#endregion
+//#region src/cli.ts
+program.description("Parse and display specific contents of a markdown").argument("[path]", "Path to the markdown file, optional with --content or --stdin flag").option("-c, --content <content>", "Markdown content provided as a string").option("-i, --stdin", "Read markdown content from stdin").option("-m, --metadata", "Print metadata from markdown content").option("-t, --toc", "Print table of contents from markdown content").option("-s, --section <section>", "Print specific section from markdown content (e.g. \"Introduction\" or \"#2\")").action(async (file, options) => {
+	if (!options.file && !options.content && !options.stdin) program.addHelpText("after", "\nError: Please provide a file path / markdown content / or the stdin flag").help();
+	const content = await getContent({
+		...options,
+		file
+	});
+	const tokens = Array.from(walkMarkdown(content));
+	if (!tokens.length) return;
+	const contents = [];
+	if (options.metadata && tokens[0].type === "metadata") contents.push(`---\n${tokens[0].metadata}\n---`);
+	if (options.toc) contents.push(`[TOC]\n${getTOC(tokens)}`);
+	if (options.section) {
+		const section = getSection(tokens, options.section);
+		if (section != null) contents.push(section);
+	}
+	if (contents.length) console.log(contents.join("\n\n"));
+});
+program.parse(process.argv);
+
+//#endregion
+export {  };

package/dist/index.d.ts

@@ -0,0 +1,193 @@
+//#region node_modules/.pnpm/marked@17.0.3/node_modules/marked/lib/marked.d.ts
+// Generated by dts-bundle-generator v9.5.1
+type MarkedToken = (Tokens.Blockquote | Tokens.Br | Tokens.Checkbox | Tokens.Code | Tokens.Codespan | Tokens.Def | Tokens.Del | Tokens.Em | Tokens.Escape | Tokens.Heading | Tokens.Hr | Tokens.HTML | Tokens.Image | Tokens.Link | Tokens.List | Tokens.ListItem | Tokens.Paragraph | Tokens.Space | Tokens.Strong | Tokens.Table | Tokens.Tag | Tokens.Text);
+type Token = (MarkedToken | Tokens.Generic);
+declare namespace Tokens {
+  interface Blockquote {
+    type: "blockquote";
+    raw: string;
+    text: string;
+    tokens: Token[];
+  }
+  interface Br {
+    type: "br";
+    raw: string;
+  }
+  interface Checkbox {
+    type: "checkbox";
+    raw: string;
+    checked: boolean;
+  }
+  interface Code {
+    type: "code";
+    raw: string;
+    codeBlockStyle?: "indented";
+    lang?: string;
+    text: string;
+    escaped?: boolean;
+  }
+  interface Codespan {
+    type: "codespan";
+    raw: string;
+    text: string;
+  }
+  interface Def {
+    type: "def";
+    raw: string;
+    tag: string;
+    href: string;
+    title: string;
+  }
+  interface Del {
+    type: "del";
+    raw: string;
+    text: string;
+    tokens: Token[];
+  }
+  interface Em {
+    type: "em";
+    raw: string;
+    text: string;
+    tokens: Token[];
+  }
+  interface Escape {
+    type: "escape";
+    raw: string;
+    text: string;
+  }
+  interface Generic {
+    [index: string]: any;
+    type: string;
+    raw: string;
+    tokens?: Token[];
+  }
+  interface Heading {
+    type: "heading";
+    raw: string;
+    depth: number;
+    text: string;
+    tokens: Token[];
+  }
+  interface Hr {
+    type: "hr";
+    raw: string;
+  }
+  interface HTML {
+    type: "html";
+    raw: string;
+    pre: boolean;
+    text: string;
+    block: boolean;
+  }
+  interface Image {
+    type: "image";
+    raw: string;
+    href: string;
+    title: string | null;
+    text: string;
+    tokens: Token[];
+  }
+  interface Link {
+    type: "link";
+    raw: string;
+    href: string;
+    title?: string | null;
+    text: string;
+    tokens: Token[];
+  }
+  interface List {
+    type: "list";
+    raw: string;
+    ordered: boolean;
+    start: number | "";
+    loose: boolean;
+    items: ListItem[];
+  }
+  interface ListItem {
+    type: "list_item";
+    raw: string;
+    task: boolean;
+    checked?: boolean;
+    loose: boolean;
+    text: string;
+    tokens: Token[];
+  }
+  interface Paragraph {
+    type: "paragraph";
+    raw: string;
+    pre?: boolean;
+    text: string;
+    tokens: Token[];
+  }
+  interface Space {
+    type: "space";
+    raw: string;
+  }
+  interface Strong {
+    type: "strong";
+    raw: string;
+    text: string;
+    tokens: Token[];
+  }
+  interface Table {
+    type: "table";
+    raw: string;
+    align: Array<"center" | "left" | "right" | null>;
+    header: TableCell[];
+    rows: TableCell[][];
+  }
+  interface TableCell {
+    text: string;
+    tokens: Token[];
+    header: boolean;
+    align: "center" | "left" | "right" | null;
+  }
+  interface TableRow<P = string> {
+    text: P;
+  }
+  interface Tag {
+    type: "html";
+    raw: string;
+    inLink: boolean;
+    inRawBlock: boolean;
+    text: string;
+    block: boolean;
+  }
+  interface Text {
+    type: "text";
+    raw: string;
+    text: string;
+    tokens?: Token[];
+    escaped?: boolean;
+  }
+}
+//#endregion
+//#region src/walker.d.ts
+type WalkerToken = MarkdownMetadata | MarkdownSectionStart | MarkdownSectionEnd | MarkdownToken;
+interface MarkdownMetadata {
+  type: 'metadata';
+  metadata: string;
+}
+interface MarkdownSectionStart {
+  type: 'section-start';
+  path: Tokens.Heading[];
+  levelParts: number[];
+  startToken: Tokens.Heading;
+}
+interface MarkdownSectionEnd {
+  type: 'section-end';
+  startToken: Tokens.Heading;
+}
+interface MarkdownToken {
+  type: 'token';
+  token: Token;
+}
+declare function walkMarkdown(markdown: string): Generator<WalkerToken>;
+//#endregion
+//#region src/toc.d.ts
+declare function getTOC(tokens: WalkerToken[]): string;
+//#endregion
+//#region src/section.d.ts
+declare function getSection(tokens: WalkerToken[], titleOrNumber: string): string;
+//#endregion
+export { MarkdownMetadata, MarkdownSectionEnd, MarkdownSectionStart, MarkdownToken, WalkerToken, getSection, getTOC, walkMarkdown };

package/dist/index.js

@@ -0,0 +1,3 @@
+import { n as getTOC, r as walkMarkdown, t as getSection } from "./section-Cw5XNpYg.js";
+
+export { getSection, getTOC, walkMarkdown };