@bhsd/codemirror-stickyscroll 0.1.0 → 0.1.1

package/README.md

@@ -2,11 +2,7 @@
 
 > VS Code / Monaco-style **sticky scroll** (sticky lines) for [CodeMirror 6](https://codemirror.net/).
 
-<p align="center">
-  <img src="preview/image.png" alt="Sticky Scroll Preview" width="750" />
-</p>
-
-This is a fork of [@fazelstudio/codemirror-stickyscroll](https://github.com/fazel-studio/codemirror-stickyscroll).
+This is a fork of [@fazelstudio/codemirror-stickyscroll](https://github.com/fazelstudio/codemirror-stickyscroll) that adds support for [foldService](https://codemirror.net/docs/ref/#language.foldService), which makes it compatible with legacy [StreamParser](https://codemirror.net/docs/ref/#language.StreamParser) languages that register folding.
 
 Sticky lines keep the *opening* lines of the enclosing scopes (function, class,
 if/loop blocks, …) pinned at the top of the editor while you scroll — exactly
@@ -24,7 +20,7 @@ extension** (no fork of `@codemirror/*`).
   *active* highlight styles of the editor (`highlightingFor`), or clones the
   already-rendered DOM line when available. The package **never** registers its
   own `syntaxHighlighting(...)`.
-- **Language-agnostic** — detection is based on `foldable()` from
+- **Language-agnostic** — detection is based on `foldNodeProp` or `foldService` from
   `@codemirror/language` (the fold services / fold node props that every
   `@codemirror/lang-*` already registers). It includes a smart, generic denylist
   that works across multiple languages (JS/TS, Python, Rust, Go, etc.) out of the box,
@@ -45,11 +41,9 @@ has a working CodeMirror 6 editor):
 
 | Package | Minimum |
 | --- | --- |
-| `@codemirror/view` | ^6.0.0 |
+| `@codemirror/view` | ^6.3.0 |
 | `@codemirror/state` | ^6.0.0 |
 | `@codemirror/language` | ^6.0.0 |
-| `@lezer/common` | ^1.0.0 |
-| `@lezer/highlight` | ^1.0.0 |
 
 ## API
 
@@ -59,7 +53,7 @@ has a working CodeMirror 6 editor):
 interface StickyScrollOptions {
   /** Maximum sticky lines shown at once (dynamically clamped to ~40% of editor height). Default: 4 */
   maxStickyLines?: number;
-  /** Minimum lines a scope must span to become sticky. Default: 2 */
+  /** Minimum lines a scope must span to become sticky. Default: 6 */
   minBlockLines?: number;
   /**
    * Denylist predicate: return true to never pin a foldable node of that type.
@@ -67,11 +61,7 @@ interface StickyScrollOptions {
    * It uses exact node names for JS/TS and generic regex patterns for other
    * languages, while automatically bypassing the literal denylist for JSON.
    */
-  excludeNode?: (nodeName: string, langName: string | undefined) => boolean;
-  /** Extra HighlightStyle merged in when a line is re-highlighted from scratch. */
-  highlightStyle?: HighlightStyle;
-  /** Called after a sticky line is clicked (after the jump is dispatched). */
-  onLineClick?: (lineNumber: number) => void;
+  excludeNode?: (nodeName?: string, langName?: string, ownerName?: string) => boolean;
   /** Extra CSS class(es) for the bar container. */
   class?: string;
 }
@@ -105,15 +95,14 @@ Per-row hooks:
 | `.cm-stickyscroll-line:hover` | hover highlight |
 | `.cm-stickyscroll-line.cm-stickyscroll-current` | block containing the cursor |
 | `.cm-stickyscroll-gutter` | line-number cell |
-| `.cm-stickyscroll-text` | code column (horizontally synced) |
+| `.cm-stickyscroll-code` | code column (horizontally synced) |
 
 ## How it works
 
-1. **Detect the top line** — `view.lineBlockAtHeight(scrollTop - documentTop)`.
+1. **Detect the top line** — `view.lineBlockAtHeight(clientTop - documentTop)`.
 2. **Walk the syntax tree** — from `syntaxTree(state).resolveInner(topPos, 0)`
    up through `node.parent`.
-3. **A scope qualifies when** its opening line is *foldable*
-   (`foldable(state, line.from, line.to)` from `@codemirror/language`), its fold
+3. **A scope qualifies when** its opening line is *foldable*, its fold
    anchor node is not denylisted, and it spans ≥ `minBlockLines`.
 4. **Render** — a `ViewPlugin` owns an absolutely-positioned overlay
    (`position: absolute; top: 0` inside `view.dom`), updated per-frame from the

package/dist/compute.js

@@ -7,6 +7,11 @@ import { ensureSyntaxTree, foldNodeProp, foldService, language, syntaxTree } fro
  * reveal; once the tree covers the position the cost is O(1).
  */
 const PARSE_TIMEOUT = 25;
+/**
+ * Maximum number of lines to scan for foldable blocks when any fold service is
+ * registered.
+ */
+const MAX_SERVICE_SCAN_LINES = 100;
 /**
  * Return the best syntax tree we can answer a query at `pos` with right now.
  *
@@ -57,7 +62,7 @@ export function getStickyContext(view, config) {
     const lineHeight = Math.round(view.defaultLineHeight) || 16;
     const maxDynamic = Math.max(1, Math.floor(view.scrollDOM.clientHeight * 0.4 / lineHeight));
     const maxSticky = Math.min(config.maxStickyLines, maxDynamic);
-    return getStickyContextForRange(view, topBlock.from, config, parseTree, maxSticky);
+    return getStickyContextForRange(state, topBlock.from, config, parseTree, maxSticky);
 }
 /**
  * Pure version of the algorithm.
@@ -66,7 +71,7 @@ export function getStickyContext(view, config) {
  * already-extended tree (see `getStickyContext`) to compute against a parse
  * that is known to cover `fromPos`.
  */
-function getStickyContextForRange({ state, viewport }, fromPos, config, t, maxSticky) {
+function getStickyContextForRange(state, fromPos, config, t, maxSticky) {
     const lang = state.facet(language);
     if (!lang)
         return [];
@@ -129,10 +134,9 @@ function getStickyContextForRange({ state, viewport }, fromPos, config, t, maxSt
         }
     }
     else {
-        for (let openLine = topLineNumber - 1; openLine > 0; openLine--) {
+        const minLineNumber = Math.max(0, topLineNumber - MAX_SERVICE_SCAN_LINES);
+        for (let openLine = topLineNumber - 1; openLine > minLineNumber; openLine--) {
             const open = doc.line(openLine);
-            if (open.to < viewport.from)
-                break;
             const ownerName = open.text.trim();
             if (!exclude(undefined, langName, ownerName)) {
                 for (const service of services) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@bhsd/codemirror-stickyscroll",
-	"version": "0.1.0",
+	"version": "0.1.1",
 	"description": "VS Code / Monaco-style sticky scroll (sticky lines) extension for CodeMirror 6",
 	"keywords": [
 		"codemirror",
@@ -44,9 +44,9 @@
 		"@codemirror/language": "^6.12.4",
 		"@codemirror/state": "^6.7.1",
 		"@codemirror/view": "^6.43.9",
-		"eslint": "^10.9.1",
+		"eslint": "^10.10.0",
 		"markdownlint-cli2": "^0.23.2",
-		"stylelint": "^17.14.1",
+		"stylelint": "^17.15.0",
 		"typescript": "^6.0.3"
 	}
 }