@contractkit/prettier-plugin 0.12.1 → 0.13.0

package/tests/round-trip.test.ts

@@ -0,0 +1,268 @@
+import { describe, it, expect } from 'vitest';
+import { readdirSync, readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { printCk } from '../src/print-ck.js';
+import { parseCk, DiagnosticCollector } from '@contractkit/core';
+
+/**
+ * Formatting a `.ck` file must not change it.
+ *
+ * The prettier plugin used to fold standalone `#` comment blocks into trailing comments on the
+ * following declaration, reorder operation body keys, drop blank lines between operations, and
+ * expand single-line response bodies — all of which silently rewrote a user's file on
+ * `pnpm format`. These tests pin the guarantee: parse → print is the identity on well-formed
+ * source, and printing is idempotent.
+ */
+
+function format(source: string, file = 'test.ck'): string {
+    const diag = new DiagnosticCollector();
+    const ast = parseCk(source, file, diag);
+    expect(diag.hasErrors()).toBe(false);
+    return printCk(ast);
+}
+
+// ─── Repository contracts ────────────────────────────────────────────────────
+
+const CONTRACTS_DIR = new URL('../../../contracts', import.meta.url).pathname;
+const ckFiles = readdirSync(CONTRACTS_DIR).filter(f => f.endsWith('.ck'));
+
+describe('round-trip — repository .ck files', () => {
+    it('finds .ck files to check', () => {
+        expect(ckFiles.length).toBeGreaterThan(0);
+    });
+
+    for (const name of ckFiles) {
+        it(`formats ${name} to itself`, () => {
+            const source = readFileSync(join(CONTRACTS_DIR, name), 'utf8');
+            expect(format(source, name)).toBe(source);
+        });
+    }
+});
+
+// ─── Constructs that previously round-tripped lossily ────────────────────────
+
+describe('round-trip — comment placement', () => {
+    it('keeps a standalone comment block above the declaration it precedes', () => {
+        const source = `# ─── Pet endpoints ───
+
+operation /pet: {
+    get: {
+        response: {
+            200:
+        }
+    }
+}
+`;
+        expect(format(source)).toBe(source);
+    });
+
+    it('keeps a contract doc comment on its own line', () => {
+        const source = `# A pet for sale
+contract Pet: {
+    id: int
+}
+`;
+        expect(format(source)).toBe(source);
+    });
+
+    it('keeps a contract doc comment inline when written inline', () => {
+        const source = `contract Pet: { # A pet for sale
+    id: int
+}
+`;
+        expect(format(source)).toBe(source);
+    });
+
+    it('distinguishes a divider from the doc comment below it', () => {
+        const source = `# ─── Models ───
+
+# A pet for sale
+contract Pet: {
+    id: int
+}
+`;
+        expect(format(source)).toBe(source);
+    });
+
+    it('keeps an operation doc comment on its own line', () => {
+        const source = `operation /pet: {
+    # update an existing pet
+    put: {
+        response: {
+            200:
+        }
+    }
+}
+`;
+        expect(format(source)).toBe(source);
+    });
+
+    it('keeps an operation doc comment inline when written inline', () => {
+        const source = `operation /pet: {
+    put: { # update an existing pet
+        response: {
+            200:
+        }
+    }
+}
+`;
+        expect(format(source)).toBe(source);
+    });
+});
+
+describe('round-trip — comments in the options block', () => {
+    it('keeps a comment above a sub-block', () => {
+        const source = `options {
+    # where these come from
+    keys: {
+        area: ledger
+    }
+}
+`;
+        expect(format(source)).toBe(source);
+    });
+
+    it('keeps a comment run above the sub-block it precedes', () => {
+        const source = `options {
+    keys: {
+        area: ledger
+    }
+    # service wiring
+    # one per module
+    services: {
+        UserService: "#src/user.js"
+    }
+}
+`;
+        expect(format(source)).toBe(source);
+    });
+
+    it('keeps a trailing comment before the closing brace', () => {
+        const source = `options {
+    keys: {
+        area: ledger
+    }
+    # nothing below
+}
+`;
+        expect(format(source)).toBe(source);
+    });
+
+    it('keeps an options block that holds nothing but a comment', () => {
+        const source = `options {
+    # a note
+}
+`;
+        expect(format(source)).toBe(source);
+    });
+});
+
+describe('round-trip — operation body key order', () => {
+    it('does not reorder keys into a canonical order', () => {
+        const source = `operation /pet: {
+    put: {
+        sdk: updatePet
+        service: PetService.update
+        response: {
+            200:
+        }
+    }
+}
+`;
+        expect(format(source)).toBe(source);
+    });
+
+    it('preserves the opposite order just as faithfully', () => {
+        const source = `operation /pet: {
+    put: {
+        service: PetService.update
+        sdk: updatePet
+        response: {
+            200:
+        }
+    }
+}
+`;
+        expect(format(source)).toBe(source);
+    });
+});
+
+describe('round-trip — layout', () => {
+    it('keeps blank lines between operations', () => {
+        const source = `operation /pet: {
+    get: {
+        response: {
+            200:
+        }
+    }
+
+    post: {
+        response: {
+            201:
+        }
+    }
+}
+`;
+        expect(format(source)).toBe(source);
+    });
+
+    it('keeps operations packed when the source has no blank line', () => {
+        const source = `operation /pet: {
+    get: {
+        response: {
+            200:
+        }
+    }
+    post: {
+        response: {
+            201:
+        }
+    }
+}
+`;
+        expect(format(source)).toBe(source);
+    });
+
+    it('keeps a single-line response body on one line', () => {
+        const source = `operation /pet: {
+    get: {
+        response: {
+            200: { application/json: Pet }
+        }
+    }
+}
+`;
+        expect(format(source)).toBe(source);
+    });
+
+    it('keeps an expanded response body expanded', () => {
+        const source = `operation /pet: {
+    get: {
+        response: {
+            200: {
+                application/json: Pet
+            }
+        }
+    }
+}
+`;
+        expect(format(source)).toBe(source);
+    });
+});
+
+// ─── Idempotence ─────────────────────────────────────────────────────────────
+
+describe('round-trip — idempotence', () => {
+    const sources = [
+        ...ckFiles.map(name => readFileSync(join(CONTRACTS_DIR, name), 'utf8')),
+        // Non-canonical spacing: formatting once must reach a fixed point.
+        `operation /pet: {\n    get: {\n        response: {\n            200:\n        }\n    }\n}\n`,
+    ];
+
+    for (const [i, source] of sources.entries()) {
+        it(`formatting is a fixed point for source #${i}`, () => {
+            const once = format(source);
+            expect(format(once)).toBe(once);
+        });
+    }
+});

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);