@contractkit/plugin-bruno 0.9.1 → 1.0.0

package/.turbo/turbo-build$colon$ci.log

@@ -1,35 +1,19 @@
-
-
-> @contractkit/plugin-bruno@0.9.0 build:ci /Users/robert/projects/contractkit/packages/plugin-bruno
-> eslint --max-warnings=0 && pnpm run build
-
-=============
-
-
-WARNING: You are currently running a version of TypeScript which is not officially supported by @typescript-eslint/typescript-estree.
-
-
-* @typescript-eslint/typescript-estree version: 8.57.2
-* Supported TypeScript versions: >=4.8.4 <6.0.0
-* Your TypeScript version: 6.0.2
-
-
-Please only submit bug reports when using the officially supported version.
-
-
-=============
-
-> @contractkit/plugin-bruno@0.9.0 build /Users/robert/projects/contractkit/packages/plugin-bruno
-> tsup src/index.ts --format esm --sourcemap --dts && tsc --emitDeclarationOnly --declaration
-
-CLI Building entry: src/index.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v8.5.1
-CLI Target: esnext
-ESM Build start
-ESM dist/index.js     19.94 KB
-ESM dist/index.js.map 46.49 KB
-ESM ⚡️ Build success in 41ms
-DTS Build start
-DTS ⚡️ Build success in 622ms
-DTS dist/index.d.ts 1.37 KB
+
+> @contractkit/plugin-bruno@1.0.0 build:ci /home/runner/work/ContractKit/ContractKit/packages/plugin-bruno
+> eslint --max-warnings=0 && pnpm run build
+
+
+> @contractkit/plugin-bruno@1.0.0 build /home/runner/work/ContractKit/ContractKit/packages/plugin-bruno
+> tsup src/index.ts --format esm --sourcemap --dts && tsc --emitDeclarationOnly --declaration
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.1
+CLI Target: esnext
+ESM Build start
+ESM dist/index.js     20.98 KB
+ESM dist/index.js.map 50.34 KB
+ESM ⚡️ Build success in 158ms
+DTS Build start
+DTS ⚡️ Build success in 3705ms
+DTS dist/index.d.ts 2.09 KB

package/.turbo/turbo-test$colon$ci.log

