docs: add @packageDocumentation tag to all packages

shtse8 · shtse8 · commit 8f3070a40116 · 2025-11-29T00:01:15.000Z
Affects: synth-c, synth-css, synth-docs, synth-go, synth-graphql, synth-html, synth-ini, synth-java, synth-js, synth-js-format, synth-js-minify, synth-json, synth-jsx, synth-lint, synth-md, synth-md-gfm, synth-md-katex, synth-md-mermaid, synth-metrics, synth-msgpack, synth-php, synth-protobuf, synth-python, synth-ruby, synth-rust, synth-sql, synth-toml, synth-typecheck, synth-vue, synth-wasm-js, synth-wasm-md, synth-xml, synth-yaml
diff --git a/packages/synth-c/src/index.ts b/packages/synth-c/src/index.ts
@@ -2,6 +2,8 @@
  * @sylphx/synth-c
  *
  * C parser for Synth's universal AST
+ *
+ * @packageDocumentation
  */
 
 export { CParser, createParser, parse, parseAsync } from './parser.js'
diff --git a/packages/synth-css/src/index.ts b/packages/synth-css/src/index.ts
@@ -3,6 +3,8 @@
  *
  * CSS3 parser using Synth's universal AST
  * Hand-written, zero dependencies
+ *
+ * @packageDocumentation
  */
 
 export type { CSSParseOptions } from './parser.js'
diff --git a/packages/synth-docs/src/index.ts b/packages/synth-docs/src/index.ts
@@ -2,6 +2,8 @@
  * @sylphx/synth-docs
  *
  * Documentation generator for Synth AST
+ *
+ * @packageDocumentation
  */
 
 export { createGenerator, DocGenerator, generate } from './generator.js'
diff --git a/packages/synth-go/src/index.ts b/packages/synth-go/src/index.ts
@@ -3,6 +3,8 @@
  *
  * Go parser using Synth's universal AST
  * Conversion layer over tree-sitter-go
+ *
+ * @packageDocumentation
  */
 
 export type { GoParseOptions } from './parser.js'
diff --git a/packages/synth-graphql/src/index.ts b/packages/synth-graphql/src/index.ts
@@ -3,6 +3,8 @@
  *
  * GraphQL parser using Synth's universal AST
  * Conversion layer over graphql-js
+ *
+ * @packageDocumentation
  */
 
 export type { GraphQLParseOptions } from './parser.js'
diff --git a/packages/synth-html/src/index.ts b/packages/synth-html/src/index.ts
@@ -2,6 +2,8 @@
  * @sylphx/synth-html
  *
  * High-performance HTML5 parser for Synth
+ *
+ * @packageDocumentation
  */
 
 // Incremental tokenizer
diff --git a/packages/synth-ini/src/index.ts b/packages/synth-ini/src/index.ts
@@ -3,6 +3,8 @@
  *
  * INI parser using Synth's universal AST
  * Hand-written, zero dependencies
+ *
+ * @packageDocumentation
  */
 
 export type { INIParseOptions } from './parser.js'
diff --git a/packages/synth-java/src/index.ts b/packages/synth-java/src/index.ts
@@ -2,6 +2,8 @@
  * @sylphx/synth-java
  *
  * Java parser for Synth's universal AST
+ *
+ * @packageDocumentation
  */
 
 export { createParser, JavaParser, parse, parseAsync } from './parser.js'
diff --git a/packages/synth-js-format/src/index.ts b/packages/synth-js-format/src/index.ts
@@ -2,6 +2,8 @@
  * @sylphx/synth-js-format
  *
  * Prettier-style code formatter for JavaScript/TypeScript
+ *
+ * @packageDocumentation
  */
 
 export { check, Formatter, format } from './formatter.js'
diff --git a/packages/synth-js-minify/src/index.ts b/packages/synth-js-minify/src/index.ts
@@ -2,6 +2,8 @@
  * @sylphx/synth-js-minify
  *
  * JavaScript minifier using Synth's universal AST
+ *
+ * @packageDocumentation
  */
 
 export { Compressor } from './compressor.js'
diff --git a/packages/synth-js/src/index.ts b/packages/synth-js/src/index.ts
@@ -2,6 +2,8 @@
  * @sylphx/synth-js
  *
  * High-performance JavaScript/TypeScript parser for Synth
+ *
+ * @packageDocumentation
  */
 
 // Incremental tokenizer
