@contractkit/prettier-plugin 0.9.0 → 0.9.2

package/src/print-ck.ts

@@ -8,6 +8,18 @@ export const DEFAULT_PRINT_WIDTH = 80;
 
 // ─── Options block ──────────────────────────────────────────────────────────
 
+/**
+ * Quote an options-block value if it isn't a plain identifier.
+ *
+ * Plain identifiers (starts with letter/underscore/dollar, rest are
+ * alphanumeric/underscore/dollar/hyphen/dot) are left bare. Everything
+ * else — paths with slashes, values starting with `#`, values with spaces,
+ * etc. — is double-quoted so the round-trip parse is unambiguous.
+ */
+function quoteOptionsValue(value: string): string {
+    return /^[a-zA-Z_$][a-zA-Z0-9_$\-.]*$/.test(value) ? value : `"${value}"`;
+}
+
 function printOptionsBlock(ast: CkRootNode): string | null {
     const hasMeta = Object.keys(ast.meta).length > 0;
     const hasServices = Object.keys(ast.services).length > 0;
@@ -22,8 +34,7 @@ function printOptionsBlock(ast: CkRootNode): string | null {
     if (hasMeta) {
         lines.push(`${INDENT}keys: {`);
         for (const [key, value] of Object.entries(ast.meta)) {
-            const v = value.startsWith('#') || value.includes(' ') ? `"${value}"` : value;
-            lines.push(`${INDENT}${INDENT}${key}: ${v}`);
+            lines.push(`${INDENT}${INDENT}${key}: ${quoteOptionsValue(value)}`);
         }
         lines.push(`${INDENT}}`);
     }
@@ -31,8 +42,7 @@ function printOptionsBlock(ast: CkRootNode): string | null {
     if (hasServices) {
         lines.push(`${INDENT}services: {`);
         for (const [key, value] of Object.entries(ast.services)) {
-            const v = value.startsWith('#') || value.includes(' ') ? `"${value}"` : value;
-            lines.push(`${INDENT}${INDENT}${key}: ${v}`);
+            lines.push(`${INDENT}${INDENT}${key}: ${quoteOptionsValue(value)}`);
         }
         lines.push(`${INDENT}}`);
     }
@@ -69,6 +79,14 @@ function printOptionsHeaderScope(keyword: 'request' | 'response', headers: OpRes
 
 // ─── CK file printer ───────────────────────────────────────────────────────
 
+/**
+ * Render a parsed `.ck` AST back to source. Output is byte-identical on
+ * round-trip when the input is already canonically formatted: options block
+ * first, then contracts, then operations, separated by blank lines.
+ *
+ * `printWidth` is forwarded to per-model printing for line wrapping inside
+ * inline-object types.
+ */
 export function printCk(ast: CkRootNode, printWidth: number = DEFAULT_PRINT_WIDTH): string {
     const parts: string[] = [];
 

package/src/print-type.ts

@@ -3,6 +3,7 @@ import { INDENT } from './indent.js';
 
 // ─── Type expression printer ────────────────────────────────────────────────
 
+/** Render a `ContractTypeNode` back to its `.ck` source string. */
 export function printType(type: ContractTypeNode): string {
     switch (type.kind) {
         case 'scalar': {
@@ -29,7 +30,7 @@ export function printType(type: ContractTypeNode): string {
         case 'record':
             return `record(${printType(type.key)}, ${printType(type.value)})`;
         case 'enum':
-            return `enum(${type.values.join(', ')})`;
+            return `enum(${type.values.map(formatEnumValue).join(', ')})`;
         case 'literal':
             return typeof type.value === 'string' ? `literal("${type.value}")` : `literal(${type.value})`;
         case 'union':
@@ -63,7 +64,7 @@ function printInlineObjectCompact(obj: InlineObjectTypeNode): string {
 /** Multi-line enum form — one value per line, used when single-line would exceed print width. */
 export function printEnumExpanded(values: string[], indent: string): string {
     const innerIndent = indent + INDENT;
-    return `enum(\n${values.map(v => `${innerIndent}${v}`).join(',\n')}\n${indent})`;
+    return `enum(\n${values.map(v => `${innerIndent}${formatEnumValue(v)}`).join(',\n')}\n${indent})`;
 }
 
 // ─── Field printer ──────────────────────────────────────────────────────────
@@ -111,6 +112,12 @@ export function printInlineObjectExpanded(obj: InlineObjectTypeNode, indent: str
 
 // ─── Helpers ────────────────────────────────────────────────────────────────
 
+/** Format a single enum value: bare identifier stays bare; anything else gets double-quoted. */
+export function formatEnumValue(v: string): string {
+    if (/^[a-zA-Z_$][a-zA-Z0-9_$\-.]*$/.test(v)) return v;
+    return `"${v}"`;
+}
+
 /** Format a default value: quote strings that aren't valid bare identifiers. */
 export function formatDefault(val: string | number | boolean): string {
     if (typeof val === 'number' || typeof val === 'boolean') return String(val);

package/tests/print-ck.test.ts

@@ -649,3 +649,94 @@ operation /users/{slug}: {
         expect(roundTrip(source)).toBe(source);
     });
 });
+
+describe('printCk — options keys and services quoting', () => {
+    function roundTrip(source: string): string {
+        const diag = new DiagnosticCollector();
+        const ast = parseCk(source, 'test.ck', diag);
+        expect(diag.hasErrors()).toBe(false);
+        return printCk(ast);
+    }
+
+    it('leaves simple identifier keys values unquoted', () => {
+        const source = `\
+options {
+    keys: {
+        area: payments
+    }
+}
+`;
+        expect(roundTrip(source)).toBe(source);
+    });
+
+    it('preserves quotes on path-like values containing slashes', () => {
+        const source = `\
+options {
+    keys: {
+        bruno: "../../bruno/"
+    }
+}
+`;
+        expect(roundTrip(source)).toBe(source);
+    });
+
+    it('quotes values that start with a dot', () => {
+        const source = `\
+options {
+    keys: {
+        path: "../relative"
+    }
+}
+`;
+        expect(roundTrip(source)).toBe(source);
+    });
+
+    it('preserves quotes on service paths starting with #', () => {
+        const source = `\
+options {
+    services: {
+        AuthService: "#src/modules/auth/auth.service.js"
+    }
+}
+`;
+        expect(roundTrip(source)).toBe(source);
+    });
+
+    it('leaves plain identifier service names unquoted', () => {
+        const source = `\
+options {
+    services: {
+        AuthService: authService
+    }
+}
+`;
+        expect(roundTrip(source)).toBe(source);
+    });
+});
+
+describe('printCk — enum values with spaces (round-trip)', () => {
+    function roundTrip(source: string): string {
+        const diag = new DiagnosticCollector();
+        const ast = parseCk(source, 'test.ck', diag);
+        expect(diag.hasErrors()).toBe(false);
+        return printCk(ast);
+    }
+
+    it('round-trips enum with bare identifiers unchanged', () => {
+        const source = `\
+contract M: {
+    status: enum(active, inactive, pending)
+}
+`;
+        expect(roundTrip(source)).toBe(source);
+    });
+
+    it('round-trips enum with quoted multi-word values', () => {
+        const source = `\
+contract M: {
+    entityType: enum("Sole Proprietorship", LLC, "Limited Partnership")
+}
+`;
+        expect(roundTrip(source)).toBe(source);
+    });
+});