@azure-tools/typespec-azure-examples 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation. All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/README.md

@@ -0,0 +1,83 @@
+# @azure-tools/typespec-azure-examples
+
+Tooling for the Azure **unified examples format** (`examples.yaml`): the published JSON Schema
+and the `tsp-examples` CLI.
+
+The unified examples format replaces the ~282K per-version `x-ms-examples` JSON files with a
+single version-aware `examples.yaml` per service (or `examples/<Interface>.yaml` for large
+services). See the RFC: _Unified Examples Format_.
+
+## Format
+
+```yaml
+$schema: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/schemas/examples.schema.yaml
+$namespace: Microsoft.EventGrid
+
+CaCertificates.get:
+  - request:
+      path:
+        subscriptionId: 8f6b6269-84f2-4d09-9e31-1127efcd1e40
+        resourceGroupName: myResourceGroup
+    responses:
+      200:
+        body:
+          name: exampleCaCertificate
+          properties:
+            provisioningState: Succeeded
+  - since: "2023-12-15-preview"
+    request:
+      path:
+        subscriptionId: 8f6b6269-84f2-4d09-9e31-1127efcd1e40
+        resourceGroupName: myResourceGroup
+    responses:
+      200:
+        body:
+          name: exampleCaCertificate
+          properties:
+            provisioningState: Succeeded
+            delegatedIdentityTokenExpirationTimeInUtc: "2023-10-12T23:06:43+00:00"
+```
+
+- File metadata uses `$`-prefixed keys (`$schema`, `$namespace`); every bare top-level key is an
+  operation, identified by its interface-relative name (`Interface.operation`).
+- Each operation maps to a list of example variants. The base variant has no `since`; later
+  variants carry a quoted `since` and restate the full request/response.
+- Response status codes are bare integer keys. `api-version` is implicit; use the
+  `{api-version}` placeholder where a version must be embedded in a value.
+
+## `tsp-examples validate`
+
+Validate a service's example files against the JSON Schema and the format rules:
+
+```bash
+tsp-examples validate <service-dir>
+```
+
+It discovers `examples.yaml` and `examples/*.yaml` in the directory, reads the adjacent
+`service.yaml` for version metadata, and reports diagnostics. It exits non-zero if any error is
+found (use `--warn-as-error` to also fail on warnings).
+
+### Rules enforced
+
+- Only `$schema`/`$namespace` may be `$`-prefixed; other bare keys are operations that must be a
+  list of examples.
+- Response keys are integer status codes; range keys (`2XX`) and `default` are rejected.
+- `since` must be a quoted string and a version listed in `service.yaml`.
+- Per lineage (entries grouped by `title`; untitled entries form the default lineage): at most one
+  entry without `since`, and `since` values are unique.
+- An operation's full example set lives in a single file, and each interface appears in exactly
+  one file.
+- `{api-version}` is the only supported placeholder, and `api-version` must not appear as a
+  request parameter.
+
+## API
+
+```ts
+import {
+  validateExamplesDir,
+  validateExampleFiles,
+  loadExampleFile,
+} from "@azure-tools/typespec-azure-examples";
+
+const { diagnostics } = await validateExamplesDir("path/to/service");
+```

package/dist/schema/dist/ExamplesYaml.json

