@luckyfishes/markdown-core 0.1.0 → 0.2.0

package/dist/index.d.cts

@@ -0,0 +1,140 @@
+import { PluggableList } from 'unified';
+import { RootContent, Text, Root } from 'mdast';
+
+declare const FOOTNOTES_HEADING_TEXT = "Footnotes";
+declare const FOOTNOTES_HEADING_ID = "footnote-label";
+type FootnotesOptions = {
+    headingId?: string;
+    headingText?: string;
+};
+
+type HastNode$1 = {
+    type: string;
+    tagName?: string;
+    properties?: Record<string, unknown>;
+    children?: HastNode$1[];
+    value?: string;
+};
+type CodeFenceComponentMapping = {
+    componentName: string;
+    propName: string;
+};
+type CodeFenceComponentMappings = Record<string, CodeFenceComponentMapping>;
+declare const DEFAULT_CODE_FENCE_COMPONENT_MAPPINGS: CodeFenceComponentMappings;
+declare function createCodeFenceComponentPlugin(mappings?: CodeFenceComponentMappings): (tree: HastNode$1) => void;
+
+type NodeWithPosition = {
+    position?: {
+        start?: {
+            line?: number;
+            offset?: number;
+        };
+        end?: {
+            line?: number;
+            offset?: number;
+        };
+    };
+};
+type FlowNode = RootContent & NodeWithPosition;
+type CustomSyntaxComponentNames = {
+    badge: string;
+    tip: string;
+    tabs: string;
+    tabsList: string;
+    tabsTrigger: string;
+    tabsContent: string;
+};
+type CustomSyntaxOptions = {
+    componentNames?: Partial<CustomSyntaxComponentNames>;
+};
+declare const DEFAULT_CUSTOM_SYNTAX_COMPONENT_NAMES: CustomSyntaxComponentNames;
+declare function resolveCustomSyntaxComponentNames(options?: CustomSyntaxOptions): CustomSyntaxComponentNames;
+type BlockHandlerKind = "block" | "container";
+type BlockHandlerMatchContext = {
+    children: FlowNode[];
+    componentNames: CustomSyntaxComponentNames;
+    getNodeSource: (node: NodeWithPosition) => string;
+    index: number;
+    source: string;
+    lines: string[];
+};
+type BlockHandlerTransformContext = BlockHandlerMatchContext & {
+    consumeThroughLine: (endLine: number) => number;
+    createFlowElement: (name: string, props?: Record<string, unknown>, children?: RootContent[]) => RootContent;
+    createInlineTextElement: (name: string, props?: Record<string, unknown>, text?: string) => RootContent;
+    createText: (value: string) => Text;
+    getLine: (lineNumber: number) => string;
+    getNodeSource: (node: NodeWithPosition) => string;
+    parseYamlProps: (yamlSource: string) => Record<string, unknown>;
+    transformFragment: (markdown: string) => RootContent[];
+};
+type BlockHandlerResult = {
+    consumed: number;
+    nodes: RootContent[];
+};
+type CustomSyntaxBlockHandler = {
+    kind: BlockHandlerKind;
+    match: (context: BlockHandlerMatchContext) => boolean;
+    name: string;
+    priority?: number;
+    transform: (context: BlockHandlerTransformContext) => BlockHandlerResult;
+};
+type InlineHandlerContext = {
+    componentNames: CustomSyntaxComponentNames;
+    createInlineTextElement: (name: string, props?: Record<string, unknown>, text?: string) => RootContent;
+    createText: (value: string) => Text;
+    getNodeSource: (node: NodeWithPosition) => string;
+    source: string;
+};
+type CustomSyntaxInlineHandler = {
+    kind: "inline";
+    match: (nodes: RootContent[], index: number, context: InlineHandlerContext) => boolean;
+    name: string;
+    priority?: number;
+    transform: (nodes: RootContent[], index: number, context: InlineHandlerContext) => {
+        consumed: number;
+        nodes: RootContent[];
+    };
+};
+
+type MarkdownPresetOptions = {
+    codeFenceMappings?: CodeFenceComponentMappings;
+    customSyntax?: CustomSyntaxOptions;
+    footnotes?: FootnotesOptions;
+};
+type MarkdownPreset = {
+    remarkPlugins: PluggableList;
+    rehypePlugins: PluggableList;
+};
+declare function createMarkdownPreset(options?: MarkdownPresetOptions): MarkdownPreset;
+
+type HastNode = {
+    type: string;
+    tagName?: string;
+    properties?: Record<string, unknown>;
+    children?: HastNode[];
+    value?: string;
+};
+declare function rehypeFootnotesHeading(options?: FootnotesOptions): (tree: HastNode) => void;
+
+declare function createCustomSyntaxRemarkPlugin(options?: CustomSyntaxOptions): (tree: Root, file?: {
+    value?: unknown;
+}) => void;
+
+declare const YAML_PROP_PREFIX = "__YAML__";
+
+type MdastNode = {
+    type: string;
+    value?: string;
+    children?: MdastNode[];
+};
+declare function remarkSuperSub(): (tree: MdastNode) => void;
+
+type MarkdownHeading = {
+    depth: 1 | 2 | 3;
+    text: string;
+    id: string;
+};
+declare function extractHeadings(markdown: string, options?: FootnotesOptions): MarkdownHeading[];
+
+export { type CodeFenceComponentMapping, type CodeFenceComponentMappings, type CustomSyntaxBlockHandler, type CustomSyntaxComponentNames, type CustomSyntaxInlineHandler, type CustomSyntaxOptions, DEFAULT_CODE_FENCE_COMPONENT_MAPPINGS, DEFAULT_CUSTOM_SYNTAX_COMPONENT_NAMES, FOOTNOTES_HEADING_ID, FOOTNOTES_HEADING_TEXT, type FlowNode, type FootnotesOptions, type MarkdownHeading, type MarkdownPreset, type MarkdownPresetOptions, type NodeWithPosition, YAML_PROP_PREFIX, createCodeFenceComponentPlugin, createCustomSyntaxRemarkPlugin, createMarkdownPreset, extractHeadings, rehypeFootnotesHeading, remarkSuperSub, resolveCustomSyntaxComponentNames };