diff --git a/packages/synth-json/src/index.ts b/packages/synth-json/src/index.ts
@@ -2,6 +2,8 @@
  * @sylphx/synth-json
  *
  * JSON parser using Synth's universal AST
+ *
+ * @packageDocumentation
  */
 
 // Incremental tokenizer
diff --git a/packages/synth-jsx/src/index.ts b/packages/synth-jsx/src/index.ts
@@ -3,6 +3,8 @@
  *
  * JSX/TSX parser using Synth's universal AST
  * Conversion layer over Acorn + acorn-jsx
+ *
+ * @packageDocumentation
  */
 
 export type { JSXParseOptions } from './parser.js'
diff --git a/packages/synth-lint/src/index.ts b/packages/synth-lint/src/index.ts
@@ -2,6 +2,8 @@
  * @sylphx/synth-lint
  *
  * Universal linter framework for Synth AST
+ *
+ * @packageDocumentation
  */
 
 export { createLinter, Linter } from './linter.js'
diff --git a/packages/synth-md-gfm/src/index.ts b/packages/synth-md-gfm/src/index.ts
@@ -8,6 +8,8 @@
  * - Strikethrough (~~text~~)
  * - Autolinks (URLs and email)
  * - Task lists ([x] and [ ])
+ *
+ * @packageDocumentation
  */
 
 import { createTransformPlugin, type TransformPlugin } from '@sylphx/synth'
