@cluesmith/codev-core 3.1.8 → 3.2.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/review-markers.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Review-marker codec — the single, host-agnostic home for the on-disk `REVIEW`
+ * comment format and the transforms a rendered review surface needs.
+ *
+ * Background (#859): `@cluesmith/codev-artifact-canvas` renders Codev artifacts
+ * (specs/plans/reviews) and lets a reviewer add inline comments. A comment is
+ * serialized into the markdown as a positional HTML comment:
+ *
+ *     <!-- REVIEW(@<author>): <text> -->
+ *
+ * written on the line **after** the block it annotates. There is no `line=N`
+ * attribute. The marker's *position in the file* is the entire line association:
+ * a marker annotates the nearest non-marker line above it (so a stack of
+ * comments on one block all resolve to that block). This convention
+ * matches both the existing VSCode editor Comments-API path
+ * (`packages/vscode/src/comments/plan-review.ts`) and the canvas package's own
+ * tested adapter contract, so the two authoring surfaces round-trip through the
+ * same bytes.
+ *
+ * This module lives in `core` (not in a host) because the convention is a
+ * cross-host contract: the VSCode host consumes it now, and the dashboard /
+ * future hosts consume the same functions so they cannot drift. It is pure
+ * (no `vscode`, no DOM, no I/O) and therefore safe in both Node and the browser.
+ *
+ * Hiding markers from the rendered body is NOT done here: the canvas renderer
+ * strips full-line HTML comments before parsing (keeping blocks intact and
+ * `data-line` accurate), so hosts pass raw document text straight through. This
+ * codec is purely the on-disk read/write convention (#1036 is fixed in the
+ * renderer, #1042).
+ */
+/**
+ * In-memory model of one review marker. Structurally matches
+ * `ReviewMarker` from `@cluesmith/codev-artifact-canvas` (kept as a local
+ * declaration so `core` does not depend on the React rendering package).
+ */
+export interface ReviewMarker {
+    author: string;
+    /** 0-based logical line the marker annotates (the line *above* the marker). */
+    line: number;
+    text: string;
+    /** Original on-disk marker text, for lossless round-tripping. */
+    raw: string;
+    /** Reserved for region anchors (unused in v1). */
+    lineRange?: {
+        start: number;
+        end: number;
+    };
+}
+/**
+ * Eligible artifact paths — the `+` affordance and the canvas editor are gated
+ * to these. Shared so the editor path and the canvas host agree on one rule.
+ */
+export declare const ELIGIBLE_PATH_REGEX: RegExp;
+/** True if `fsPath` (forward-slash normalized or not) is a review-eligible artifact. */
+export declare function isEligibleReviewPath(fsPath: string): boolean;
+/** True if a single line is a review marker. */
+export declare function isReviewMarkerLine(line: string): boolean;
+/**
+ * Serialize a marker to its canonical on-disk form. The body is
+ * whitespace-normalized to a single line (markers are single-line by
+ * convention; the canvas/editor decorations assume one line). `indent` is
+ * prepended so a marker inside an indented list item keeps the list's
+ * indentation.
+ */
+export declare function serializeReviewMarker(author: string, body: string, indent?: string): string;
+/**
+ * The file line a new marker is written to, given the 0-based line it annotates:
+ * the line *after* the annotated line. Encoded here so every caller (editor +
+ * canvas host) shares one definition of the convention and cannot drift.
+ */
+export declare function markerInsertionLine(annotatedLine: number): number;
+/**
+ * Parse all review markers out of `text` into `ReviewMarker`s, mapping each to
+ * the 0-based logical line it annotates: the nearest line ABOVE the marker that
+ * is not itself a marker. Skipping over a run of stacked markers means several
+ * comments on one block all anchor to that block's start (the canvas renders
+ * them as a list) instead of each pointing at the marker above it. A marker, or
+ * a run of markers, at the very top of the file annotates nothing and is skipped.
+ */
+export declare function parseReviewMarkers(text: string): ReviewMarker[];
+//# sourceMappingURL=review-markers.d.ts.map

package/dist/review-markers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"review-markers.d.ts","sourceRoot":"","sources":["../src/review-markers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,iEAAiE;IACjE,GAAG,EAAE,MAAM,CAAC;IACZ,kDAAkD;IAClD,SAAS,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CAC5C;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,QAAqC,CAAC;AAUtE,wFAAwF;AACxF,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAE5D;AAED,gDAAgD;AAChD,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAExD;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,SAAK,GAAG,MAAM,CAGvF;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,CAEjE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,EAAE,CAY/D"}

package/dist/review-markers.js

@@ -0,0 +1,97 @@
+/**
+ * Review-marker codec — the single, host-agnostic home for the on-disk `REVIEW`
+ * comment format and the transforms a rendered review surface needs.
+ *
+ * Background (#859): `@cluesmith/codev-artifact-canvas` renders Codev artifacts
+ * (specs/plans/reviews) and lets a reviewer add inline comments. A comment is
+ * serialized into the markdown as a positional HTML comment:
+ *
+ *     <!-- REVIEW(@<author>): <text> -->
+ *
+ * written on the line **after** the block it annotates. There is no `line=N`
+ * attribute. The marker's *position in the file* is the entire line association:
+ * a marker annotates the nearest non-marker line above it (so a stack of
+ * comments on one block all resolve to that block). This convention
+ * matches both the existing VSCode editor Comments-API path
+ * (`packages/vscode/src/comments/plan-review.ts`) and the canvas package's own
+ * tested adapter contract, so the two authoring surfaces round-trip through the
+ * same bytes.
+ *
+ * This module lives in `core` (not in a host) because the convention is a
+ * cross-host contract: the VSCode host consumes it now, and the dashboard /
+ * future hosts consume the same functions so they cannot drift. It is pure
+ * (no `vscode`, no DOM, no I/O) and therefore safe in both Node and the browser.
+ *
+ * Hiding markers from the rendered body is NOT done here: the canvas renderer
+ * strips full-line HTML comments before parsing (keeping blocks intact and
+ * `data-line` accurate), so hosts pass raw document text straight through. This
+ * codec is purely the on-disk read/write convention (#1036 is fixed in the
+ * renderer, #1042).
+ */
+/**
+ * Eligible artifact paths — the `+` affordance and the canvas editor are gated
+ * to these. Shared so the editor path and the canvas host agree on one rule.
+ */
+export const ELIGIBLE_PATH_REGEX = /\/codev\/(plans|specs|reviews)\//;
+/**
+ * Per-line marker matcher. Capture groups: [1] indent, [2] author, [3] body.
+ * A marker occupies its own line by convention; the body is single-line
+ * (whitespace-normalized at write time). Tolerant of surrounding whitespace to
+ * stay compatible with markers authored by the editor path and by hand.
+ */
+const REVIEW_MARKER_RE = /^(\s*)<!--\s*REVIEW\s*\(@([^)]+)\)\s*:\s*([\s\S]*?)\s*-->\s*$/;
+/** True if `fsPath` (forward-slash normalized or not) is a review-eligible artifact. */
+export function isEligibleReviewPath(fsPath) {
+    return ELIGIBLE_PATH_REGEX.test(fsPath.replace(/\\/g, '/'));
+}
+/** True if a single line is a review marker. */
+export function isReviewMarkerLine(line) {
+    return REVIEW_MARKER_RE.test(line);
+}
+/**
+ * Serialize a marker to its canonical on-disk form. The body is
+ * whitespace-normalized to a single line (markers are single-line by
+ * convention; the canvas/editor decorations assume one line). `indent` is
+ * prepended so a marker inside an indented list item keeps the list's
+ * indentation.
+ */
+export function serializeReviewMarker(author, body, indent = '') {
+    const normalized = body.replace(/\s+/g, ' ').trim();
+    return `${indent}<!-- REVIEW(@${author}): ${normalized} -->`;
+}
+/**
+ * The file line a new marker is written to, given the 0-based line it annotates:
+ * the line *after* the annotated line. Encoded here so every caller (editor +
+ * canvas host) shares one definition of the convention and cannot drift.
+ */
+export function markerInsertionLine(annotatedLine) {
+    return annotatedLine + 1;
+}
+/**
+ * Parse all review markers out of `text` into `ReviewMarker`s, mapping each to
+ * the 0-based logical line it annotates: the nearest line ABOVE the marker that
+ * is not itself a marker. Skipping over a run of stacked markers means several
+ * comments on one block all anchor to that block's start (the canvas renders
+ * them as a list) instead of each pointing at the marker above it. A marker, or
+ * a run of markers, at the very top of the file annotates nothing and is skipped.
+ */
+export function parseReviewMarkers(text) {
+    const out = [];
+    const lines = text.split('\n');
+    for (let i = 0; i < lines.length; i++) {
+        const m = REVIEW_MARKER_RE.exec(lines[i]);
+        if (!m) {
+            continue;
+        }
+        let anchor = i - 1;
+        while (anchor >= 0 && isReviewMarkerLine(lines[anchor])) {
+            anchor--;
+        }
+        if (anchor < 0) {
+            continue;
+        }
+        out.push({ author: m[2], line: anchor, text: m[3], raw: lines[i].trim() });
+    }
+    return out;
+}
+//# sourceMappingURL=review-markers.js.map

package/dist/review-markers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"review-markers.js","sourceRoot":"","sources":["../src/review-markers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAkBH;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,kCAAkC,CAAC;AAEtE;;;;;GAKG;AACH,MAAM,gBAAgB,GAAG,+DAA+D,CAAC;AAEzF,wFAAwF;AACxF,MAAM,UAAU,oBAAoB,CAAC,MAAc;IACjD,OAAO,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;AAC9D,CAAC;AAED,gDAAgD;AAChD,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAAc,EAAE,IAAY,EAAE,MAAM,GAAG,EAAE;IAC7E,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IACpD,OAAO,GAAG,MAAM,gBAAgB,MAAM,MAAM,UAAU,MAAM,CAAC;AAC/D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,aAAqB;IACvD,OAAO,aAAa,GAAG,CAAC,CAAC;AAC3B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,MAAM,GAAG,GAAmB,EAAE,CAAC;IAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,CAAC,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,IAAI,CAAC,CAAC,EAAE,CAAC;YAAC,SAAS;QAAC,CAAC;QACrB,IAAI,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC;QACnB,OAAO,MAAM,IAAI,CAAC,IAAI,kBAAkB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;YAAC,MAAM,EAAE,CAAC;QAAC,CAAC;QACtE,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YAAC,SAAS;QAAC,CAAC;QAC7B,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC7E,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cluesmith/codev-core",
-  "version": "3.1.8",
+  "version": "3.2.0",
   "description": "Core runtime utilities for Codev — Tower client, auth, workspace helpers, escape buffer",
   "type": "module",
   "exports": {
@@ -43,22 +43,25 @@
     "./phase-grouping": {
       "types": "./dist/phase-grouping.d.ts",
       "default": "./dist/phase-grouping.js"
+    },
+    "./review-markers": {
+      "types": "./dist/review-markers.d.ts",
+      "default": "./dist/review-markers.js"
     }
   },
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsc",
-    "check-types": "tsc --noEmit",
-    "test": "vitest run",
-    "prepublishOnly": "pnpm build"
-  },
   "devDependencies": {
-    "@cluesmith/codev-types": "workspace:*",
     "@types/node": "22.x",
     "typescript": "^5.7.0",
-    "vitest": "^4.0.15"
+    "vitest": "^4.0.15",
+    "@cluesmith/codev-types": "3.2.0"
   },
-  "license": "Apache-2.0"
-}
+  "license": "Apache-2.0",
+  "scripts": {
+    "build": "tsc",
+    "check-types": "tsc --noEmit",
+    "test": "vitest run"
+  }
+}