@bhsd/codemirror-stickyscroll 0.1.1 → 0.3.0

package/README.md

@@ -2,7 +2,10 @@
 
 > VS Code / Monaco-style **sticky scroll** (sticky lines) for [CodeMirror 6](https://codemirror.net/).
 
-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 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
@@ -15,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 `foldNodeProp` or `foldService` 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.
@@ -72,12 +76,9 @@ 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)
+  stickyScrollEffect,       // StateEffect to trigger a re-render (e.g. after theme change)
   type StickyScrollOptions,
-  type StickyLine,
 } from "@bhsd/codemirror-stickyscroll";
 ```
 

package/dist/compute.js

@@ -85,6 +85,19 @@ function getStickyContextForRange(state, fromPos, config, t, maxSticky) {
     const exclude = config.excludeNode;
     const langName = lang.name;
     const found = [];
+    const pushStickyLine = (open, closeLine, nodeFrom, nodeTo) => {
+        const openLine = open.number;
+        if (closeLine - openLine + 1 >= minBlockLines && closeLine >= topLineNumber) {
+            found.push({
+                lineNumber: openLine,
+                from: open.from,
+                to: open.to,
+                text: open.text,
+                nodeFrom,
+                nodeTo,
+            });
+        }
+    };
     const services = state.facet(foldService);
     if (services.length === 0) {
         let node = t.resolveInner(fromPos, 0);
@@ -115,16 +128,7 @@ function getStickyContextForRange(state, fromPos, config, t, maxSticky) {
                                 // what delays the slide-away until the real closing brace.
                                 const close = doc.lineAt(Math.min(owner.to, doc.length));
                                 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: owner.from,
-                                        nodeTo: owner.to,
-                                    });
-                                }
+                                pushStickyLine(open, closeLine, owner.from, owner.to);
                             }
                         }
                     }
@@ -141,21 +145,11 @@ function getStickyContextForRange(state, fromPos, config, t, maxSticky) {
             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);
+                    pushStickyLine(open, doc.lineAt(nodeTo).number, 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,8 @@
 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";
+export { stickyScrollEffect } from "./plugin";
 /**
  * Add Monaco/VS Code-style sticky scroll to a CodeMirror 6 editor.
  *

package/dist/index.js

@@ -1,8 +1,8 @@
 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";
+export { stickyScrollEffect } from "./plugin";
 /**
  * Add Monaco/VS Code-style sticky scroll to a CodeMirror 6 editor.
  *

package/dist/plugin.d.ts

@@ -1,5 +1,6 @@
 import { EditorView, ViewPlugin, type ViewUpdate } from "@codemirror/view";
 import type { StickyLine } from "./types";
+export declare const stickyScrollEffect: import("@codemirror/state").StateEffectType<true>;
 declare class StickyScrollPlugin {
     private readonly dom;
     private readonly inner;

package/dist/plugin.js

@@ -1,8 +1,10 @@
 import { language, syntaxTree } from "@codemirror/language";
 import { Direction, EditorView, ViewPlugin } from "@codemirror/view";
+import { StateEffect } from "@codemirror/state";
 import { getStickyContext } from "./compute";
 import { stickyScrollFacet } from "./facet";
 import { renderLineCode } from "./render";
+export const stickyScrollEffect = StateEffect.define();
 // ─────────────────────────────────────────────────────────────────────────────
 // Utilities
 // ─────────────────────────────────────────────────────────────────────────────
@@ -102,7 +104,8 @@ class StickyScrollPlugin {
         this.config = update.state.facet(stickyScrollFacet);
         const contentChanged = configChanged ||
             update.docChanged ||
-            syntaxTree(update.startState) !== syntaxTree(update.state);
+            syntaxTree(update.startState) !== syntaxTree(update.state) ||
+            update.transactions.some(({ effects }) => effects.some((e) => e.is(stickyScrollEffect)));
         if (contentChanged) {
             this.clearCache();
         }
@@ -330,4 +333,4 @@ class StickyScrollPlugin {
         return semiTransparent;
     }
 }
-export const scrollStickyPlugin = ViewPlugin.fromClass(StickyScrollPlugin, {});
+export const scrollStickyPlugin = /* #__PURE__ */ ViewPlugin.fromClass(StickyScrollPlugin, {});

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.1",
+	"version": "0.3.0",
 	"description": "VS Code / Monaco-style sticky scroll (sticky lines) extension for CodeMirror 6",
 	"keywords": [
 		"codemirror",
@@ -32,7 +32,8 @@
 		"lint:md": "markdownlint-cli2 '**/*.md'",
 		"lint:css": "stylelint --cache '**/*.css'",
 		"lint": "npm run lint:ts && npm run lint:css && npm run lint:md",
-		"build": "tsc && eslint --no-inline-config --no-config-lookup -c eslint.dist.js dist/*.js"
+		"build": "tsc && eslint --no-inline-config --no-config-lookup -c eslint.dist.js dist/*.js",
+		"test": "echo 'This package has no tests.'"
 	},
 	"peerDependencies": {
 		"@codemirror/language": "^6.3.0",
@@ -40,13 +41,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.10.0",
-		"markdownlint-cli2": "^0.23.2",
-		"stylelint": "^17.15.0",
+		"@codemirror/state": "^6.7.6",
+		"@codemirror/view": "^6.43.13",
+		"eslint": "^10.12.0",
+		"markdownlint-cli2": "^0.23.3",
+		"stylelint": "^17.16.0",
 		"typescript": "^6.0.3"
 	}
 }