@contractkit/prettier-plugin 0.12.0 → 0.12.2

package/src/print-operation.ts

@@ -21,6 +21,7 @@ const I4 = INDENT.repeat(4);
 // ─── Orphan comment helpers ──────────────────────────────────────────────────
 
 type CommentEntry = { line: number; text: string };
+/** A run of consecutive-line orphan comments, keyed by the source line it starts on. */
 export type CommentBlock = { startLine: number; lines: string[] };
 
 /** Group sorted orphan comment entries into consecutive-line blocks. */
@@ -52,6 +53,14 @@ export function flushBlocks(out: string[], blocks: CommentBlock[], idx: { value:
 
 // ─── Route ───────────────────────────────────────────────────────────────────
 
+/**
+ * Render an `operation` route body from its `path: {` onward (the `operation` keyword and
+ * any modifier are prepended by the caller). Emits the params/security blocks and each HTTP
+ * operation, interleaving orphan comment `blocks` at their original source positions — `idx`
+ * tracks how far through `blocks` we've consumed, and `nextRouteStart` bounds the flush to
+ * comments before the following route. Any `route.trailingComments` (comments after the last
+ * operation, before `}`) are emitted before the closing brace so they round-trip.
+ */
 export function printRoute(route: OpRouteNode, blocks: CommentBlock[], idx: { value: number }, nextRouteStart: number): string {
     const lines: string[] = [];
     const commentSuffix = route.description ? ` # ${route.description}` : '';
@@ -74,6 +83,11 @@ export function printRoute(route: OpRouteNode, blocks: CommentBlock[], idx: { va
     // Flush comment blocks between last operation and the next route
     flushBlocks(lines, blocks, idx, nextRouteStart, I1);
 
+    // Trailing/orphan comments after the last operation, before the closing brace.
+    for (const comment of route.trailingComments ?? []) {
+        lines.push(`${I1}# ${comment}`);
+    }
+
     lines.push('}');
     return lines.join('\n');
 }

package/src/print-type.ts

@@ -105,9 +105,15 @@ export function printField(field: FieldNode, indent: string, printWidth: number
     return fullLine;
 }
 
-/** Print inline-object fields expanded (used when an inline brace object trails a type alias). */
+/** Print inline-object fields expanded (used when an inline brace object trails a type alias).
+ * Any `trailingComments` (comments after the last field, before `}`) are emitted as indented
+ * `# text` lines after the fields, matching how model bodies round-trip trailing comments. */
 export function printInlineObjectExpanded(obj: InlineObjectTypeNode, indent: string, printWidth: number = 80): string[] {
-    return obj.fields.map(f => printField(f, indent, printWidth));
+    const lines = obj.fields.map(f => printField(f, indent, printWidth));
+    for (const comment of obj.trailingComments ?? []) {
+        lines.push(`${indent}# ${comment}`);
+    }
+    return lines;
 }
 
 // ─── Helpers ────────────────────────────────────────────────────────────────

package/tests/print-ck.test.ts

@@ -800,3 +800,242 @@ contract M: {
         expect(roundTrip(source)).toBe(source);
     });
 });
+
+describe('printCk — trailing/orphan comments (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('preserves a comment on the last line of a contract body', () => {
+        const source = `\
+contract Payment: {
+    id: uuid
+    # more fields to come
+}
+`;
+        const out = roundTrip(source);
+        expect(out).toContain('# more fields to come');
+        // Comment sits on its own line after the last field, before the closing brace.
+        expect(out).toBe(source);
+        // Idempotent: formatting the output again yields the same result.
+        expect(roundTrip(out)).toBe(out);
+    });
+
+    it('preserves multiple trailing comments in a contract body', () => {
+        const source = `\
+contract Payment: {
+    id: uuid
+    # note one
+    # note two
+}
+`;
+        const out = roundTrip(source);
+        expect(out).toContain('# note one');
+        expect(out).toContain('# note two');
+        expect(out).toBe(source);
+        expect(roundTrip(out)).toBe(out);
+    });
+
+    it('preserves a comment as the only content of a contract body', () => {
+        const source = `\
+contract Empty: {
+    # nothing here yet
+}
+`;
+        const out = roundTrip(source);
+        expect(out).toContain('# nothing here yet');
+        expect(out).toBe(source);
+        expect(roundTrip(out)).toBe(out);
+    });
+
+    it('preserves a comment on the last line of an operation/route body', () => {
+        const source = `\
+operation /users: {
+    get: {
+    }
+    # TODO: add post
+}
+`;
+        const out = roundTrip(source);
+        expect(out).toContain('# TODO: add post');
+        expect(out).toBe(source);
+        expect(roundTrip(out)).toBe(out);
+    });
+
+    it('does not double-emit a header inline comment on a contract with no fields', () => {
+        const source = `\
+contract Empty: { # nothing here yet
+}
+`;
+        const out = roundTrip(source);
+        // The inline header comment must survive exactly once, not be duplicated on a trailing line.
+        expect(out.match(/# nothing here yet/g)?.length).toBe(1);
+        expect(roundTrip(out)).toBe(out);
+    });
+});
+
+describe('printCk — inline object trailing comments (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('preserves a trailing comment as the last inner item of an inline object type', () => {
+        const source = `\
+contract Foo: {
+    bar: {
+        a: string
+        # trailing note
+    }
+}
+`;
+        const out = roundTrip(source);
+        expect(out).toContain('# trailing note');
+        expect(out).toBe(source);
+        expect(roundTrip(out)).toBe(out);
+    });
+
+    it('preserves multiple trailing comments in an inline object type', () => {
+        const source = `\
+contract Foo: {
+    bar: {
+        a: string
+        # note one
+        # note two
+    }
+}
+`;
+        const out = roundTrip(source);
+        expect(out).toContain('# note one');
+        expect(out).toContain('# note two');
+        expect(out).toBe(source);
+        expect(roundTrip(out)).toBe(out);
+    });
+
+    it('preserves a trailing comment as the only inner item of an inline object type', () => {
+        const source = `\
+contract Foo: {
+    bar: {
+        # placeholder
+    }
+}
+`;
+        const out = roundTrip(source);
+        expect(out).toContain('# placeholder');
+        expect(out).toBe(source);
+        expect(roundTrip(out)).toBe(out);
+    });
+
+    it('still attaches an inline comment on an inline field (no regression)', () => {
+        const source = `\
+contract Foo: {
+    bar: {
+        a: string # about a
+        b: int
+    }
+}
+`;
+        const out = roundTrip(source);
+        expect(out).toContain('a: string # about a');
+        expect(out).toBe(source);
+        expect(roundTrip(out)).toBe(out);
+    });
+});
+
+describe('printCk — options block sub-block comments (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('preserves a leading comment on a keys entry', () => {
+        const source = `\
+options {
+    keys: {
+        # the api area
+        area: payments
+        version: v2
+    }
+}
+`;
+        const out = roundTrip(source);
+        expect(out).toContain('# the api area');
+        expect(out).toBe(source);
+        expect(roundTrip(out)).toBe(out);
+    });
+
+    it('preserves a trailing comment at the end of the keys sub-block', () => {
+        const source = `\
+options {
+    keys: {
+        area: payments
+        # more keys to come
+    }
+}
+`;
+        const out = roundTrip(source);
+        expect(out).toContain('# more keys to come');
+        expect(out).toBe(source);
+        expect(roundTrip(out)).toBe(out);
+    });
+
+    it('preserves a leading comment on a services entry', () => {
+        const source = `\
+options {
+    services: {
+        # payments backend
+        PaymentsService: "#src/services/payments.service.js"
+    }
+}
+`;
+        const out = roundTrip(source);
+        expect(out).toContain('# payments backend');
+        expect(out).toBe(source);
+        expect(roundTrip(out)).toBe(out);
+    });
+
+    it('preserves a comment at the end of the last options sub-block (end of options block)', () => {
+        const source = `\
+options {
+    keys: {
+        area: payments
+    }
+    services: {
+        PaymentsService: "#src/services/payments.service.js"
+        # end of options
+    }
+}
+`;
+        const out = roundTrip(source);
+        expect(out).toContain('# end of options');
+        expect(out).toBe(source);
+        expect(roundTrip(out)).toBe(out);
+    });
+
+    it('preserves both leading and trailing comments across keys and services', () => {
+        const source = `\
+options {
+    keys: {
+        # area comment
+        area: payments
+        # trailing keys
+    }
+    services: {
+        # service comment
+        PaymentsService: "#src/services/payments.service.js"
+        # trailing services
+    }
+}
+`;
+        const out = roundTrip(source);
+        expect(out).toBe(source);
+        expect(roundTrip(out)).toBe(out);
+    });
+});

