@bhsd/codemirror-stickyscroll 0.1.0 → 0.2.0

package/README.md

@@ -2,11 +2,10 @@
 
 > 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. This personal fork also removes some unused features.
 
 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
@@ -19,16 +18,17 @@ extension** (no fork of `@codemirror/*`).
   throttle keeps the bar glued to the scroll position; no "jumpy" updates.
 - **Click-to-jump with margin compensation** — clicking a sticky line scrolls
   the target line to the top *plus* the current bar height, so the line you
-  jump to is never hidden behind the bar. Keyboard (`Enter`/`Space`) + `role="button"` for a11y.
+  jump to is never hidden behind the bar. Keyboard (`Enter`/`Space`) +
+  `role="button"` for a11y.
 - **Reuses the consumer's theme** — the bar re-highlights lines through the
   *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
-  `@codemirror/language` (the fold services / fold node props that every
+- **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,
-  and gracefully handles data languages like JSON.
+  that works across multiple languages (JS/TS, Python, Rust, Go, etc.) out of
+  the box, and gracefully handles data languages like JSON.
 - **Gutter alignment, horizontal sync, RTL, resize-proof** — line numbers are
   aligned with the real gutter (width tracked via `ResizeObserver`), the bar
   follows horizontal scroll, and it reacts to font/zoom/resize changes.
@@ -45,11 +45,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 +57,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 +65,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;
 }
@@ -82,12 +76,8 @@ interface StickyScrollOptions {
 ```ts
 import {
   stickyScroll,
-  stickyScrollFacet,        // the configuration Facet (compose/override per instance)
   defaultExcludeNode,       // default denylist implementation
-  makeStickyScrollConfig,   // merge options with defaults
-  stickyScrollBaseTheme,    // layout-only base theme (no token colors)
   type StickyScrollOptions,
-  type StickyLine,
 } from "@bhsd/codemirror-stickyscroll";
 ```
 
@@ -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,28 +134,28 @@ 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) {
                     const foldRange = service(state, open.from, open.to);
-                    if (foldRange) {
-                        const nodeTo = Math.min(foldRange.to, doc.length);
-                        const close = doc.lineAt(nodeTo);
-                        const closeLine = close.number;
-                        if (closeLine - openLine + 1 >= minBlockLines && closeLine >= topLineNumber) {
-                            found.push({
-                                lineNumber: openLine,
-                                from: open.from,
-                                to: open.to,
-                                text: open.text,
-                                nodeFrom: foldRange.from,
-                                nodeTo,
-                            });
-                        }
+                    if (!foldRange) {
+                        continue;
+                    }
+                    const nodeTo = Math.min(foldRange.to, doc.length);
+                    const close = doc.lineAt(nodeTo);
+                    const closeLine = close.number;
+                    if (closeLine - openLine + 1 >= minBlockLines && closeLine >= topLineNumber) {
+                        found.push({
+                            lineNumber: openLine,
+                            from: open.from,
+                            to: open.to,
+                            text: open.text,
+                            nodeFrom: foldRange.from,
+                            nodeTo,
+                        });
                     }
                 }
             }

package/dist/facet.d.ts

@@ -35,8 +35,6 @@ export interface StickyScrollConfig extends Required<Pick<StickyScrollOptions, "
  * for a language you need exact behavior on.
  */
 export declare const defaultExcludeNode: (nodeName?: string, langName?: string, ownerName?: string) => boolean;
-/** Merge partial options with built-in defaults. */
-export declare function makeStickyScrollConfig(options?: StickyScrollOptions): StickyScrollConfig;
 /**
  * The facet carrying the sticky-scroll configuration.
  *

package/dist/facet.js

@@ -59,7 +59,7 @@ export const defaultExcludeNode = (nodeName, langName, ownerName) => {
 const DEFAULT_MAX_STICKY_LINES = 4;
 const DEFAULT_MIN_BLOCK_LINES = 6;
 /** Merge partial options with built-in defaults. */
-export function makeStickyScrollConfig(options) {
+function makeStickyScrollConfig(options) {
     var _a, _b, _c;
     return {
         maxStickyLines: (_a = options === null || options === void 0 ? void 0 : options.maxStickyLines) !== null && _a !== void 0 ? _a : DEFAULT_MAX_STICKY_LINES,

package/dist/index.d.ts

@@ -1,9 +1,7 @@
 import type { Extension } from "@codemirror/state";
 import { type StickyScrollOptions } from "./facet";
-export type { StickyLine } from "./types";
-export type { StickyScrollOptions, StickyScrollConfig } from "./facet";
-export { stickyScrollFacet, defaultExcludeNode, makeStickyScrollConfig } from "./facet";
-export { stickyScrollBaseTheme } from "./theme";
+export type { StickyScrollOptions } from "./facet";
+export { defaultExcludeNode } from "./facet";
 /**
  * Add Monaco/VS Code-style sticky scroll to a CodeMirror 6 editor.
  *

package/dist/index.js

@@ -1,8 +1,7 @@
 import { stickyScrollFacet } from "./facet";
 import { scrollStickyPlugin } from "./plugin";
 import { stickyScrollBaseTheme } from "./theme";
-export { stickyScrollFacet, defaultExcludeNode, makeStickyScrollConfig } from "./facet";
-export { stickyScrollBaseTheme } from "./theme";
+export { defaultExcludeNode } from "./facet";
 /**
  * Add Monaco/VS Code-style sticky scroll to a CodeMirror 6 editor.
  *

package/dist/render.js

@@ -16,9 +16,6 @@ class StateHighlighter {
     style(tags) {
         return highlightingFor(this.state, tags, this.topNodeType);
     }
-    scope() {
-        return true;
-    }
 }
 // ---------------------------------------------------------------------------
 // Internal: find the live `.cm-line` DOM element for a document line
@@ -35,13 +32,7 @@ function findRenderedLineElement(view, lineNumber) {
     // (Block widgets, placeholder lines and render-margin lines make those two
     // lists diverge, which previously caused wrong — blank / comment / `}` —
     // line text to be cloned into the sticky bar.)
-    let dom;
-    try {
-        dom = view.domAtPos(lineFrom, 1);
-    }
-    catch {
-        return null;
-    }
+    const dom = view.domAtPos(lineFrom, 1);
     let el = dom.node instanceof HTMLElement ? dom.node : dom.node.parentElement;
     while (el && !el.classList.contains("cm-line"))
         el = el.parentElement;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@bhsd/codemirror-stickyscroll",
-	"version": "0.1.0",
+	"version": "0.2.0",
 	"description": "VS Code / Monaco-style sticky scroll (sticky lines) extension for CodeMirror 6",
 	"keywords": [
 		"codemirror",
@@ -40,13 +40,13 @@
 		"@codemirror/view": "^6.0.0"
 	},
 	"devDependencies": {
-		"@bhsd/code-standard": "^4.1.0",
+		"@bhsd/code-standard": "^4.3.0",
 		"@codemirror/language": "^6.12.4",
-		"@codemirror/state": "^6.7.1",
-		"@codemirror/view": "^6.43.9",
-		"eslint": "^10.9.1",
-		"markdownlint-cli2": "^0.23.2",
-		"stylelint": "^17.14.1",
+		"@codemirror/state": "^6.7.6",
+		"@codemirror/view": "^6.43.13",
+		"eslint": "^10.11.0",
+		"markdownlint-cli2": "^0.23.3",
+		"stylelint": "^17.16.0",
 		"typescript": "^6.0.3"
 	}
 }