@@ -0,0 +1,111 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "examples.yaml",
+    "type": "object",
+    "properties": {
+        "$schema": {
+            "type": "string",
+            "description": "Schema URL. Gives editors autocomplete and inline validation while authoring."
+        },
+        "$namespace": {
+            "type": "string",
+            "description": "Service namespace (e.g. `Microsoft.EventGrid`), prepended to each operation key to form\nthe fully-qualified operation identity used for Swagger linkage (`x-id`)."
+        }
+    },
+    "unevaluatedProperties": {
+        "anyOf": [
+            {
+                "type": "array",
+                "items": {
+                    "$ref": "#/$defs/Example"
+                }
+            },
+            {
+                "type": "string"
+            }
+        ]
+    },
+    "description": "Top-level `examples.yaml` file: `$schema`/`$namespace` metadata plus one entry per\noperation, keyed by the interface-relative operation name (e.g. `CaCertificates.get`).\nEach operation maps to a list of example variants.\n\nThe indexer is widened to `Example[] | string` so the `$`-prefixed string metadata keys\nare structurally valid. The rules that a bare (non-`$`) key must be a list of examples and\nthat the only allowed metadata keys are `$schema`/`$namespace` are enforced by the\n`examples-validate` semantic rules.",
+    "$defs": {
+        "Example": {
+            "type": "object",
+            "properties": {
+                "title": {
+                    "type": "string",
+                    "description": "Optional human-readable title. Omit for the single-example case; provide it only to\ndisambiguate multiple distinct examples on the same operation. Entries sharing a `title`\nform one lineage; untitled entries all belong to the single default lineage."
+                },
+                "description": {
+                    "type": "string",
+                    "description": "Longer description of what this example demonstrates."
+                },
+                "legacyFilename": {
+                    "type": "string",
+                    "description": "Legacy `x-ms-examples` file name (e.g. `CaCertificates_Get.json`) this variant was migrated\nfrom. Preserved so an emitter can re-materialize the legacy file under its original name,\nkeeping the diff minimal during rollout. When omitted, the emitter derives the file name (and\nthe `x-ms-examples` key) from the operation id and `title`."
+                },
+                "since": {
+                    "type": "string",
+                    "description": "Quoted version from which this variant applies (must be a version listed in the service's\n`service.yaml`). Omit to apply from the earliest version."
+                },
+                "request": {
+                    "$ref": "#/$defs/ExampleRequest",
+                    "description": "The request of the API interaction."
+                },
+                "responses": {
+                    "$ref": "#/$defs/RecordExampleResponse",
+                    "description": "Responses keyed by integer status code (e.g. `200`, `404`)."
+                }
+            },
+            "required": [
+                "request",
+                "responses"
+            ],
+            "description": "A single example variant representing one complete API interaction."
+        },
+        "ExampleRequest": {
+            "type": "object",
+            "properties": {
+                "path": {
+                    "$ref": "#/$defs/RecordUnknown",
+                    "description": "Path parameters. `api-version` is implicit and MUST NOT be included."
+                },
+                "query": {
+                    "$ref": "#/$defs/RecordUnknown",
+                    "description": "Query parameters (e.g. `$top`, `$filter`)."
+                },
+                "headers": {
+                    "$ref": "#/$defs/RecordUnknown",
+                    "description": "Request headers (e.g. `If-Match`)."
+                },
+                "body": {
+                    "description": "Request body. Structure matches the operation's request schema."
+                }
+            },
+            "description": "The request portion of an example, split by parameter location."
+        },
+        "RecordExampleResponse": {
+            "type": "object",
+            "properties": {},
+            "unevaluatedProperties": {
+                "$ref": "#/$defs/ExampleResponse"
+            }
+        },
+        "RecordUnknown": {
+            "type": "object",
+            "properties": {},
+            "unevaluatedProperties": {}
+        },
+        "ExampleResponse": {
+            "type": "object",
+            "properties": {
+                "headers": {
+                    "$ref": "#/$defs/RecordUnknown",
+                    "description": "Response headers (e.g. `Location`, `Azure-AsyncOperation`)."
+                },
+                "body": {
+                    "description": "Response body. Structure matches the operation's response schema."
+                }
+            },
+            "description": "A single response of an example, keyed in the parent map by integer status code."
+        }
+    }
+}

package/dist/src/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/src/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":""}

package/dist/src/cli.js

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+/* eslint-disable no-console */
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+import { validateCommand } from "./commands/validate.js";
+/**
+ * `tsp-examples` — the permanent CLI for the unified examples format. Sub-commands operate on a
+ * service's `examples.yaml` (`scaffold` and `add` are registered here as they land).
+ */
+async function main() {
+    await yargs(hideBin(process.argv))
+        .scriptName("tsp-examples")
+        .command(validateCommand)
+        .demandCommand(1, "Specify a command (e.g. `validate`).")
+        .strict()
+        .help()
+        .parseAsync();
+}
+main().catch((error) => {
+    console.error(error);
+    process.exit(1);
+});
+//# sourceMappingURL=cli.js.map

