test docs and bun automaticly

Author: sigmaSd

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Test
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Deno
+        uses: denoland/setup-deno@v2
+        with:
+          deno-version: v2.x
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Run tests
+        run: deno task test

deno.json

@@ -1,10 +1,10 @@
 {
   "name": "@sigma/parse",
-  "version": "0.48.0",
+  "version": "0.49.0",
   "exports": "./mod.ts",
   "license": "MIT",
   "tasks": {
-    "test": "deno test && bun test --preload ./bun-preload.ts"
+    "test": "deno doc --lint mod.ts && deno test --doc && bun test --preload ./bun-preload.ts"
   },
   "imports": {
     "@std/assert": "jsr:@std/assert@^1.0.18"

mod.ts

@@ -77,8 +77,11 @@ export {
 export type {
   ArgOptions,
   ArgumentMetadata,
+  CollectionOptions,
   CommandInstance,
+  CommandOptions,
   CommonOptions,
+  DecoratorContext,
   OptDef,
   OptOptions,
   ParseOptions,
@@ -87,9 +90,10 @@ export type {
   PositionalDef as ArgumentDef,
   PropertyMetadata,
   SubCommand,
+  SubCommandOptions,
   SupportedType,
   Validator,
-} from "./src/types.ts";
+} from "./src/index.ts";
 
 // Export error handling utilities
 export {

src/decorators.ts

@@ -73,8 +73,7 @@ export function addValidator(validator: Validator): (
  * 1. With a built-in or custom validator function (e.g., `@validate(range(1, 10))`)
  * 2. With a predicate function and custom error message (e.g., `@validate(val => val > 0, "must be positive")`)
  *
- * @param validatorOrPredicate - A validator function OR a predicate function
- * @param message - Error message (required only if using a predicate)
+ * @param validator - A validator function
  * @returns A decorator function
  */
 export function validate<T>(
@@ -83,13 +82,27 @@ export function validate<T>(
   _target: unknown,
   context: DecoratorContext,
 ) => void;
+/**
+ * Validate decorator for custom validation logic.
+ *
+ * @param predicate - Function that returns true if value is valid
+ * @param message - Error message to show when validation fails
+ * @returns A decorator function
+ */
 export function validate<T>(
   predicate: (value: T) => boolean,
   message: string,
 ): (
   _target: unknown,
   context: DecoratorContext,
 ) => void;
+/**
+ * Validate decorator for custom validation logic.
+ *
+ * @param validatorOrPredicate - A validator function OR a predicate function
+ * @param message - Error message (required only if using a predicate)
+ * @returns A decorator function
+ */
 export function validate<T>(
   validatorOrPredicate: Validator | ((value: T) => boolean),
   message?: string,
@@ -121,10 +134,24 @@ export function command(
   target: T,
   ctx: ClassDecoratorContext,
 ) => T;
+/**
+ * Command decorator to mark a class as a CLI command or subcommand.
+ *
+ * @param target - The class constructor being decorated
+ * @param ctx - The class decorator context
+ * @returns The original or a modified class constructor
+ */
 export function command<T extends new () => unknown>(
   target: T,
   ctx: ClassDecoratorContext,
 ): T;
+/**
+ * Command decorator to mark a class as a CLI command or subcommand.
+ *
+ * @param optionsOrTarget - Either command options or the class constructor
+ * @param _maybeCtx - Optional context (only present when used as a direct decorator)
+ * @returns The decorator function or the decorated class
+ */
 export function command<T extends new () => unknown>(
   optionsOrTarget?: CommandOptions | T,
   _maybeCtx?: ClassDecoratorContext,

src/index.ts

@@ -101,6 +101,7 @@ export {
   type DecoratorContext,
   opt,
   subCommand,
+  type SubCommandOptions,
   validate,
 } from "./decorators.ts";
 export {
@@ -119,6 +120,7 @@ export { printHelp } from "./help.ts";
 export {
   collectArgumentDefs,
   collectInstanceArgumentDefs,
+  type CollectionOptions,
   extractTypeFromDescriptor,
 } from "./metadata.ts";
 export {

src/metadata.ts

@@ -10,7 +10,11 @@ import type {
   SupportedType,
 } from "./types.ts";
 
-interface CollectionOptions {
+/**
+ * Configuration options for metadata collection.
+ */
+export interface CollectionOptions {
+  /** Whether to throw errors when types cannot be inferred */
   strict?: boolean;
 }