@@ -49,6 +51,8 @@ export interface GFMPluginOptions {
  *
  * const tree = parse(markdown, { plugins: [gfmPlugin()] })
  * ```
+ *
+ * @packageDocumentation
  */
 export function gfmPlugin(options: GFMPluginOptions = {}): TransformPlugin {
   const { tables = true, strikethrough = true, autolinks = true, taskLists = true } = options
diff --git a/packages/synth-md-katex/src/index.ts b/packages/synth-md-katex/src/index.ts
@@ -8,6 +8,8 @@
  * $$
  * \frac{-b \pm \sqrt{b^2-4ac}}{2a}
  * $$
+ *
+ * @packageDocumentation
  */
 
 import type { BaseNode } from '@sylphx/synth'
@@ -59,6 +61,8 @@ export interface KatexPluginOptions {
  *
  * const tree = parse(markdown, { plugins: [katexPlugin()] })
  * ```
+ *
+ * @packageDocumentation
  */
 export function katexPlugin(options: KatexPluginOptions = {}): TransformPlugin {
   const { inlineMath = true, blockMath = true } = options
diff --git a/packages/synth-md-mermaid/src/index.ts b/packages/synth-md-mermaid/src/index.ts
@@ -8,6 +8,8 @@
  * graph TD
  *   A --> B
  * ```
+ *
+ * @packageDocumentation
  */
 
 import type { BaseNode } from '@sylphx/synth'
@@ -52,6 +54,8 @@ export interface MermaidPluginOptions {
  *
  * const tree = parse(markdown, { plugins: [mermaidPlugin()] })
  * ```
+ *
+ * @packageDocumentation
  */
 export function mermaidPlugin(_options: MermaidPluginOptions = {}): TransformPlugin {
   return createTransformPlugin(
diff --git a/packages/synth-md/src/index.ts b/packages/synth-md/src/index.ts
@@ -11,6 +11,8 @@
  * - Streaming support
  * - Full GFM support
  * - Plugin system
+ *
+ * @packageDocumentation
  */
 
 export { BatchTokenizer } from './batch-tokenizer.js'
diff --git a/packages/synth-metrics/src/index.ts b/packages/synth-metrics/src/index.ts
@@ -2,6 +2,8 @@
  * @sylphx/synth-metrics
  *
  * Code metrics and complexity analysis for Synth AST
+ *
+ * @packageDocumentation
  */
 
 export { analyze, createAnalyzer, MetricsAnalyzer, report } from './analyzer.js'
diff --git a/packages/synth-msgpack/src/index.ts b/packages/synth-msgpack/src/index.ts
@@ -2,6 +2,8 @@
  * @sylphx/synth-msgpack
  *
  * MessagePack parser using Synth's universal AST
+ *
+ * @packageDocumentation
  */
 
 export type { Node, Plugin, Tree } from '@sylphx/synth'
diff --git a/packages/synth-php/src/index.ts b/packages/synth-php/src/index.ts
@@ -2,6 +2,8 @@
  * @sylphx/synth-php
  *
  * PHP parser for Synth's universal AST
+ *
+ * @packageDocumentation
  */
 
 export { createParser, PhpParser, parse, parseAsync } from './parser.js'
diff --git a/packages/synth-protobuf/src/index.ts b/packages/synth-protobuf/src/index.ts
@@ -2,6 +2,8 @@
  * @sylphx/synth-protobuf
  *
  * Protocol Buffers parser using Synth's universal AST
+ *
+ * @packageDocumentation
  */
 
 export type { Node, Plugin, Tree } from '@sylphx/synth'
diff --git a/packages/synth-python/src/index.ts b/packages/synth-python/src/index.ts
@@ -3,6 +3,8 @@
  *
  * Python parser using Synth's universal AST
  * Conversion layer over tree-sitter-python
+ *
+ * @packageDocumentation
  */
 
 export type { PythonParseOptions } from './parser.js'
diff --git a/packages/synth-ruby/src/index.ts b/packages/synth-ruby/src/index.ts
@@ -2,6 +2,8 @@
  * @sylphx/synth-ruby
  *
  * Ruby parser for Synth's universal AST
+ *
+ * @packageDocumentation
  */
 
 export { createParser, parse, parseAsync, RubyParser } from './parser.js'
diff --git a/packages/synth-rust/src/index.ts b/packages/synth-rust/src/index.ts
@@ -3,6 +3,8 @@
  *
  * Rust parser using Synth's universal AST
  * Conversion layer over tree-sitter-rust
+ *
+ * @packageDocumentation
  */
 
 export type { RustParseOptions } from './parser.js'
diff --git a/packages/synth-sql/src/index.ts b/packages/synth-sql/src/index.ts
@@ -3,6 +3,8 @@
  *
  * SQL parser using Synth's universal AST
  * Conversion layer over node-sql-parser
+ *
+ * @packageDocumentation
  */
 
 export type { SQLParseOptions } from './parser.js'
diff --git a/packages/synth-toml/src/index.ts b/packages/synth-toml/src/index.ts
@@ -3,6 +3,8 @@
  *
  * TOML parser using Synth's universal AST
  * Hand-written, zero dependencies
+ *
+ * @packageDocumentation
  */
 
 export type { TOMLParseOptions } from './parser.js'
diff --git a/packages/synth-typecheck/src/index.ts b/packages/synth-typecheck/src/index.ts
@@ -2,6 +2,8 @@
  * @sylphx/synth-typecheck
  *
  * Type checker for Synth AST
+ *
+ * @packageDocumentation
  */
 
 export { check, createChecker, TypeChecker } from './checker.js'
diff --git a/packages/synth-vue/src/index.ts b/packages/synth-vue/src/index.ts
@@ -3,6 +3,8 @@
  *
  * Vue SFC parser using Synth's universal AST
  * Conversion layer over @vue/compiler-sfc
+ *
+ * @packageDocumentation
  */
 
 export type { VueParseOptions } from './parser.js'
diff --git a/packages/synth-wasm-js/src/index.ts b/packages/synth-wasm-js/src/index.ts
@@ -8,6 +8,8 @@
  * - parse(): Returns structured AST with decoded nodes
  * - parseBinary(): Maximum performance (returns raw Uint8Array)
  * - parseCount(): Node count only (for benchmarking)
+ *
+ * @packageDocumentation
  */
 
 // Initialization
diff --git a/packages/synth-wasm-md/bench/turbo.bench.ts b/packages/synth-wasm-md/bench/turbo.bench.ts
@@ -36,7 +36,7 @@ console.log()
 
 // Import parsers
 const { initWasm } = await import('../src/index.js')
-const { fastTokenize, fastParseBinary, turboParseBinary, turboParseCount } = await import(
+const { fastParseBinary, turboParseBinary, turboParseCount } = await import(
   '../wasm/synth_wasm_md.js'
 )
 const { parse: jsParse } = await import('@sylphx/synth-md')
diff --git a/packages/synth-wasm-md/src/index.ts b/packages/synth-wasm-md/src/index.ts
@@ -6,6 +6,8 @@
  * Performance vs JavaScript:
  * - parse(): 2-4x faster (returns JSON object)
  * - parseBinary(): 10-18x faster (returns Uint8Array)
+ *
+ * @packageDocumentation
  */
 
 // Initialization
diff --git a/packages/synth-wasm-md/wasm/synth_wasm_md_bg.wasm b/packages/synth-wasm-md/wasm/synth_wasm_md_bg.wasm
diff --git a/packages/synth-xml/src/index.ts b/packages/synth-xml/src/index.ts
@@ -3,6 +3,8 @@
  *
  * XML parser using Synth's universal AST
  * Conversion layer over fast-xml-parser
+ *
+ * @packageDocumentation
  */
 
 export type { XMLParseOptions } from './parser.js'
diff --git a/packages/synth-yaml/src/index.ts b/packages/synth-yaml/src/index.ts
@@ -2,6 +2,8 @@
  * @sylphx/synth-yaml
  *
  * YAML parser using Synth's universal AST
+ *
+ * @packageDocumentation
  */
 
 export type { YAMLParseOptions } from './parser.js'

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@`
`2`	`2`	`* @sylphx/synth-c`
`3`	`3`	`*`
`4`	`4`	`* C parser for Synth's universal AST`
	`5`	`+ *`
	`6`	`+ * @packageDocumentation`
`5`	`7`	`*/`
`6`	`8`
`7`	`9`	`export { CParser, createParser, parse, parseAsync } from './parser.js'`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,8 @@`
`3`	`3`	`*`
`4`	`4`	`* CSS3 parser using Synth's universal AST`
`5`	`5`	`* Hand-written, zero dependencies`
	`6`	`+ *`
	`7`	`+ * @packageDocumentation`
`6`	`8`	`*/`
`7`	`9`
`8`	`10`	`export type { CSSParseOptions } from './parser.js'`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@`
`2`	`2`	`* @sylphx/synth-docs`
`3`	`3`	`*`
`4`	`4`	`* Documentation generator for Synth AST`
	`5`	`+ *`
	`6`	`+ * @packageDocumentation`
`5`	`7`	`*/`
`6`	`8`
`7`	`9`	`export { createGenerator, DocGenerator, generate } from './generator.js'`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,8 @@`
`3`	`3`	`*`
`4`	`4`	`* Go parser using Synth's universal AST`
`5`	`5`	`* Conversion layer over tree-sitter-go`
	`6`	`+ *`
	`7`	`+ * @packageDocumentation`
`6`	`8`	`*/`
`7`	`9`
`8`	`10`	`export type { GoParseOptions } from './parser.js'`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,8 @@`
`3`	`3`	`*`
`4`	`4`	`* GraphQL parser using Synth's universal AST`
`5`	`5`	`* Conversion layer over graphql-js`
	`6`	`+ *`
	`7`	`+ * @packageDocumentation`
`6`	`8`	`*/`
`7`	`9`
`8`	`10`	`export type { GraphQLParseOptions } from './parser.js'`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@`
`2`	`2`	`* @sylphx/synth-html`
`3`	`3`	`*`
`4`	`4`	`* High-performance HTML5 parser for Synth`
	`5`	`+ *`
	`6`	`+ * @packageDocumentation`
`5`	`7`	`*/`
`6`	`8`
`7`	`9`	`// Incremental tokenizer`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,8 @@`
`3`	`3`	`*`
`4`	`4`	`* INI parser using Synth's universal AST`
`5`	`5`	`* Hand-written, zero dependencies`
	`6`	`+ *`
	`7`	`+ * @packageDocumentation`
`6`	`8`	`*/`
`7`	`9`
`8`	`10`	`export type { INIParseOptions } from './parser.js'`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@`
`2`	`2`	`* @sylphx/synth-java`
`3`	`3`	`*`
`4`	`4`	`* Java parser for Synth's universal AST`
	`5`	`+ *`
	`6`	`+ * @packageDocumentation`
`5`	`7`	`*/`
`6`	`8`
`7`	`9`	`export { createParser, JavaParser, parse, parseAsync } from './parser.js'`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@`
`2`	`2`	`* @sylphx/synth-js-format`
`3`	`3`	`*`
`4`	`4`	`* Prettier-style code formatter for JavaScript/TypeScript`
	`5`	`+ *`
	`6`	`+ * @packageDocumentation`
`5`	`7`	`*/`
`6`	`8`
`7`	`9`	`export { check, Formatter, format } from './formatter.js'`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@`
`2`	`2`	`* @sylphx/synth-js-minify`
`3`	`3`	`*`
`4`	`4`	`* JavaScript minifier using Synth's universal AST`
	`5`	`+ *`
	`6`	`+ * @packageDocumentation`
`5`	`7`	`*/`
`6`	`8`
`7`	`9`	`export { Compressor } from './compressor.js'`