package/dist/src/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":";AACA,+BAA+B;AAC/B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD;;;GAGG;AACH,KAAK,UAAU,IAAI;IACjB,MAAM,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAC/B,UAAU,CAAC,cAAc,CAAC;SAC1B,OAAO,CAAC,eAAe,CAAC;SACxB,aAAa,CAAC,CAAC,EAAE,sCAAsC,CAAC;SACxD,MAAM,EAAE;SACR,IAAI,EAAE;SACN,UAAU,EAAE,CAAC;AAClB,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/dist/src/commands/validate.d.ts

@@ -0,0 +1,9 @@
+import type { CommandModule } from "yargs";
+interface ValidateArgs {
+    dir: string;
+    "warn-as-error": boolean;
+}
+/** `tsp-examples validate` — validate the unified examples files in a service directory. */
+export declare const validateCommand: CommandModule<unknown, ValidateArgs>;
+export {};
+//# sourceMappingURL=validate.d.ts.map

package/dist/src/commands/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../src/commands/validate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAI3C,UAAU,YAAY;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED,4FAA4F;AAC5F,eAAO,MAAM,eAAe,EAAE,aAAa,CAAC,OAAO,EAAE,YAAY,CAoChE,CAAC"}

package/dist/src/commands/validate.js

@@ -0,0 +1,37 @@
+/* eslint-disable no-console */
+import { resolve } from "path";
+import { validateExamplesDir } from "../discover.js";
+import { formatDiagnostics, formatSummary } from "../reporter.js";
+/** `tsp-examples validate` — validate the unified examples files in a service directory. */
+export const validateCommand = {
+    command: "validate [dir]",
+    describe: "Validate unified examples format files (examples.yaml)",
+    builder: (yargs) => yargs
+        .positional("dir", {
+        type: "string",
+        describe: "Service directory containing examples.yaml / examples/*.yaml and service.yaml",
+        default: ".",
+    })
+        .option("warn-as-error", {
+        type: "boolean",
+        default: false,
+        describe: "Treat warnings as errors (non-zero exit)",
+    }),
+    handler: async (args) => {
+        const dir = resolve(process.cwd(), args.dir);
+        const { diagnostics, files } = await validateExamplesDir(dir);
+        if (files.length === 0) {
+            console.error(`No examples files found in ${dir} (looked for examples.yaml and examples/*.yaml).`);
+            process.exit(1);
+        }
+        if (diagnostics.length > 0) {
+            console.log(formatDiagnostics(diagnostics));
+            console.log("");
+        }
+        console.log(formatSummary(diagnostics));
+        const hasError = diagnostics.some((d) => d.severity === "error");
+        const hasWarning = diagnostics.some((d) => d.severity === "warning");
+        process.exit(hasError || (args["warn-as-error"] && hasWarning) ? 1 : 0);
+    },
+};
+//# sourceMappingURL=validate.js.map

package/dist/src/commands/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../../src/commands/validate.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAOlE,4FAA4F;AAC5F,MAAM,CAAC,MAAM,eAAe,GAAyC;IACnE,OAAO,EAAE,gBAAgB;IACzB,QAAQ,EAAE,wDAAwD;IAClE,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CACjB,KAAK;SACF,UAAU,CAAC,KAAK,EAAE;QACjB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,+EAA+E;QACzF,OAAO,EAAE,GAAG;KACb,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACvB,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,0CAA0C;KACrD,CAAC;IACN,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QACtB,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7C,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,MAAM,mBAAmB,CAAC,GAAG,CAAC,CAAC;QAE9D,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO,CAAC,KAAK,CACX,8BAA8B,GAAG,kDAAkD,CACpF,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC;YAC5C,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAClB,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC;QAExC,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC;QACjE,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC;QACrE,OAAO,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF,CAAC"}

package/dist/src/discover.d.ts

