@stacksjs/ts-md 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,151 @@
+
+## v0.3.1...main
+
+[compare changes](https://github.com/stacksjs/ts-starter/compare/v0.3.1...main)
+
+### 🚀 Enhancements
+
+- Add `bun-plugin-dts-auto` ([c0c487b](https://github.com/stacksjs/ts-starter/commit/c0c487b))
+
+### ❤️ Contributors
+
+- Chris <chrisbreuer93@gmail.com>
+
+## v0.3.0...main
+
+[compare changes](https://github.com/stacksjs/ts-starter/compare/v0.3.0...main)
+
+### 🏡 Chore
+
+- Fix isolatedDeclarations setting ([b87b6b1](https://github.com/stacksjs/ts-starter/commit/b87b6b1))
+- Adjust urls ([0a40b72](https://github.com/stacksjs/ts-starter/commit/0a40b72))
+
+### ❤️ Contributors
+
+- Chris <chrisbreuer93@gmail.com>
+
+## v0.2.1...main
+
+[compare changes](https://github.com/stacksjs/ts-starter/compare/v0.2.1...main)
+
+### 🚀 Enhancements
+
+- Add `noFallthroughCasesInSwitch` ([b9cfa30](https://github.com/stacksjs/ts-starter/commit/b9cfa30))
+- Add `verbatimModuleSyntax` ([c495d17](https://github.com/stacksjs/ts-starter/commit/c495d17))
+- Several updates ([f703179](https://github.com/stacksjs/ts-starter/commit/f703179))
+
+### 🩹 Fixes
+
+- Properly use bun types ([7144221](https://github.com/stacksjs/ts-starter/commit/7144221))
+
+### 🏡 Chore
+
+- Adjust badge links ([432aff7](https://github.com/stacksjs/ts-starter/commit/432aff7))
+- Add `runs-on` options ([9a5b97f](https://github.com/stacksjs/ts-starter/commit/9a5b97f))
+- Cache node_modules ([ba2f6ce](https://github.com/stacksjs/ts-starter/commit/ba2f6ce))
+- Use `ubuntu-latest` for now ([1add684](https://github.com/stacksjs/ts-starter/commit/1add684))
+- Minor updates ([1007cff](https://github.com/stacksjs/ts-starter/commit/1007cff))
+- Lint ([d531bdc](https://github.com/stacksjs/ts-starter/commit/d531bdc))
+- Remove bunx usage ([e1a5575](https://github.com/stacksjs/ts-starter/commit/e1a5575))
+- Pass bun flag ([960976f](https://github.com/stacksjs/ts-starter/commit/960976f))
+- Use defaults ([157455b](https://github.com/stacksjs/ts-starter/commit/157455b))
+- Run typecheck using bun flag ([f22f3b1](https://github.com/stacksjs/ts-starter/commit/f22f3b1))
+- Test ([0b3c3a1](https://github.com/stacksjs/ts-starter/commit/0b3c3a1))
+- Use modern js for commitlint ([4bd6978](https://github.com/stacksjs/ts-starter/commit/4bd6978))
+- Update worklows readme ([f54aae9](https://github.com/stacksjs/ts-starter/commit/f54aae9))
+- Adjust readme ([92d7ff1](https://github.com/stacksjs/ts-starter/commit/92d7ff1))
+- More updates ([0225587](https://github.com/stacksjs/ts-starter/commit/0225587))
+- Add .zed settings for biome ([1688024](https://github.com/stacksjs/ts-starter/commit/1688024))
+- Extend via alias ([b108d30](https://github.com/stacksjs/ts-starter/commit/b108d30))
+- Lint ([d961b2a](https://github.com/stacksjs/ts-starter/commit/d961b2a))
+- Minor updates ([e66d44a](https://github.com/stacksjs/ts-starter/commit/e66d44a))
+
+### ❤️ Contributors
+
+- Chris <chrisbreuer93@gmail.com>
+
+## v0.2.0...main
+
+[compare changes](https://github.com/stacksjs/ts-starter/compare/v0.2.0...main)
+
+### 🏡 Chore
+
+- Remove unused action ([066f85a](https://github.com/stacksjs/ts-starter/commit/066f85a))
+- Housekeeping ([fc4e24d](https://github.com/stacksjs/ts-starter/commit/fc4e24d))
+
+### ❤️ Contributors
+
+- Chris <chrisbreuer93@gmail.com>
+
+## v0.1.1...main
+
+[compare changes](https://github.com/stacksjs/ts-starter/compare/v0.1.1...main)
+
+### 🏡 Chore
+
+- Adjust eslint config name ([53c2aa6](https://github.com/stacksjs/ts-starter/commit/53c2aa6))
+- Set type module ([22dde14](https://github.com/stacksjs/ts-starter/commit/22dde14))
+
+### ❤️ Contributors
+
+- Chris <chrisbreuer93@gmail.com>
+
+## v0.1.0...main
+
+[compare changes](https://github.com/stacksjs/ts-starter/compare/v0.1.0...main)
+
+### 🏡 Chore
+
+- Use correct cover image ([75bd3ae](https://github.com/stacksjs/ts-starter/commit/75bd3ae))
+
+### ❤️ Contributors
+
+- Chris <chrisbreuer93@gmail.com>
+
+## v0.0.5...main
+
+[compare changes](https://github.com/stacksjs/ts-starter/compare/v0.0.5...main)
+
+### 🚀 Enhancements
+
+- Add pkgx deps ([319c066](https://github.com/stacksjs/ts-starter/commit/319c066))
+- Use flat eslint config ([cdb0093](https://github.com/stacksjs/ts-starter/commit/cdb0093))
+
+### 🏡 Chore
+
+- Fix badge ([bc3b000](https://github.com/stacksjs/ts-starter/commit/bc3b000))
+- Minor updates ([78dc522](https://github.com/stacksjs/ts-starter/commit/78dc522))
+- Housekeeping ([e1cba3b](https://github.com/stacksjs/ts-starter/commit/e1cba3b))
+- Additional housekeeping ([f5dc625](https://github.com/stacksjs/ts-starter/commit/f5dc625))
+- Add `.gitattributes` ([7080f8c](https://github.com/stacksjs/ts-starter/commit/7080f8c))
+- Adjust deps ([cc71b42](https://github.com/stacksjs/ts-starter/commit/cc71b42))
+- Adjust wording ([3bc54b3](https://github.com/stacksjs/ts-starter/commit/3bc54b3))
+- Adjust readme cover ([e6acbb2](https://github.com/stacksjs/ts-starter/commit/e6acbb2))
+
+### ❤️ Contributors
+
+- Chris <chrisbreuer93@gmail.com>
+
+## v0.0.5...main
+
+[compare changes](https://github.com/stacksjs/ts-starter/compare/v0.0.5...main)
+
+### 🚀 Enhancements
+
+- Add pkgx deps ([319c066](https://github.com/stacksjs/ts-starter/commit/319c066))
+- Use flat eslint config ([cdb0093](https://github.com/stacksjs/ts-starter/commit/cdb0093))
+
+### 🏡 Chore
+
+- Fix badge ([bc3b000](https://github.com/stacksjs/ts-starter/commit/bc3b000))
+- Minor updates ([78dc522](https://github.com/stacksjs/ts-starter/commit/78dc522))
+- Housekeeping ([e1cba3b](https://github.com/stacksjs/ts-starter/commit/e1cba3b))
+- Additional housekeeping ([f5dc625](https://github.com/stacksjs/ts-starter/commit/f5dc625))
+- Add `.gitattributes` ([7080f8c](https://github.com/stacksjs/ts-starter/commit/7080f8c))
+- Adjust deps ([cc71b42](https://github.com/stacksjs/ts-starter/commit/cc71b42))
+- Adjust wording ([3bc54b3](https://github.com/stacksjs/ts-starter/commit/3bc54b3))
+- Adjust readme cover ([e6acbb2](https://github.com/stacksjs/ts-starter/commit/e6acbb2))
+
+### ❤️ Contributors
+
+- Chris <chrisbreuer93@gmail.com>

package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2024 Open Web Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,121 @@
+# ts-md
+
+High-performance markdown parser and sanitizer built for Bun.
+
+## Features
+
+- GitHub Flavored Markdown (GFM) support
+- Tables, task lists, strikethrough
+- Header ID generation
+- Syntax highlighting support
+- HTML sanitization
+- Frontmatter parsing (YAML, TOML, JSON)
+
+## Installation
+
+```bash
+bun add ts-md
+```
+
+## Usage
+
+### Basic Markdown Parsing
+
+```typescript
+import { parseMarkdown } from 'ts-md'
+
+const html = parseMarkdown('# Hello **world**')
+// <h1 id="hello-world">Hello <strong>world</strong></h1>
+```
+
+### With Options
+
+```typescript
+const html = parseMarkdown(markdown, {
+  gfm: true,              // GitHub Flavored Markdown (default: true)
+  breaks: false,          // Convert \n to <br> (default: false)
+  headerIds: true,        // Generate header IDs (default: true)
+  headerPrefix: '',       // Prefix for header IDs (default: '')
+  sanitize: false,        // Sanitize HTML output (default: false)
+  highlight: (code, lang) => {
+    // Custom syntax highlighting
+    return highlightedCode
+  }
+})
+```
+
+### HTML Sanitization
+
+```typescript
+import { sanitizeHtml } from 'ts-md'
+
+const clean = sanitizeHtml(userInput, {
+  allowedTags: ['p', 'strong', 'em', 'a', 'code'],
+  allowedAttributes: {
+    a: ['href', 'title']
+  },
+  allowedSchemes: ['http', 'https', 'mailto']
+})
+```
+
+### Frontmatter Parsing
+
+```typescript
+import { parseFrontmatter } from 'ts-md'
+
+const content = `---
+title: My Post
+date: 2024-01-01
+---
+
+# Content here`
+
+const { data, content: markdown } = parseFrontmatter(content)
+console.log(data.title) // 'My Post'
+```
+
+## Performance
+
+Benchmark results against popular markdown parsers:
+
+| Document Size | ts-md | markdown-it | marked | showdown |
+|--------------|-------------------|-------------|---------|----------|
+| Small (< 1KB) | 324B ops/sec | 112B ops/sec | 26B ops/sec | 14B ops/sec |
+| Medium (~3KB) | 34.7B ops/sec | 17.7B ops/sec | 2.8B ops/sec | 2.8B ops/sec |
+| Large (~50KB) | 1.81B ops/sec | 1.25B ops/sec | 16M ops/sec | 135M ops/sec |
+
+**Performance vs markdown-it:**
+
+- Small documents: 2.89x faster
+- Medium documents: 1.96x faster
+- Large documents: 1.45x faster
+
+The parser uses a flat token stream architecture with position-based parsing for optimal performance.
+
+## Architecture
+
+The markdown parser is built with several key optimizations:
+
+- **Flat token stream**: Avoids nested object allocations for better cache locality
+- **Position-based parsing**: Minimizes string allocations with substring operations
+- **Optimized escapeHtml**: Fast-path for strings without special characters
+- **Direct inline matching**: Efficient emphasis and link parsing
+- **Recursive nested parsing**: Proper support for nested inline elements
+
+## API
+
+### `parseMarkdown(markdown: string, options?: MarkdownOptions): string`
+
+Parse markdown to HTML.
+
+### `sanitizeHtml(html: string, options?: SanitizeOptions): string`
+
+Sanitize HTML to prevent XSS attacks.
+
+### `parseFrontmatter(content: string): { data: any, content: string }`
+
+Extract and parse frontmatter from markdown content. Supports YAML, TOML, and JSON formats.
+
+## License
+
+MIT

package/bin/cli.ts

@@ -0,0 +1,86 @@
+#!/usr/bin/env bun
+import { readFileSync } from 'node:fs'
+import { resolve } from 'node:path'
+import { parseMarkdown, parseMarkdownWithFrontmatter, parseFrontmatter, parseYaml } from '../src/index'
+
+const args = process.argv.slice(2)
+
+if (args.length === 0 || args.includes('--help') || args.includes('-h')) {
+  console.log(`
+ts-md - Fast, native Bun-powered markdown parser
+
+USAGE:
+  md <file> [options]
+
+OPTIONS:
+  --frontmatter, -f    Parse frontmatter only
+  --yaml, -y          Parse as YAML
+  --full             Parse markdown with frontmatter
+  --gfm              Enable GitHub Flavored Markdown
+  --breaks           Enable line breaks
+  --json             Output as JSON
+  --help, -h         Show this help
+  --version, -v      Show version
+
+EXAMPLES:
+  md README.md                    # Parse markdown to HTML
+  md document.md --frontmatter    # Extract frontmatter
+  md document.md --full           # Parse with frontmatter
+  md data.yaml --yaml             # Parse YAML
+  md README.md --gfm --breaks     # Parse with GFM and breaks
+  `)
+  process.exit(0)
+}
+
+if (args.includes('--version') || args.includes('-v')) {
+  const pkg = JSON.parse(readFileSync(resolve(import.meta.dir, '../package.json'), 'utf-8'))
+  console.log(pkg.version)
+  process.exit(0)
+}
+
+const filePath = args.find(arg => !arg.startsWith('--') && !arg.startsWith('-'))
+if (!filePath) {
+  console.error('Error: No file specified')
+  process.exit(1)
+}
+
+const fullPath = resolve(process.cwd(), filePath)
+const content = readFileSync(fullPath, 'utf-8')
+
+const isFrontmatter = args.includes('--frontmatter') || args.includes('-f')
+const isYaml = args.includes('--yaml') || args.includes('-y')
+const isFull = args.includes('--full')
+const asJson = args.includes('--json')
+const gfm = args.includes('--gfm')
+const breaks = args.includes('--breaks')
+
+try {
+  let result: any
+
+  if (isYaml) {
+    result = parseYaml(content)
+  }
+  else if (isFrontmatter) {
+    result = parseFrontmatter(content)
+  }
+  else if (isFull) {
+    result = parseMarkdownWithFrontmatter(content, { gfm, breaks })
+  }
+  else {
+    result = parseMarkdown(content, { gfm, breaks })
+  }
+
+  if (asJson) {
+    console.log(JSON.stringify(result, null, 2))
+  }
+  else if (typeof result === 'string') {
+    console.log(result)
+  }
+  else {
+    console.log(result)
+  }
+}
+catch (error) {
+  console.error('Error parsing file:', error)
+  process.exit(1)
+}

package/dist/config.d.ts

@@ -0,0 +1,5 @@
+import type { BinaryConfig } from './types';
+export declare function getConfig(): Promise<BinaryConfig>;
+export declare const defaultConfig: BinaryConfig;
+// For backwards compatibility - synchronous access with default fallback
+export declare const config: BinaryConfig;

package/dist/frontmatter.d.ts

@@ -0,0 +1,17 @@
+import type { JsonObject, ParsedMarkdown } from './types';
+/**
+ * Parse markdown with frontmatter
+ */
+export declare function parse<T = JsonObject>(content: string): ParsedMarkdown<T>;
+/**
+ * Stringify data to frontmatter markdown
+ */
+export declare function stringify<T extends JsonObject = JsonObject>(data: T, content: string, format?: 'yaml' | 'toml'): string;
+/**
+ * Check if content has frontmatter
+ */
+export declare function hasFrontmatter(content: string): boolean;
+/**
+ * Extract only the frontmatter (without parsing)
+ */
+export declare function extractFrontmatter(content: string): string | null;

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import { parse as parseFrontmatter } from './frontmatter';
+import { parse as parseMarkdown } from './parser';
+/**
+ * Parse markdown file with frontmatter in one go
+ */
+export declare function parseMarkdownWithFrontmatter<T = Record<string, any>>(content: string, options?: { gfm?: boolean, breaks?: boolean }): { data: T, content: string, html: string };
+export * as frontmatter from './frontmatter';
+export { parse as parseFrontmatter, stringify as stringifyFrontmatter } from './frontmatter';
+export * from './parser';
+export { parse as parseMarkdown, parseSync as parseMarkdownSync } from './parser';
+export * from './types';
+export * as yaml from './yaml';
+export { parse as parseYaml, stringify as stringifyYaml } from './yaml';
+export default markdownParser;