add examples directory

Author: EthanThatOneKid

README.md

@@ -3,8 +3,12 @@
 Reason with TypeScript code via
 [type introspection](https://en.wikipedia.org/wiki/Type_introspection).
 
-TODO: Figure out what else to do next with this such as merging the PR that is
-currently open, at least.
+## Introspection
+
+Introspection helps avoid the problem of slow types introduced by libraries like
+Zod and TypeBox. It allows you to determine the type of a value at runtime,
+rather than inferring it at compile time. This can lead to more efficient and
+dynamic type handling in your TypeScript projects.
 
 ## Installation
 
@@ -22,10 +26,18 @@ currently open, at least.
 > it has an extremely fast built-in type checker, it can create example values
 > based on schemas, and a lot more.
 >
-> - <https://blog.val.town/blog/typebox/>
+> \- <https://blog.val.town/blog/typebox/>
+
+Introspection helps avoid the problem of slow types introduced by libraries like
+Zod and TypeBox. It allows you to determine the type of a value at runtime,
+rather than inferring it at compile time. This can lead to more efficient and
+dynamic type handling in your TypeScript projects.
 
 ### TypeBox example
 
+Instantiate a TypeBox schema at runtime using introspection via
+`@sinclair/typebox/compiler`.
+
 ```ts
 // TODO: Add TypeBox example.
 ```

lib/typebox/schema-from-introspection.test.ts renamed to examples/schema-from-introspection.test.ts

@@ -3,8 +3,8 @@ import { TypeCompiler } from "@sinclair/typebox/compiler";
 import {
   EXAMPLE_PERSON,
   EXAMPLE_PERSON_INTROSPECTION,
-} from "#/lib/introspector/example/person.ts";
-import { schemaFromIntrospection } from "./schema-from-introspection.ts";
+} from "#/lib/example/person.ts";
+import { schemaFromIntrospection } from "#/lib/typebox/schema-from-introspection.ts";
 
 Deno.test("schemaFromIntrospection introspects TypeScript class", () => {
   const schema = schemaFromIntrospection(EXAMPLE_PERSON_INTROSPECTION);

lib/introspector/tree-sitter-introspector.test.ts renamed to examples/tree-sitter-introspector.test.ts

@@ -1,11 +1,11 @@
 import { assertEquals } from "@std/assert";
-import { EXAMPLE_TYPESCRIPT_TREE_SITTER_PARSER } from "./example/tree-sitter-parser.ts";
+import { TreeSitterIntrospector } from "#/lib/introspector/tree-sitter-introspector.ts";
+import { EXAMPLE_TYPESCRIPT_TREE_SITTER_PARSER } from "../lib/example/tree-sitter-parser.ts";
 import {
   EXAMPLE_PERSON_INTROSPECTION,
   EXAMPLE_PERSON_SOURCE_CODE,
   Person,
-} from "./example/person.ts";
-import { TreeSitterIntrospector } from "./tree-sitter-introspector.ts";
+} from "#/lib/example/person.ts";
 
 Deno.test("TreeSitterIntrospector introspects TypeScript class", () => {
   const introspector = new TreeSitterIntrospector(

lib/introspector/example/book.ts renamed to lib/example/book.ts

@@ -1,6 +1,5 @@
 import { queryRootNode } from "#/lib/tree-sitter/tree-sitter.ts";
 import type { Introspection } from "#/lib/introspector/introspector.ts";
-
 import { makeTreeSitterTypeScriptClassPattern } from "#/lib/introspector/tree-sitter-introspector.ts";
 import {
   EXAMPLE_TYPESCRIPT_CLASS_TREE_SITTER_CAPTURE_NAME_MAP,