package/dist/index.js

@@ -8,6 +8,14 @@ function resolveFootnotesHeadingDepth(depths) {
 // src/preset.ts
 import remarkGfm2 from "remark-gfm";
 
+// src/module-interop.ts
+function resolveModuleDefault(value) {
+  if (value && typeof value === "object" && "default" in value) {
+    return value.default;
+  }
+  return value;
+}
+
 // src/rehype/code-fence-components.ts
 import { visit } from "unist-util-visit";
 var DEFAULT_CODE_FENCE_COMPONENT_MAPPINGS = {
@@ -163,6 +171,8 @@ import matter from "gray-matter";
 import remarkGfm from "remark-gfm";
 import remarkParse from "remark-parse";
 import { unified } from "unified";
+var remarkGfmPlugin = resolveModuleDefault(remarkGfm);
+var remarkParsePlugin = resolveModuleDefault(remarkParse);
 var YAML_PROP_PREFIX = "__YAML__";
 var YAML_BODY_SPLIT_RE = /^---\s*$/;
 var COMPONENT_START_RE = /^::([A-Za-z][A-Za-z0-9_]*)\s*$/;
@@ -249,7 +259,7 @@ function createInlineTextElement(name, props = {}, text = "") {
   return node;
 }
 function parseMarkdownFragment(markdown) {
-  return unified().use(remarkParse).use(remarkGfm).parse(markdown);
+  return unified().use(remarkParsePlugin).use(remarkGfmPlugin).parse(markdown);
 }
 
 // src/remark/custom-syntax/handlers/component-block.ts
@@ -1054,6 +1064,7 @@ function remarkSuperSub() {
 }
 
 // src/preset.ts
+var remarkGfmPlugin2 = resolveModuleDefault(remarkGfm2);
 function createMarkdownPreset(options) {
   const customSyntaxPlugin = options?.customSyntax ? function customSyntaxPresetPlugin() {
     return createCustomSyntaxRemarkPlugin(options.customSyntax);
@@ -1067,7 +1078,7 @@ function createMarkdownPreset(options) {
   return {
     remarkPlugins: [
       customSyntaxPlugin,
-      [remarkGfm2, { singleTilde: false }],
+      [remarkGfmPlugin2, { singleTilde: false }],
       remarkSuperSub
     ],
     rehypePlugins: [
@@ -1083,6 +1094,8 @@ import remarkGfm3 from "remark-gfm";
 import remarkParse2 from "remark-parse";
 import { unified as unified2 } from "unified";
 import { visit as visit3 } from "unist-util-visit";
+var remarkGfmPlugin3 = resolveModuleDefault(remarkGfm3);
+var remarkParsePlugin2 = resolveModuleDefault(remarkParse2);
 function extractText2(children) {
   return children.map((child) => {
     if ("value" in child && typeof child.value === "string") {
@@ -1098,7 +1111,7 @@ function extractText2(children) {
   }).join("");
 }
 function extractHeadings(markdown, options) {
-  const tree = unified2().use(remarkParse2).use(remarkGfm3).parse(markdown);
+  const tree = unified2().use(remarkParsePlugin2).use(remarkGfmPlugin3).parse(markdown);
   const slugger = new GithubSlugger();
   const headings = [];
   const headingId = options?.headingId ?? FOOTNOTES_HEADING_ID;

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@luckyfishes/markdown-core",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Core Markdown/MDX parsing and AST transformation utilities extracted from noname_blog.",
   "type": "module",
-  "main": "./dist/index.js",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "homepage": "https://github.com/lijiajunply/nonameblog-markdown-core#readme",
   "bugs": {
@@ -16,7 +17,9 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.js"
     }
   },
   "files": [
@@ -27,7 +30,7 @@
     "access": "public"
   },
   "scripts": {
-    "build": "tsup src/index.ts --format esm --dts --clean",
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
     "prepare": "npm run build",
     "test": "vitest run"
   },