@contractkit/prettier-plugin 0.8.1 → 0.9.1

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

@@ -1,35 +1,19 @@
-
-
-> @contractkit/prettier-plugin@0.8.0 build:ci /Users/robert/projects/contractkit/apps/prettier-plugin
-> 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/prettier-plugin@0.8.0 build /Users/robert/projects/contractkit/apps/prettier-plugin
-> 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     17.83 KB
-ESM dist/index.js.map 42.37 KB
-ESM ⚡️ Build success in 43ms
-DTS Build start
-DTS ⚡️ Build success in 612ms
-DTS dist/index.d.ts 157.00 B
+
+> @contractkit/prettier-plugin@0.9.1 build:ci /home/runner/work/ContractKit/ContractKit/apps/prettier-plugin
+> eslint --max-warnings=0 && pnpm run build
+
+
+> @contractkit/prettier-plugin@0.9.1 build /home/runner/work/ContractKit/ContractKit/apps/prettier-plugin
+> 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     18.13 KB
+ESM dist/index.js.map 43.70 KB
+ESM ⚡️ Build success in 123ms
+DTS Build start
+DTS ⚡️ Build success in 3581ms
+DTS dist/index.d.ts 157.00 B

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

@@ -1,105 +1,26 @@
-
-
-> @contractkit/prettier-plugin@0.8.0 test:ci /Users/robert/projects/contractkit/apps/prettier-plugin
-> vitest run --coverage
-
-[?25l
- RUN  v4.1.5 /Users/robert/projects/contractkit/apps/prettier-plugin
-      Coverage enabled with v8
-
-[?2026h
- ❯ tests/print-ck.test.ts [queued]
-
- Test Files 0 passed (1)
-      Tests 0 passed (0)
-   Start at 08:51:09
-   Duration 304ms
-[?2026l[?2026h
- ❯ tests/print-ck.test.ts [queued]
-
- Test Files 0 passed (1)
-      Tests 0 passed (0)
-   Start at 08:51:09
-   Duration 916ms
-[?2026l[?2026h
- ❯ tests/print-ck.test.ts 1/45
-
- Test Files 0 passed (1)
-      Tests 1 passed (45)
-   Start at 08:51:09
-   Duration 1.12s
-[?2026l ✓ tests/print-ck.test.ts (45 tests) 99ms
-   ✓ printCk — route modifiers (5)
-     ✓ prints route with no modifiers 12ms
-     ✓ prints route with internal modifier 0ms
-     ✓ prints route with deprecated modifier 0ms
-     ✓ treats empty modifiers array same as no modifier 0ms
-     ✓ preserves description alongside modifier 0ms
-   ✓ printCk — operation modifiers (6)
-     ✓ prints operation with no modifiers 0ms
-     ✓ prints operation with internal modifier 0ms
-     ✓ prints operation with deprecated modifier 0ms
-     ✓ treats empty operation modifiers array as no modifiers 0ms
-     ✓ prints multiple operations with mixed modifiers 0ms
-     ✓ preserves description alongside modifier on operation 0ms
-   ✓ printCk — route and operation modifiers combined (2)
-     ✓ prints both route and operation modifiers independently 0ms
-     ✓ modifier placement: operation(modifier) before path, verb(modifier) before colon 0ms
-   ✓ printCk — security (8)
-     ✓ prints operation-level security: none 0ms
-     ✓ prints security block with roles only 0ms
-     ✓ prints security block with multiple roles space-separated 0ms
-     ✓ prints operation-level signature as its own keyword 0ms
-     ✓ prints unquoted identifier signature without quotes 0ms
-     ✓ prints route-level security with shallower indentation 0ms
-     ✓ prints route-level security: none 0ms
-     ✓ emits no security line when security is undefined 0ms
-   ✓ printCk — query and headers descriptions (2)
-     ✓ emits inline comment on query params that have descriptions 0ms
-     ✓ emits inline comment on headers params that have descriptions 0ms
-   ✓ printCk — query and headers optional, nullable, default (7)
-     ✓ emits ? for optional query params 0ms
-     ✓ emits | null for nullable query params 0ms
-     ✓ emits = value for numeric defaults 0ms
-     ✓ emits = value for boolean defaults 0ms
-     ✓ emits = "value" for string defaults that need quoting 0ms
-     ✓ combines optional, default, and description on the same param 0ms
-     ✓ applies the same rules to headers params 0ms
-   ✓ printCk — request blocks (3)
-     ✓ prints a single content-type request 0ms
-     ✓ round-trips vendor JSON mime types like application/vnd.api+json 0ms
-     ✓ prints multiple content-types preserving source order 0ms
-   ✓ printCk — response headers (2)
-     ✓ prints response headers alongside body 0ms
-     ✓ prints response headers without a body 0ms
-   ✓ printCk — options-level header globals (round-trip) (4)
-     ✓ round-trips options.request.headers 40ms
-     ✓ round-trips options.response.headers 23ms
-     ✓ round-trips operation-level headers: none 9ms
-     ✓ round-trips per-status headers: none 1ms
-   ✓ printCk — multi-base inheritance and override (round-trip) (3)
-     ✓ round-trips multi-base inheritance 1ms
-     ✓ round-trips override modifier on a field 1ms
-     ✓ emits canonical modifier order: override → deprecated → readonly 0ms
-   ✓ printCk — typed path params (round-trip) (3)
-     ✓ round-trips path params with constraint arguments 4ms
-     ✓ round-trips path params with enum types 1ms
-     ✓ round-trips path params with regex constraints and a comment 1ms
-
- Test Files  1 passed (1)
-      Tests  45 passed (45)
-   Start at  08:51:09
-   Duration  1.20s (transform 258ms, setup 0ms, import 648ms, tests 99ms, environment 0ms)
-
- % Coverage report from v8
---------------------|---------|----------|---------|---------|-----------------------------------------------------------
-File                | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s                                         
---------------------|---------|----------|---------|---------|-----------------------------------------------------------
-All files           |   61.01 |    53.55 |      68 |   67.95 |                                                           
- indent.ts          |     100 |      100 |     100 |     100 |                                                           
- print-ck.ts        |   67.14 |    64.19 |     100 |   78.84 | 23-28,32-37,49                                            
- print-contract.ts  |   41.93 |    28.57 |      50 |   42.85 | 10,37-68                                                  
- print-operation.ts |   69.64 |    63.19 |      90 |   79.69 | 27-38,47-48,85,102,168,185,193-204,236                    
- print-type.ts      |   45.23 |    42.55 |      40 |   47.14 | 12-13,22-30,34-40,44-66,88-93,101-102,108-109,132,135-138 
---------------------|---------|----------|---------|---------|-----------------------------------------------------------
-[?25h
+
+> @contractkit/prettier-plugin@0.9.1 test:ci /home/runner/work/ContractKit/ContractKit/apps/prettier-plugin
+> vitest run --coverage
+
+
+ RUN  v4.1.5 /home/runner/work/ContractKit/ContractKit/apps/prettier-plugin
+      Coverage enabled with v8
+
+ ✓ tests/print-ck.test.ts (55 tests) 215ms
+
+ Test Files  1 passed (1)
+      Tests  55 passed (55)
+   Start at  18:49:08
+   Duration  5.56s (transform 1.50s, setup 0ms, import 4.05s, tests 215ms, environment 0ms)
+
+ % Coverage report from v8
+-------------------|---------|----------|---------|---------|-------------------
+File               | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
+-------------------|---------|----------|---------|---------|-------------------
+All files          |   66.02 |    56.81 |   69.23 |   71.87 |                   
+ indent.ts         |     100 |      100 |     100 |     100 |                   
+ print-ck.ts       |   89.85 |       80 |     100 |   98.03 | 59                
+ print-contract.ts |   41.93 |    28.57 |      50 |   42.85 | 10,37-68          
+ ...t-operation.ts |   70.62 |    63.74 |      90 |   80.43 | ...92,200-211,243 
+ print-type.ts     |   45.23 |    42.55 |      40 |   47.14 | ...09,132,135-138 
+-------------------|---------|----------|---------|---------|-------------------

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @contractkit/prettier-plugin-contractkit
 
+## 0.9.1
+
+### Patch Changes
+
+- 7555412: Round-trip path-like values in `options.keys` and `options.services` correctly.
+
+    Values that aren't plain identifiers (paths with slashes, values starting with `.` or `#`, values containing spaces, etc.) are now consistently double-quoted on output. Previously only values starting with `#` or containing spaces were quoted, so a value like `"../../bruno"` lost its quotes on round-trip and re-parsed as a different shape.
+
+- Updated dependencies [7555412]
+    - @contractkit/core@0.13.0
+
+## 0.9.0
+
+### Minor Changes
+
+- 876696f: Add a `plugins` block to operations for attaching external files to individual code-generators.
+
+    ```
+    post: {
+        plugins: {
+            bruno: "request-token.yml"
+        }
+    }
+    ```
+
+    Each entry maps a plugin name to a path relative to the contract's `.ck` file. The CLI resolves the path before plugins run and exposes the file content on the AST as `op.pluginFiles[name]`; missing files emit a warning. Plugins keyed by their own `name` can read their entry to override or augment generated output. The raw paths remain on `op.plugins` for round-trip use cases (the prettier plugin and VS Code syntax highlighting consume the raw form).
+
+### Patch Changes
+
+- Updated dependencies [876696f]
+    - @contractkit/core@0.12.0
+
 ## 0.8.1
 
 ### Patch Changes

package/README.md

@@ -0,0 +1,58 @@
+# @contractkit/prettier-plugin
+
+A [Prettier](https://prettier.io) plugin that formats ContractKit `.ck` files. Idempotent: re-formatting an already-formatted file is a no-op.
+
+## Installation
+
+```bash
+pnpm add -D prettier @contractkit/prettier-plugin
+```
+
+## Configuration
+
+Add the plugin to your prettier config:
+
+```json
+{
+    "plugins": ["@contractkit/prettier-plugin"]
+}
+```
+
+Prettier registers `.ck` as the `ContractDSL` language and applies the plugin automatically.
+
+## Usage
+
+```bash
+# Format all .ck files in your project
+pnpm prettier --write "**/*.ck"
+
+# Or via the editor integration of your choice
+```
+
+Most editors with a Prettier integration (VS Code, JetBrains, Neovim) pick the plugin up from your project's `package.json` automatically.
+
+## What it does
+
+The printer round-trips the parser's AST back into canonical `.ck` source:
+
+- 4-space indentation (matches Prettier's default `tabWidth`)
+- Canonical modifier order on fields: `override → deprecated → readonly|writeonly`
+- Stable ordering of `options` block items, route bodies, and operation blocks
+- Inline `# comment` placement preserved on field/operation/status lines
+- Multi-base inheritance: `contract C: A & B & { ... }` with the inline block always last
+- Multi-line unions: a leading `|` is preserved on type aliases like `contract X: A | B | C`
+- Discriminated unions render as `discriminated(by=field, A | B | C)`
+- Options-level header globals (`options { request/response: { headers } }`) are emitted in their original un-merged form so the AST round-trips cleanly
+
+The plugin honours Prettier's `printWidth` for line-wrapping decisions where applicable, but most CK constructs format to a fixed multi-line shape regardless of width.
+
+## Source layout
+
+| Path | Purpose |
+| --- | --- |
+| `src/index.ts` | Prettier plugin entry — parser + printer registration |
+| `src/print-ck.ts` | Top-level dispatcher; renders the `options { ... }` block |
+| `src/print-contract.ts` | Renders `contract` declarations and field blocks |
+| `src/print-operation.ts` | Renders `operation` declarations, params, query, headers, request/response |
+| `src/print-type.ts` | Shared type-expression printer used everywhere a type appears |
+| `src/indent.ts` | Indentation constants and helpers |