@@ -0,0 +1,20 @@
+import type { ExampleDiagnostic } from "./types.js";
+/** Result of validating an examples directory. */
+export interface ValidateDirResult {
+    /** All diagnostics produced (errors and warnings). */
+    readonly diagnostics: ExampleDiagnostic[];
+    /** The example files that were discovered and validated. */
+    readonly files: string[];
+}
+/**
+ * Discover the example files under `dir`: a top-level `examples.yaml` and/or per-interface
+ * files under `examples/` (`examples/<Interface>.yaml`).
+ */
+export declare function discoverExampleFiles(dir: string): Promise<string[]>;
+/**
+ * Validate all example files in a service directory. Discovers `examples.yaml` /
+ * `examples/*.yaml` and the adjacent `service.yaml` (for the `since ∈ service.yaml` check),
+ * then runs {@link validateExampleFiles}. Paths in diagnostics are relative to `dir`.
+ */
+export declare function validateExamplesDir(dir: string): Promise<ValidateDirResult>;
+//# sourceMappingURL=discover.d.ts.map

package/dist/src/discover.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"discover.d.ts","sourceRoot":"","sources":["../../src/discover.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAGpD,kDAAkD;AAClD,MAAM,WAAW,iBAAiB;IAChC,sDAAsD;IACtD,QAAQ,CAAC,WAAW,EAAE,iBAAiB,EAAE,CAAC;IAC1C,4DAA4D;IAC5D,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;CAC1B;AAWD;;;GAGG;AACH,wBAAsB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAgBzE;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAqCjF"}

package/dist/src/discover.js

