reworked doc-snippets config for client config builder to properly extract snippets from examples

Author: krisbitney

packages/js/client-config-builder/README.md

@@ -36,7 +36,7 @@ export function configure(): ClientConfigBuilder {
     resolvers: [],
   });
 
-  // add or remove items using the more specific add methods
+  // add or remove items by chaining method calls
   builder
     .addPackage({
       uri: "wrap://plugin/package",

packages/js/client-config-builder/examples/quickstart.ts

@@ -53,13 +53,16 @@
   },
   "doc-snippets": {
     "extract": {
-      "include": "./**/*.{ts,tsx,json,yaml,txt,md,graphql,cue}",
+      "include": [
+        "./src/**/*.{ts,tsx,json,yaml,txt,md,graphql,cue}",
+        "./examples/**/*.{ts,tsx,json,yaml,txt,md,graphql,cue}"
+      ],
       "ignore": [
         "./**/node_modules/**",
         "./**/.polywrap/**",
         "./**/__tests__/**"
       ],
-      "dir": "./src"
+      "dir": "./"
     },
     "inject": {
       "dir": "./readme",

packages/js/client-config-builder/package.json

@@ -41,7 +41,7 @@ $snippet: quickstart-build
 A complete example using all or most of the available methods.
 
 ```typescript=
-$snippet: quickstart
+$snippet: quickstart-example
 ```
 
 # Reference

packages/js/client-config-builder/readme/README.md

@@ -8,6 +8,5 @@
   ],
   "exclude": [
     "./src/**/__tests__",
-    "./examples"
   ]
 }

packages/js/client-config-builder/tsconfig.build.json

@@ -104,6 +104,8 @@ const client = new PolywrapClient(config);
 const altClient = new PolywrapClient(config, { noDefaults: true });
 ```
 
+# Reference
+
 ## Types
 
 ```ts

packages/js/client/README.md

@@ -82,6 +82,8 @@ const config = {
 const client = new PolywrapCoreClient(config);
 ```
 
+# Reference
+
 ## Types
 
 ```ts
@@ -194,7 +196,7 @@ export interface PolywrapCoreClientConfig<
   @Tracer.traceMethod("PolywrapClient: getManifest")
   public async getManifest<TUri extends Uri | string>(
     uri: TUri
-  ): Promise<Result<WrapManifest, Error>> 
+  ): Promise<Result<WrapManifest, WrapError>> 
 ```
 
 ### getFile
@@ -210,7 +212,7 @@ export interface PolywrapCoreClientConfig<
   public async getFile<TUri extends Uri | string>(
     uri: TUri,
     options: GetFileOptions
-  ): Promise<Result<string | Uint8Array, Error>> 
+  ): Promise<Result<string | Uint8Array, WrapError>> 
 ```
 
 ### getImplementations
@@ -227,7 +229,7 @@ export interface PolywrapCoreClientConfig<
   public async getImplementations<TUri extends Uri | string>(
     uri: TUri,
     options: GetImplementationsOptions = {}
-  ): Promise<Result<TUri[], Error>> 
+  ): Promise<Result<TUri[], WrapError>> 
 ```
 
 ### invokeWrapper
@@ -337,7 +339,7 @@ export interface PolywrapCoreClientConfig<
     uri: Uri,
     resolutionContext?: IUriResolutionContext,
     options?: DeserializeManifestOptions
-  ): Promise<Result<Wrapper, Error>> 
+  ): Promise<Result<Wrapper, WrapError>> 
 ```
 
 ### validate
@@ -350,11 +352,11 @@ export interface PolywrapCoreClientConfig<
    * @param options - { abi?: boolean; recursive?: boolean }
    * @returns A Promise with a Result containing a boolean or Error
    */
-  @Tracer.traceMethod("PolywrapClient: validateConfig")
+  @Tracer.traceMethod("PolywrapClient: validate")
   public async validate<TUri extends Uri | string>(
     uri: TUri,
     options: ValidateOptions
-  ): Promise<Result<true, Error>> 
+  ): Promise<Result<true, WrapError>> 
 ```
 
 ## Development

packages/js/core-client/README.md

@@ -2,6 +2,8 @@
 
 A TypeScript / JavaScript implementation of the WRAP standard, including all fundamental types & algorithms.
 
+# Reference
+
 ## Types
 
 ### CoreClient
@@ -93,7 +95,7 @@ export interface CoreClient extends Invoker, UriResolverHandler<unknown> {
    */
   getManifest<TUri extends Uri | string>(
     uri: TUri
-  ): Promise<Result<WrapManifest, Error>>;
+  ): Promise<Result<WrapManifest, WrapError>>;
 
   /**
    * returns a file contained in a wrap package
@@ -105,7 +107,7 @@ export interface CoreClient extends Invoker, UriResolverHandler<unknown> {
   getFile<TUri extends Uri | string>(
     uri: TUri,
     options: GetFileOptions
-  ): Promise<Result<string | Uint8Array, Error>>;
+  ): Promise<Result<string | Uint8Array, WrapError>>;
 
   /**
    * returns the interface implementations associated with an interface URI
@@ -118,7 +120,7 @@ export interface CoreClient extends Invoker, UriResolverHandler<unknown> {
   getImplementations<TUri extends Uri | string>(
     uri: TUri,
     options: GetImplementationsOptions
-  ): Promise<Result<TUri[], Error>>;
+  ): Promise<Result<TUri[], WrapError>>;
 
   /**
    * Validate a wrapper, given a URI.
@@ -131,7 +133,7 @@ export interface CoreClient extends Invoker, UriResolverHandler<unknown> {
   validate<TUri extends Uri | string>(
     uri: TUri,
     options?: ValidateOptions
-  ): Promise<Result<true, Error>>;
+  ): Promise<Result<true, WrapError>>;
 }
 
 ```
@@ -193,7 +195,7 @@ export interface InvokeOptions<TUri extends Uri | string = string> {
  *
  * @template TData Type of the invoke result data.
  */
-export type InvokeResult<TData = unknown> = Result<TData, Error>;
+export type InvokeResult<TData = unknown> = Result<TData, WrapError>;
 
 /**
  * Provides options for the invoker to set based on the state of the invocation.
@@ -580,7 +582,7 @@ export interface MaybeUriOrManifest {
       invoker: Invoker,
       wrapper: Uri,
       uri: Uri
-    ): Promise<Result<MaybeUriOrManifest, Error>> 
+    ): Promise<Result<MaybeUriOrManifest, WrapError>> 
 ```
 
 #### getFile
@@ -598,7 +600,7 @@ export interface MaybeUriOrManifest {
       invoker: Invoker,
       wrapper: Uri,
       path: string
-    ): Promise<Result<Uint8Array | undefined, Error>> 
+    ): Promise<Result<Uint8Array | undefined, WrapError>> 
 ```
 
 ## Uri Resolution