package/coverage/base.css

@@ -1,224 +0,0 @@
-body, html {
-  margin:0; padding: 0;
-  height: 100%;
-}
-body {
-    font-family: Helvetica Neue, Helvetica, Arial;
-    font-size: 14px;
-    color:#333;
-}
-.small { font-size: 12px; }
-*, *:after, *:before {
-  -webkit-box-sizing:border-box;
-     -moz-box-sizing:border-box;
-          box-sizing:border-box;
-  }
-h1 { font-size: 20px; margin: 0;}
-h2 { font-size: 14px; }
-pre {
-    font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
-    margin: 0;
-    padding: 0;
-    -moz-tab-size: 2;
-    -o-tab-size:  2;
-    tab-size: 2;
-}
-a { color:#0074D9; text-decoration:none; }
-a:hover { text-decoration:underline; }
-.strong { font-weight: bold; }
-.space-top1 { padding: 10px 0 0 0; }
-.pad2y { padding: 20px 0; }
-.pad1y { padding: 10px 0; }
-.pad2x { padding: 0 20px; }
-.pad2 { padding: 20px; }
-.pad1 { padding: 10px; }
-.space-left2 { padding-left:55px; }
-.space-right2 { padding-right:20px; }
-.center { text-align:center; }
-.clearfix { display:block; }
-.clearfix:after {
-  content:'';
-  display:block;
-  height:0;
-  clear:both;
-  visibility:hidden;
-  }
-.fl { float: left; }
-@media only screen and (max-width:640px) {
-  .col3 { width:100%; max-width:100%; }
-  .hide-mobile { display:none!important; }
-}
-
-.quiet {
-  color: #7f7f7f;
-  color: rgba(0,0,0,0.5);
-}
-.quiet a { opacity: 0.7; }
-
-.fraction {
-  font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
-  font-size: 10px;
-  color: #555;
-  background: #E8E8E8;
-  padding: 4px 5px;
-  border-radius: 3px;
-  vertical-align: middle;
-}
-
-div.path a:link, div.path a:visited { color: #333; }
-table.coverage {
-  border-collapse: collapse;
-  margin: 10px 0 0 0;
-  padding: 0;
-}
-
-table.coverage td {
-  margin: 0;
-  padding: 0;
-  vertical-align: top;
-}
-table.coverage td.line-count {
-    text-align: right;
-    padding: 0 5px 0 20px;
-}
-table.coverage td.line-coverage {
-    text-align: right;
-    padding-right: 10px;
-    min-width:20px;
-}
-
-table.coverage td span.cline-any {
-    display: inline-block;
-    padding: 0 5px;
-    width: 100%;
-}
-.missing-if-branch {
-    display: inline-block;
-    margin-right: 5px;
-    border-radius: 3px;
-    position: relative;
-    padding: 0 4px;
-    background: #333;
-    color: yellow;
-}
-
-.skip-if-branch {
-    display: none;
-    margin-right: 10px;
-    position: relative;
-    padding: 0 4px;
-    background: #ccc;
-    color: white;
-}
-.missing-if-branch .typ, .skip-if-branch .typ {
-    color: inherit !important;
-}
-.coverage-summary {
-  border-collapse: collapse;
-  width: 100%;
-}
-.coverage-summary tr { border-bottom: 1px solid #bbb; }
-.keyline-all { border: 1px solid #ddd; }
-.coverage-summary td, .coverage-summary th { padding: 10px; }
-.coverage-summary tbody { border: 1px solid #bbb; }
-.coverage-summary td { border-right: 1px solid #bbb; }
-.coverage-summary td:last-child { border-right: none; }
-.coverage-summary th {
-  text-align: left;
-  font-weight: normal;
-  white-space: nowrap;
-}
-.coverage-summary th.file { border-right: none !important; }
-.coverage-summary th.pct { }
-.coverage-summary th.pic,
-.coverage-summary th.abs,
-.coverage-summary td.pct,
-.coverage-summary td.abs { text-align: right; }
-.coverage-summary td.file { white-space: nowrap;  }
-.coverage-summary td.pic { min-width: 120px !important;  }
-.coverage-summary tfoot td { }
-
-.coverage-summary .sorter {
-    height: 10px;
-    width: 7px;
-    display: inline-block;
-    margin-left: 0.5em;
-    background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
-}
-.coverage-summary .sorted .sorter {
-    background-position: 0 -20px;
-}
-.coverage-summary .sorted-desc .sorter {
-    background-position: 0 -10px;
-}
-.status-line {  height: 10px; }
-/* yellow */
-.cbranch-no { background: yellow !important; color: #111; }
-/* dark red */
-.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
-.low .chart { border:1px solid #C21F39 }
-.highlighted,
-.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
-  background: #C21F39 !important;
-}
-/* medium red */
-.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
-/* light red */
-.low, .cline-no { background:#FCE1E5 }
-/* light green */
-.high, .cline-yes { background:rgb(230,245,208) }
-/* medium green */
-.cstat-yes { background:rgb(161,215,106) }
-/* dark green */
-.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
-.high .chart { border:1px solid rgb(77,146,33) }
-/* dark yellow (gold) */
-.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
-.medium .chart { border:1px solid #f9cd0b; }
-/* light yellow */
-.medium { background: #fff4c2; }
-
-.cstat-skip { background: #ddd; color: #111; }
-.fstat-skip { background: #ddd; color: #111 !important; }
-.cbranch-skip { background: #ddd !important; color: #111; }
-
-span.cline-neutral { background: #eaeaea; }
-
-.coverage-summary td.empty {
-    opacity: .5;
-    padding-top: 4px;
-    padding-bottom: 4px;
-    line-height: 1;
-    color: #888;
-}
-
-.cover-fill, .cover-empty {
-  display:inline-block;
-  height: 12px;
-}
-.chart {
-  line-height: 0;
-}
-.cover-empty {
-    background: white;
-}
-.cover-full {
-    border-right: none !important;
-}
-pre.prettyprint {
-    border: none !important;
-    padding: 0 !important;
-    margin: 0 !important;
-}
-.com { color: #999 !important; }
-.ignore-none { color: #999; font-weight: normal; }
-
-.wrapper {
-  min-height: 100%;
-  height: auto !important;
-  height: 100%;
-  margin: 0 auto -48px;
-}
-.footer, .push {
-  height: 48px;
-}

package/coverage/block-navigation.js

@@ -1,87 +0,0 @@
-/* eslint-disable */
-var jumpToCode = (function init() {
-    // Classes of code we would like to highlight in the file view
-    var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
-
-    // Elements to highlight in the file listing view
-    var fileListingElements = ['td.pct.low'];
-
-    // We don't want to select elements that are direct descendants of another match
-    var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
-
-    // Selector that finds elements on the page to which we can jump
-    var selector =
-        fileListingElements.join(', ') +
-        ', ' +
-        notSelector +
-        missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
-
-    // The NodeList of matching elements
-    var missingCoverageElements = document.querySelectorAll(selector);
-
-    var currentIndex;
-
-    function toggleClass(index) {
-        missingCoverageElements
-            .item(currentIndex)
-            .classList.remove('highlighted');
-        missingCoverageElements.item(index).classList.add('highlighted');
-    }
-
-    function makeCurrent(index) {
-        toggleClass(index);
-        currentIndex = index;
-        missingCoverageElements.item(index).scrollIntoView({
-            behavior: 'smooth',
-            block: 'center',
-            inline: 'center'
-        });
-    }
-
-    function goToPrevious() {
-        var nextIndex = 0;
-        if (typeof currentIndex !== 'number' || currentIndex === 0) {
-            nextIndex = missingCoverageElements.length - 1;
-        } else if (missingCoverageElements.length > 1) {
-            nextIndex = currentIndex - 1;
-        }
-
-        makeCurrent(nextIndex);
-    }
-
-    function goToNext() {
-        var nextIndex = 0;
-
-        if (
-            typeof currentIndex === 'number' &&
-            currentIndex < missingCoverageElements.length - 1
-        ) {
-            nextIndex = currentIndex + 1;
-        }
-
-        makeCurrent(nextIndex);
-    }
-
-    return function jump(event) {
-        if (
-            document.getElementById('fileSearch') === document.activeElement &&
-            document.activeElement != null
-        ) {
-            // if we're currently focused on the search input, we don't want to navigate
-            return;
-        }
-
-        switch (event.which) {
-            case 78: // n
-            case 74: // j
-                goToNext();
-                break;
-            case 66: // b
-            case 75: // k
-            case 80: // p
-                goToPrevious();
-                break;
-        }
-    };
-})();
-window.addEventListener('keydown', jumpToCode);