@@ -0,0 +1,73 @@
+import { readdir, readFile, stat } from "fs/promises";
+import { join, relative } from "path";
+import { loadExampleFile, parseServiceVersions } from "./loader.js";
+import { validateExampleFiles } from "./validate.js";
+async function exists(path) {
+    try {
+        await stat(path);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Discover the example files under `dir`: a top-level `examples.yaml` and/or per-interface
+ * files under `examples/` (`examples/<Interface>.yaml`).
+ */
+export async function discoverExampleFiles(dir) {
+    const found = [];
+    const topLevel = join(dir, "examples.yaml");
+    if (await exists(topLevel))
+        found.push(topLevel);
+    const examplesDir = join(dir, "examples");
+    if ((await exists(examplesDir)) && (await stat(examplesDir)).isDirectory()) {
+        for (const entry of await readdir(examplesDir)) {
+            if (entry.endsWith(".yaml") || entry.endsWith(".yml")) {
+                found.push(join(examplesDir, entry));
+            }
+        }
+    }
+    return found.sort();
+}
+/**
+ * Validate all example files in a service directory. Discovers `examples.yaml` /
+ * `examples/*.yaml` and the adjacent `service.yaml` (for the `since ∈ service.yaml` check),
+ * then runs {@link validateExampleFiles}. Paths in diagnostics are relative to `dir`.
+ */
+export async function validateExamplesDir(dir) {
+    const filePaths = await discoverExampleFiles(dir);
+    const files = [];
+    for (const path of filePaths) {
+        const content = await readFile(path, "utf-8");
+        files.push(loadExampleFile(relative(dir, path), content));
+    }
+    const diagnostics = [];
+    let serviceVersions;
+    const serviceYamlPath = join(dir, "service.yaml");
+    if (await exists(serviceYamlPath)) {
+        const parsed = parseServiceVersions(await readFile(serviceYamlPath, "utf-8"));
+        if (parsed.versions.length > 0) {
+            serviceVersions = parsed.versions;
+        }
+        else {
+            diagnostics.push({
+                code: "invalid-service-yaml",
+                message: "service.yaml has no readable 'versions' list; skipping the 'since' version-membership check.",
+                severity: "warning",
+                file: relative(dir, serviceYamlPath),
+            });
+        }
+    }
+    else if (files.length > 0) {
+        diagnostics.push({
+            code: "missing-service-yaml",
+            message: "No service.yaml found next to the examples; skipping the 'since' version-membership check.",
+            severity: "warning",
+            file: relative(dir, serviceYamlPath),
+        });
+    }
+    diagnostics.push(...validateExampleFiles(files, { serviceVersions }));
+    return { diagnostics, files: filePaths.map((path) => relative(dir, path)) };
+}
+//# sourceMappingURL=discover.js.map

package/dist/src/discover.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"discover.js","sourceRoot":"","sources":["../../src/discover.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAA0B,MAAM,aAAa,CAAC;AAE5F,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAUrD,KAAK,UAAU,MAAM,CAAC,IAAY;IAChC,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,GAAW;IACpD,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;IAC5C,IAAI,MAAM,MAAM,CAAC,QAAQ,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAEjD,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IAC1C,IAAI,CAAC,MAAM,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;QAC3E,KAAK,MAAM,KAAK,IAAI,MAAM,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/C,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBACtD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,GAAW;IACnD,MAAM,SAAS,GAAG,MAAM,oBAAoB,CAAC,GAAG,CAAC,CAAC;IAClD,MAAM,KAAK,GAAwB,EAAE,CAAC;IACtC,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC9C,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,WAAW,GAAwB,EAAE,CAAC;IAC5C,IAAI,eAAqC,CAAC;IAC1C,MAAM,eAAe,GAAG,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;QAClC,MAAM,MAAM,GAAG,oBAAoB,CAAC,MAAM,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;QAC9E,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,eAAe,GAAG,MAAM,CAAC,QAAQ,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,IAAI,CAAC;gBACf,IAAI,EAAE,sBAAsB;gBAC5B,OAAO,EACL,8FAA8F;gBAChG,QAAQ,EAAE,SAAS;gBACnB,IAAI,EAAE,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAC;aACrC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;SAAM,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,WAAW,CAAC,IAAI,CAAC;YACf,IAAI,EAAE,sBAAsB;YAC5B,OAAO,EACL,4FAA4F;YAC9F,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAC;SACrC,CAAC,CAAC;IACL,CAAC;IAED,WAAW,CAAC,IAAI,CAAC,GAAG,oBAAoB,CAAC,KAAK,EAAE,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC;IAEtE,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;AAC9E,CAAC"}

package/dist/src/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * `@azure-tools/typespec-azure-examples` — tooling for the Azure unified examples format
+ * (`examples.yaml`). This entrypoint exposes the JSON Schema and the programmatic validation API
+ * used by the `tsp-examples validate` command.
+ */
+export { discoverExampleFiles, validateExamplesDir, type ValidateDirResult } from "./discover.js";
+export { isQuotedScalar, loadExampleFile, locationAt, parseServiceVersions, positionAt, type LoadedExampleFile, type Position, } from "./loader.js";
+export { defaultLegacyExampleFilename, slugify, stripJsonExtension } from "./naming.js";
+export { formatDiagnostics, formatSummary } from "./reporter.js";
+export { checkFilePlacement, checkSemantics, type SemanticContext } from "./rules.js";
+export { ExamplesYamlSchema } from "./schema.js";
+export type { DiagnosticSeverity, ExampleDiagnostic, ExampleRequest, ExampleResponse, ExampleVariant, ServiceVersions, } from "./types.js";
+export { checkStructure, validateExampleFiles } from "./validate.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,KAAK,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClG,OAAO,EACL,cAAc,EACd,eAAe,EACf,UAAU,EACV,oBAAoB,EACpB,UAAU,EACV,KAAK,iBAAiB,EACtB,KAAK,QAAQ,GACd,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,4BAA4B,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACxF,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,YAAY,EACV,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,eAAe,GAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,13 @@
+/**
+ * `@azure-tools/typespec-azure-examples` — tooling for the Azure unified examples format
+ * (`examples.yaml`). This entrypoint exposes the JSON Schema and the programmatic validation API
+ * used by the `tsp-examples validate` command.
+ */
+export { discoverExampleFiles, validateExamplesDir } from "./discover.js";
+export { isQuotedScalar, loadExampleFile, locationAt, parseServiceVersions, positionAt, } from "./loader.js";
+export { defaultLegacyExampleFilename, slugify, stripJsonExtension } from "./naming.js";
+export { formatDiagnostics, formatSummary } from "./reporter.js";
+export { checkFilePlacement, checkSemantics } from "./rules.js";
+export { ExamplesYamlSchema } from "./schema.js";
+export { checkStructure, validateExampleFiles } from "./validate.js";
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAA0B,MAAM,eAAe,CAAC;AAClG,OAAO,EACL,cAAc,EACd,eAAe,EACf,UAAU,EACV,oBAAoB,EACpB,UAAU,GAGX,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,4BAA4B,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACxF,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAwB,MAAM,YAAY,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AASjD,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC"}

package/dist/src/loader.d.ts

@@ -0,0 +1,41 @@
+import { type Document, LineCounter } from "yaml";
+import type { ServiceVersions } from "./types.js";
+/** A parsed `examples.yaml` (or `examples/<Interface>.yaml`) file with location metadata. */
+export interface LoadedExampleFile {
+    /** Absolute or repo-relative path, used verbatim in diagnostics. */
+    readonly path: string;
+    /** Raw file content. */
+    readonly content: string;
+    /** The parsed YAML document (retains node ranges for precise locations). */
+    readonly document: Document.Parsed;
+    /** Plain-JS view of the document (`undefined` if the YAML could not be materialized). */
+    readonly data: any;
+    /** Line counter for translating byte offsets to line/column. */
+    readonly lineCounter: LineCounter;
+    /** Fatal YAML parse error, if any. */
+    readonly parseError?: string;
+}
+/** Parse a single examples file into a {@link LoadedExampleFile}. Never throws. */
+export declare function loadExampleFile(path: string, content: string): LoadedExampleFile;
+/** 1-based line/column position. */
+export interface Position {
+    readonly line: number;
+    readonly col: number;
+}
+/** Translate a byte offset into a 1-based line/column position. */
+export declare function positionAt(file: LoadedExampleFile, offset: number | undefined): Position | undefined;
+/** Get the YAML node at a JSON path, or `undefined` if it doesn't exist. */
+export declare function nodeAt(file: LoadedExampleFile, path: (string | number)[]): unknown;
+/** Position of the node at a JSON path (start of its value). */
+export declare function locationAt(file: LoadedExampleFile, path: (string | number)[]): Position | undefined;
+/**
+ * Whether the scalar at the given path was written as a quoted string in the source.
+ * Returns `false` for plain (unquoted) scalars, which YAML may coerce away from a string.
+ */
+export declare function isQuotedScalar(file: LoadedExampleFile, path: (string | number)[]): boolean;
+/**
+ * Parse the version list from a `service.yaml` document. Tolerates a missing/empty
+ * `versions` list and non-string entries.
+ */
+export declare function parseServiceVersions(content: string): ServiceVersions;
+//# sourceMappingURL=loader.d.ts.map

package/dist/src/loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../../src/loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAY,WAAW,EAAgC,MAAM,MAAM,CAAC;AAC1F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElD,6FAA6F;AAC7F,MAAM,WAAW,iBAAiB;IAChC,oEAAoE;IACpE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,wBAAwB;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,4EAA4E;IAC5E,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC;IACnC,yFAAyF;IACzF,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC;IACnB,gEAAgE;IAChE,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,sCAAsC;IACtC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,mFAAmF;AACnF,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,iBAAiB,CAoBhF;AAED,oCAAoC;AACpC,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED,mEAAmE;AACnE,wBAAgB,UAAU,CACxB,IAAI,EAAE,iBAAiB,EACvB,MAAM,EAAE,MAAM,GAAG,SAAS,GACzB,QAAQ,GAAG,SAAS,CAItB;AAED,4EAA4E;AAC5E,wBAAgB,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,OAAO,CAElF;AAED,gEAAgE;AAChE,wBAAgB,UAAU,CACxB,IAAI,EAAE,iBAAiB,EACvB,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GACxB,QAAQ,GAAG,SAAS,CAItB;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,OAAO,CAI1F;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,eAAe,CAYrE"}

package/dist/src/loader.js

@@ -0,0 +1,70 @@
+import { isScalar, LineCounter, parse, parseDocument, Scalar } from "yaml";
+/** Parse a single examples file into a {@link LoadedExampleFile}. Never throws. */
+export function loadExampleFile(path, content) {
+    const lineCounter = new LineCounter();
+    const document = parseDocument(content, { lineCounter });
+    const fatal = document.errors[0];
+    let data;
+    if (!fatal) {
+        try {
+            data = document.toJS();
+        }
+        catch {
+            data = undefined;
+        }
+    }
+    return {
+        path,
+        content,
+        document,
+        data,
+        lineCounter,
+        parseError: fatal?.message,
+    };
+}
+/** Translate a byte offset into a 1-based line/column position. */
+export function positionAt(file, offset) {
+    if (offset === undefined)
+        return undefined;
+    const pos = file.lineCounter.linePos(offset);
+    return { line: pos.line, col: pos.col };
+}
+/** Get the YAML node at a JSON path, or `undefined` if it doesn't exist. */
+export function nodeAt(file, path) {
+    return file.document.getIn(path, true);
+}
+/** Position of the node at a JSON path (start of its value). */
+export function locationAt(file, path) {
+    const node = nodeAt(file, path);
+    const range = node?.range;
+    return positionAt(file, range?.[0]);
+}
+/**
+ * Whether the scalar at the given path was written as a quoted string in the source.
+ * Returns `false` for plain (unquoted) scalars, which YAML may coerce away from a string.
+ */
+export function isQuotedScalar(file, path) {
+    const node = nodeAt(file, path);
+    if (!isScalar(node))
+        return false;
+    return node.type === Scalar.QUOTE_SINGLE || node.type === Scalar.QUOTE_DOUBLE;
+}
+/**
+ * Parse the version list from a `service.yaml` document. Tolerates a missing/empty
+ * `versions` list and non-string entries.
+ */
+export function parseServiceVersions(content) {
+    let doc;
+    try {
+        doc = parse(content);
+    }
+    catch {
+        return { versions: [] };
+    }
+    const raw = Array.isArray(doc?.versions) ? doc.versions : [];
+    const versions = raw
+        .map((entry) => entry?.version)
+        .filter((version) => typeof version === "string");
+    return { versions };
+}
+//# sourceMappingURL=loader.js.map

package/dist/src/loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.js","sourceRoot":"","sources":["../../src/loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,QAAQ,EAAE,WAAW,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAmB1F,mFAAmF;AACnF,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,OAAe;IAC3D,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;IACtC,MAAM,QAAQ,GAAG,aAAa,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IACzD,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACjC,IAAI,IAAS,CAAC;IACd,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,IAAI,CAAC;YACH,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QACzB,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,GAAG,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO;QACL,IAAI;QACJ,OAAO;QACP,QAAQ;QACR,IAAI;QACJ,WAAW;QACX,UAAU,EAAE,KAAK,EAAE,OAAO;KAC3B,CAAC;AACJ,CAAC;AAQD,mEAAmE;AACnE,MAAM,UAAU,UAAU,CACxB,IAAuB,EACvB,MAA0B;IAE1B,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7C,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC;AAC1C,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,MAAM,CAAC,IAAuB,EAAE,IAAyB;IACvE,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACzC,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,UAAU,CACxB,IAAuB,EACvB,IAAyB;IAEzB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAChC,MAAM,KAAK,GAAI,IAAyD,EAAE,KAAK,CAAC;IAChF,OAAO,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AACtC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,IAAuB,EAAE,IAAyB;IAC/E,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAChC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAClC,OAAO,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,YAAY,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,YAAY,CAAC;AAChF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAe;IAClD,IAAI,GAAQ,CAAC;IACb,IAAI,CAAC;QACH,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAC1B,CAAC;IACD,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7D,MAAM,QAAQ,GAAG,GAAG;SACjB,GAAG,CAAC,CAAC,KAAU,EAAE,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;SACnC,MAAM,CAAC,CAAC,OAAgB,EAAqB,EAAE,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC;IAChF,OAAO,EAAE,QAAQ,EAAE,CAAC;AACtB,CAAC"}

package/dist/src/naming.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Shared naming convention for legacy `x-ms-examples` files, used both by `tsp-examples-migrate`
+ * (to decide when the original name/key can be reconstructed and therefore omitted from
+ * `examples.yaml`) and by the `typespec-autorest` emitter (to materialize the legacy files). Keeping
+ * this in one place guarantees the two sides agree, so the round-trip stays lossless.
+ */
+/** Turn an arbitrary title into a file-name-safe slug (`With WebHook` -> `With_WebHook`). */
+export declare function slugify(value: string): string;
+/** Strip a trailing `.json` extension (case-insensitive). */
+export declare function stripJsonExtension(fileName: string): string;
+/**
+ * The conventional legacy example file name for an operation. The dominant Azure convention names
+ * example files after the `operationId` (`Widgets_Get.json`); when an operation carries multiple
+ * distinct examples the title is appended (`Widgets_Get_WithFilter.json`).
+ */
+export declare function defaultLegacyExampleFilename(operationId: string, title?: string): string;
+//# sourceMappingURL=naming.d.ts.map

package/dist/src/naming.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"naming.d.ts","sourceRoot":"","sources":["../../src/naming.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,6FAA6F;AAC7F,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAK7C;AAED,6DAA6D;AAC7D,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAE3D;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAExF"}

package/dist/src/naming.js

@@ -0,0 +1,26 @@
+/**
+ * Shared naming convention for legacy `x-ms-examples` files, used both by `tsp-examples-migrate`
+ * (to decide when the original name/key can be reconstructed and therefore omitted from
+ * `examples.yaml`) and by the `typespec-autorest` emitter (to materialize the legacy files). Keeping
+ * this in one place guarantees the two sides agree, so the round-trip stays lossless.
+ */
+/** Turn an arbitrary title into a file-name-safe slug (`With WebHook` -> `With_WebHook`). */
+export function slugify(value) {
+    return value
+        .replace(/[^A-Za-z0-9]+/g, "_")
+        .replace(/^_|_$/g, "")
+        .slice(0, 120);
+}
+/** Strip a trailing `.json` extension (case-insensitive). */
+export function stripJsonExtension(fileName) {
+    return fileName.replace(/\.json$/i, "");
+}
+/**
+ * The conventional legacy example file name for an operation. The dominant Azure convention names
+ * example files after the `operationId` (`Widgets_Get.json`); when an operation carries multiple
+ * distinct examples the title is appended (`Widgets_Get_WithFilter.json`).
+ */
+export function defaultLegacyExampleFilename(operationId, title) {
+    return title ? `${operationId}_${slugify(title)}.json` : `${operationId}.json`;
+}
+//# sourceMappingURL=naming.js.map

package/dist/src/naming.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"naming.js","sourceRoot":"","sources":["../../src/naming.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,6FAA6F;AAC7F,MAAM,UAAU,OAAO,CAAC,KAAa;IACnC,OAAO,KAAK;SACT,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC;SAC9B,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;SACrB,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AACnB,CAAC;AAED,6DAA6D;AAC7D,MAAM,UAAU,kBAAkB,CAAC,QAAgB;IACjD,OAAO,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;AAC1C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAAC,WAAmB,EAAE,KAAc;IAC9E,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG,WAAW,IAAI,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,WAAW,OAAO,CAAC;AACjF,CAAC"}

package/dist/src/reporter.d.ts

@@ -0,0 +1,6 @@
+import type { ExampleDiagnostic } from "./types.js";
+/** Format a set of diagnostics for terminal output, grouped by file. */
+export declare function formatDiagnostics(diagnostics: readonly ExampleDiagnostic[], baseDir?: string): string;
+/** Format a one-line summary of the diagnostics. */
+export declare function formatSummary(diagnostics: readonly ExampleDiagnostic[]): string;
+//# sourceMappingURL=reporter.d.ts.map