@openpkg-ts/extract 0.11.2 → 0.11.3

package/dist/bin/tspec.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import {
   extract
-} from "../shared/chunk-570ne82m.js";
+} from "../shared/chunk-9x67bae3.js";
 
 // src/cli/spec.ts
 import * as fs from "node:fs";

package/dist/shared/{chunk-570ne82m.js → chunk-9x67bae3.js}

@@ -29,6 +29,27 @@ class TypeRegistry {
 
 // src/ast/utils.ts
 import ts from "typescript";
+function parseExamplesFromTags(tags) {
+  const examples = [];
+  for (const tag of tags) {
+    if (tag.name !== "example")
+      continue;
+    const text = tag.text.trim();
+    const fenceMatch = text.match(/^```(\w*)\n([\s\S]*?)\n?```$/);
+    if (fenceMatch) {
+      const lang = fenceMatch[1] || undefined;
+      const code = fenceMatch[2].trim();
+      const example = { code };
+      if (lang && ["ts", "js", "tsx", "jsx", "shell", "json"].includes(lang)) {
+        example.language = lang;
+      }
+      examples.push(example);
+    } else if (text) {
+      examples.push({ code: text });
+    }
+  }
+  return examples;
+}
 function getJSDocComment(node) {
   const jsDocTags = ts.getJSDocTags(node);
   const tags = jsDocTags.map((tag) => ({
@@ -43,7 +64,8 @@ function getJSDocComment(node) {
       description = typeof firstDoc.comment === "string" ? firstDoc.comment : ts.getTextOfJSDocComment(firstDoc.comment);
     }
   }
-  return { description, tags };
+  const examples = parseExamplesFromTags(tags);
+  return { description, tags, examples };
 }
 function getSourceLocation(node, sourceFile) {
   const { line } = sourceFile.getLineAndCharacterOfPosition(node.getStart(sourceFile));
@@ -109,7 +131,7 @@ function serializeClass(node, ctx) {
   if (!name)
     return null;
   const declSourceFile = node.getSourceFile();
-  const { description, tags } = getJSDocComment(node);
+  const { description, tags, examples } = getJSDocComment(node);
   const source = getSourceLocation(node, declSourceFile);
   return {
     id: name,
@@ -118,7 +140,8 @@ function serializeClass(node, ctx) {
     description,
     tags,
     source,
-    members: []
+    members: [],
+    ...examples.length > 0 ? { examples } : {}
   };
 }
 
@@ -129,7 +152,7 @@ function serializeEnum(node, ctx) {
   if (!name)
     return null;
   const declSourceFile = node.getSourceFile();
-  const { description, tags } = getJSDocComment(node);
+  const { description, tags, examples } = getJSDocComment(node);
   const source = getSourceLocation(node, declSourceFile);
   const members = node.members.map((member) => {
     const memberSymbol = ctx.typeChecker.getSymbolAtLocation(member.name);
@@ -147,7 +170,8 @@ function serializeEnum(node, ctx) {
     description,
     tags,
     source,
-    members
+    members,
+    ...examples.length > 0 ? { examples } : {}
   };
 }
 
@@ -170,7 +194,7 @@ function serializeFunctionExport(node, ctx) {
   if (!name)
     return null;
   const declSourceFile = node.getSourceFile();
-  const { description, tags } = getJSDocComment(node);
+  const { description, tags, examples } = getJSDocComment(node);
   const source = getSourceLocation(node, declSourceFile);
   const type = ctx.typeChecker.getTypeAtLocation(node);
   const callSignatures = type.getCallSignatures();
@@ -191,7 +215,8 @@ function serializeFunctionExport(node, ctx) {
     description,
     tags,
     source,
-    signatures
+    signatures,
+    ...examples.length > 0 ? { examples } : {}
   };
 }
 
@@ -202,7 +227,7 @@ function serializeInterface(node, ctx) {
   if (!name)
     return null;
   const declSourceFile = node.getSourceFile();
-  const { description, tags } = getJSDocComment(node);
+  const { description, tags, examples } = getJSDocComment(node);
   const source = getSourceLocation(node, declSourceFile);
   return {
     id: name,
@@ -211,7 +236,8 @@ function serializeInterface(node, ctx) {
     description,
     tags,
     source,
-    members: []
+    members: [],
+    ...examples.length > 0 ? { examples } : {}
   };
 }
 
@@ -222,7 +248,7 @@ function serializeTypeAlias(node, ctx) {
   if (!name)
     return null;
   const declSourceFile = node.getSourceFile();
-  const { description, tags } = getJSDocComment(node);
+  const { description, tags, examples } = getJSDocComment(node);
   const source = getSourceLocation(node, declSourceFile);
   const type = ctx.typeChecker.getTypeAtLocation(node);
   const typeString = ctx.typeChecker.typeToString(type);
@@ -233,7 +259,8 @@ function serializeTypeAlias(node, ctx) {
     description,
     tags,
     source,
-    ...typeString !== name ? { type: typeString } : {}
+    ...typeString !== name ? { type: typeString } : {},
+    ...examples.length > 0 ? { examples } : {}
   };
 }
 
@@ -244,7 +271,7 @@ function serializeVariable(node, statement, ctx) {
   if (!name)
     return null;
   const declSourceFile = node.getSourceFile();
-  const { description, tags } = getJSDocComment(statement);
+  const { description, tags, examples } = getJSDocComment(statement);
   const source = getSourceLocation(node, declSourceFile);
   const type = ctx.typeChecker.getTypeAtLocation(node);
   const typeString = ctx.typeChecker.typeToString(type);
@@ -255,7 +282,8 @@ function serializeVariable(node, statement, ctx) {
     description,
     tags,
     source,
-    ...typeString && typeString !== name ? { type: typeString } : {}
+    ...typeString && typeString !== name ? { type: typeString } : {},
+    ...examples.length > 0 ? { examples } : {}
   };
 }
 

package/dist/src/index.d.ts

@@ -8,14 +8,18 @@ declare class TypeRegistry {
 	getAll(): SpecType[];
 	registerFromSymbol(symbol: ts.Symbol, checker: ts.TypeChecker): SpecType | undefined;
 }
-import { SpecSource, SpecTag } from "@openpkg-ts/spec";
+import { SpecExample, SpecSource, SpecTag } from "@openpkg-ts/spec";
 import ts2 from "typescript";
 declare function getJSDocComment(node: ts2.Node): {
 	description?: string;
 	tags: SpecTag[];
+	examples: SpecExample[];
 };
 declare function getSourceLocation(node: ts2.Node, sourceFile: ts2.SourceFile): SpecSource;
 import { OpenPkg } from "@openpkg-ts/spec";
+import { TypeChecker as TypeChecker_vexmldwuwp } from "typescript";
+import { Program as Program_lhgjafqgga } from "typescript";
+import { SourceFile as SourceFile_sameteuoys } from "typescript";
 interface ExtractOptions {
 	entryFile: string;
 	baseDir?: string;
@@ -38,9 +42,9 @@ interface Diagnostic {
 	};
 }
 interface SerializerContext {
-	typeChecker: import("typescript").TypeChecker;
-	program: import("typescript").Program;
-	sourceFile: import("typescript").SourceFile;
+	typeChecker: TypeChecker_vexmldwuwp;
+	program: Program_lhgjafqgga;
+	sourceFile: SourceFile_sameteuoys;
 	maxTypeDepth: number;
 	resolveExternalTypes: boolean;
 }

package/dist/src/index.js

@@ -11,7 +11,7 @@ import {
   serializeInterface,
   serializeTypeAlias,
   serializeVariable
-} from "../shared/chunk-570ne82m.js";
+} from "../shared/chunk-9x67bae3.js";
 // src/schema/adapters/arktype.ts
 var arktypeAdapter = {
   name: "arktype",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openpkg-ts/extract",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "description": "TypeScript export extraction to OpenPkg spec",
   "keywords": [
     "openpkg",
@@ -40,7 +40,7 @@
     "format": "biome format --write src/"
   },
   "dependencies": {
-    "@openpkg-ts/spec": "workspace:*",
+    "@openpkg-ts/spec": "^0.11.1",
     "commander": "^12.0.0",
     "typescript": "^5.0.0"
   },