@@ -1,128 +1,25 @@
-
-
-> @contractkit/plugin-bruno@0.9.0 test:ci /Users/robert/projects/contractkit/packages/plugin-bruno
-> vitest run --coverage
-
-[?25l
- RUN  v4.1.5 /Users/robert/projects/contractkit/packages/plugin-bruno
-      Coverage enabled with v8
-
-[?2026h
- ❯ tests/codegen-bruno.test.ts [queued]
-
- Test Files 0 passed (1)
-      Tests 0 passed (0)
-   Start at 08:51:09
-   Duration 407ms
-[?2026l[?2026h
- ❯ tests/codegen-bruno.test.ts [queued]
-
- Test Files 0 passed (1)
-      Tests 0 passed (0)
-   Start at 08:51:09
-   Duration 927ms
-[?2026l ✓ tests/codegen-bruno.test.ts (85 tests) 11ms
-   ✓ generateOpenCollection (80)
-     ✓ generates opencollection.yml with correct spec version and collection name 2ms
-     ✓ generates Local environment file with baseUrl variable 0ms
-     ✓ emits requests for internal operations by default 0ms
-     ✓ skips internal operations when includeInternal is false 0ms
-     ✓ creates one folder per op root file 0ms
-     ✓ folder.yml has info block with name, type: folder, and seq 0ms
-     ✓ generates one .yml file per route+method combination 0ms
-     ✓ request info block has name, type: http, and seq 0ms
-     ✓ seq increments across operations within a folder 0ms
-     ✓ uses slugified name as filename when op.name is set 0ms
-     ✓ falls back to method-path filename when op.name is not set 0ms
-     ✓ uses area meta as the top-level folder name 0ms
-     ✓ falls back to filename when no area meta 0ms
-     ✓ places request files in subfolder when subarea meta is set 0ms
-     ✓ generates folder.yml for subarea with correct name 0ms
-     ✓ still generates top-level folder.yml when subarea is set 0ms
-     ✓ slugifies subarea for the folder path 0ms
-     ✓ places request files directly in folder when no subarea 0ms
-     ✓ uses {{baseUrl}} prefix and Bruno :param syntax for path params 0ms
-     ✓ generates path params as flat array entries with type: path 0ms
-     ✓ uses uuid example value for uuid path params 0ms
-     ✓ uses typed example values for scalar path params 0ms
-     ✓ uses ISO 8601 duration example value for duration path params 0ms
-     ✓ uses first enum value as example for enum path params 0ms
-     ✓ falls back to empty string for untyped path params 0ms
-     ✓ does not generate params block when path has no params and no query 0ms
-     ✓ generates query params as flat array entries with type: query 0ms
-     ✓ uses typed example values for query params 0ms
-     ✓ falls back to single placeholder entry for ref query params with no registry 0ms
-     ✓ expands ref query params into individual fields when model registry provided 0ms
-     ✓ mixes path and query params in the same flat array 0ms
-     ✓ generates headers block from op.headers inline params 0ms
-     ✓ falls back to single placeholder entry for ref header source with no registry 0ms
-     ✓ expands ref header source into individual fields when model registry provided 0ms
-     ✓ does not generate headers block when op has no headers 0ms
-     ✓ generates body with type: json and data block literal for JSON requests 0ms
-     ✓ expands inline object body type into a JSON skeleton 0ms
-     ✓ uses ISO 8601 duration example value in body skeleton 0ms
-     ✓ excludes readonly fields from inline object body skeleton 0ms
-     ✓ uses empty object for ref body types when no contractRoots provided 0ms
-     ✓ expands ref body type into a JSON skeleton when contractRoots provided 0ms
-     ✓ excludes readonly fields from expanded ref body 0ms
-     ✓ sets optional fields to null in expanded ref body 0ms
-     ✓ expands inherited fields from base model in ref body 0ms
-     ✓ uses field default value in body for non-optional fields 0ms
-     ✓ uses field default value in body for optional fields 0ms
-     ✓ uses field defaults from expanded ref model body 1ms
-     ✓ uses first enum value in body 0ms
-     ✓ uses example values for nested array fields in body 0ms
-     ✓ leaves ref fields as empty objects in body 0ms
-     ✓ generates body with type: multipart-form for multipart requests 0ms
-     ✓ does not generate body block when no request body 0ms
-     ✓ handles empty roots array 0ms
-     ✓ derives folder name from file path with directory prefix 0ms
-     ✓ does not generate any .bru files 0ms
-     ✓ adds bearer auth block to opencollection.yml when security config provided 0ms
-     ✓ adds apikey auth block to opencollection.yml 0ms
-     ✓ adds basic auth block to opencollection.yml 0ms
-     ✓ adds auth env vars to local.yml for bearer 0ms
-     ✓ does not add request or auth to opencollection.yml when no security config 0ms
-     ✓ adds auth: none inside http block when operation security is none 0ms
-     ✓ adds auth: inherit inside http block for normal operations when default scheme is set 0ms
-     ✓ does not add auth when no default scheme is set 0ms
-     ✓ emits a status-code assertion using the first declared 2xx response 0ms
-     ✓ falls back to the first response when no 2xx is declared 0ms
-     ✓ does not emit a runtime block when the operation declares no responses 0ms
-     ✓ emits assertions for required response headers and lists them in the docs 0ms
-     ✓ emits a docs block from the operation description 0ms
-     ✓ combines route and operation descriptions into the docs block 0ms
-     ✓ does not emit a docs block when no description is set 0ms
-     ✓ marks optional query params with disabled: true 0ms
-     ✓ marks optional headers with disabled: true 0ms
-     ✓ does not mark path params as disabled even though they have no optional flag 0ms
-     ✓ marks optional fields from a ref-expanded query model as disabled 0ms
-     ✓ emits a manifest listing every generated file 0ms
-     ✓ parseManifest returns [] for malformed input 0ms
-     ✓ emits Bruno faker templates for compatible scalar params when randomExamples is true 0ms
-     ✓ keeps deterministic placeholders when randomExamples is false 0ms
-     ✓ uses faker templates inside JSON body skeletons for string-valued scalars 0ms
-     ✓ does not override field defaults when randomExamples is true 0ms
-   ✓ sanitizePath (5)
-     ✓ converts simple path to filename-safe string 0ms
-     ✓ replaces path params with their names 0ms
-     ✓ handles multiple segments and params 0ms
-     ✓ returns root for bare slash 0ms
-     ✓ collapses consecutive dashes 0ms
-
- Test Files  1 passed (1)
-      Tests  85 passed (85)
-   Start at  08:51:09
-   Duration  1.08s (transform 161ms, setup 0ms, import 586ms, tests 11ms, environment 0ms)
-
- % Coverage report from v8
--------------------|---------|----------|---------|---------|-------------------------------------------------------------------------------------------------
-File               | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s                                                                               
--------------------|---------|----------|---------|---------|-------------------------------------------------------------------------------------------------
-All files          |   83.77 |    74.26 |   84.05 |   85.42 |                                                                                                 
- src               |    86.1 |     75.1 |    90.9 |   87.54 |                                                                                                 
-  codegen-bruno.ts |    86.1 |     75.1 |    90.9 |   87.54 | 239-240,324,332,385-388,395-402,422,428,432-434,450,460,484,494-496,502-504,509,513-521,530,534 
- tests             |   68.18 |    67.74 |      72 |   71.05 |                                                                                                 
-  helpers.ts       |   68.18 |    67.74 |      72 |   71.05 | 43-47,55-59,71,113,131-135,145                                                                  
--------------------|---------|----------|---------|---------|-------------------------------------------------------------------------------------------------
-[?25h
+
+> @contractkit/plugin-bruno@1.0.0 test:ci /home/runner/work/ContractKit/ContractKit/packages/plugin-bruno
+> vitest run --coverage
+
+
+ RUN  v4.1.5 /home/runner/work/ContractKit/ContractKit/packages/plugin-bruno
+      Coverage enabled with v8
+
+ ✓ tests/codegen-bruno.test.ts (96 tests) 489ms
+
+ Test Files  1 passed (1)
+      Tests  96 passed (96)
+   Start at  18:49:07
+   Duration  4.73s (transform 1.31s, setup 0ms, import 3.04s, tests 489ms, environment 0ms)
+
+ % Coverage report from v8
+-------------------|---------|----------|---------|---------|-------------------------------------------------------------------------------------------------
+File               | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s                                                                               
+-------------------|---------|----------|---------|---------|-------------------------------------------------------------------------------------------------
+All files          |   85.26 |    76.65 |   85.91 |   87.05 |                                                                                                 
+ src               |   86.73 |    76.56 |    91.3 |   88.19 |                                                                                                 
+  codegen-bruno.ts |   86.73 |    76.56 |    91.3 |   88.19 | 285-286,370,378,431-434,441-448,468,474,478-480,496,506,530,540-542,548-550,555,559-567,576,580 
+ tests             |      75 |    77.41 |      76 |   78.94 |                                                                                                 
+  helpers.ts       |      75 |    77.41 |      76 |   78.94 | 43-47,55-59,71,113,133,145                                                                      
+-------------------|---------|----------|---------|---------|-------------------------------------------------------------------------------------------------

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @contractkit/contractkit-plugin-bruno
 
+## 1.0.0
+
+### Major Changes
+
+- 7555412: Drop the `overrideDir` config option from the Bruno plugin.
+
+    Per-operation overrides via `plugins: { bruno: "..." }` combined with the new `{{var}}` substitution in `.ck` files cover the same use cases more directly. Define a shared base path once in `options { keys: { bruno: "../bruno-overrides" } }` (or in the plugin's `keys` config in `contractkit.config.json` for a workspace-wide default) and reference per-operation override files with `plugins: { bruno: "{{bruno}}/path/to/file.yml" }`.
+
+    Migration: replace the `overrideDir` entry in your plugin config with a per-operation `plugins.bruno` declaration on each operation that needs an override.
+
+### Patch Changes
+
+- Updated dependencies [7555412]
+    - @contractkit/core@0.13.0
+
+## 0.10.0
+
+### Minor Changes
+
+- 876696f: Omit optional fields from generated request body skeletons instead of emitting them as `null`.
+
+    Previously, an optional field with no default produced `"nickname": null` in the example JSON body. The field is now absent so the example body sends only what the contract actually requires, matching how most APIs treat "omit" vs. "explicit null".
+
+- f2d6a74: Add YAML override support to the Bruno plugin via per-operation plugin files and a new `overrideDir` config option.
+
+    Per-operation overrides: declare `plugins: { bruno: "override.yml" }` on an operation in a `.ck` file and the file's YAML content is deep-merged into the generated request file at codegen time. Objects recurse; arrays replace entirely.
+
+    Directory overrides: set `overrideDir` in the plugin config to a directory that mirrors the generated output structure. Any file found there is deep-merged into the matching generated file, enabling overrides for collection-level files (`opencollection.yml`, `environments/local.yml`) as well as individual request files.
+
+    The `mergePluginFile` function is now exported from `@contractkit/plugin-bruno` for use in custom tooling.
+
+### Patch Changes
+
+- Updated dependencies [876696f]
+    - @contractkit/core@0.12.0
+
 ## 0.9.1
 
 ### Patch Changes

package/README.md

@@ -38,6 +38,7 @@ pnpm add @contractkit/contractkit-plugin-bruno
 | `output` | `string` | `"bruno-collection"` | Output directory name |
 | `collectionName` | `string` | basename of `rootDir` | Collection name shown in Bruno |
 | `randomExamples` | `boolean` | `true` | Use Bruno faker templates (`{{$randomUUID}}`, `{{$randomEmail}}`, etc.) for compatible scalar fields so each send produces fresh data. Set to `false` for stable, deterministic placeholders. |
+| `includeInternal` | `boolean` | `true` | Include operations marked `internal`. Set to `false` to omit them from the collection. |
 | `auth.defaultScheme` | `string` | — | Key from `auth.schemes` to apply by default |
 | `auth.schemes` | `object` | — | Map of scheme name → security scheme definition |
 
@@ -62,6 +63,46 @@ bruno-collection/
 
 The output directory is fully replaced on each run — stale request files from removed operations are automatically cleaned up.
 
+## Per-operation overrides
+
+Add a `plugins` block to any operation in a `.ck` file to deep-merge a YAML file into the generated request:
+
+```
+post: {
+    plugins: {
+        bruno: "overrides/auth-token.yml"
+    }
+    response: { 200: AuthResponse }
+}
+```
+
+The file path is relative to the `.ck` source file. Its content is deep-merged into the generated request YAML — objects recurse, arrays replace entirely:
+
+```yaml
+# overrides/auth-token.yml
+runtime:
+  script:
+    req: |
+      bru.setVar("token", bru.getEnvVar("adminToken"));
+```
+
+Authoring tip: combine per-operation `plugins.bruno` paths with `{{var}}` substitution to factor out a shared override directory:
+
+```
+options {
+    keys: { bruno: "../../bruno-overrides" }
+}
+
+operation /payments/{id}: {
+    get: {
+        plugins: { bruno: "{{bruno}}/payments/get-payment.yml" }
+        response: { 200: { application/json: Payment } }
+    }
+}
+```
+
+The `{{bruno}}` reference can also be supplied workspace-wide via the plugin's `keys` config in `contractkit.config.json`.
+
 ## Programmatic use
 
 ```typescript