@typbase/codemirror 0.3.1 → 0.3.2

package/dist/index.d.mts

@@ -20,7 +20,7 @@ export interface NotebookCell {
 }
 /** Per-cell state the host owns: run counters and visibility. */
 export interface NotebookCellState {
-  /** Execution counter shown as `[n]`; undefined until the cell is run. */
+  /** Execution counter shown as `[n]`. Undefined until the cell is run. */
   count?: number;
   /** Output hidden until the next run. */
   cleared?: boolean;
@@ -47,7 +47,7 @@ export interface NotebookCompileResult {
   diagnostics: TypstDiagnostic[];
 }
 export interface NotebookOptions {
-  /** Cells for a document text; the host reads them from the engine. */
+  /** Cells for a document text. The host reads them from the engine. */
   cells: (text: string) => NotebookCell[];
   /** Run/visibility state per cell index. */
   state?: (index: number) => NotebookCellState | undefined;
@@ -58,7 +58,7 @@ export interface NotebookOptions {
   onCells?: (cells: NotebookCell[]) => void;
   /** Fires when the cursor moves to a different cell. */
   onActiveCell?: (index: number | null) => void;
-  /** Fires after every compile that ran; `run` carries the requested cell. */
+  /** Fires after every compile that ran. `run` carries the requested cell. */
   onRun?: (index: number | "all") => void;
   /** Fires after a compile with the fresh frames and diagnostics. */
   onCompile?: (result: NotebookCompileResult) => void;
@@ -79,7 +79,7 @@ export declare const notebookRunEffect: import("@codemirror/state").StateEffectT
 /** First position that belongs to the cell (marker line, or content). */
 export declare function cellStart(cell: NotebookCell): number;
 export declare function hasMarker(cell: NotebookCell): boolean;
-/** Index of the cell containing `pos`; gaps belong to the cell above. */
+/** Index of the cell containing `pos`. Gaps belong to the cell above. */
 export declare function cellIndexAt(cells: NotebookCell[], pos: number): number;
 export declare function cellsOf(state: EditorState): NotebookCell[];
 /** The marker line for a cell type. Markup is the unlabeled default. */
@@ -106,7 +106,7 @@ export declare function setCellTypeText(text: string, cells: NotebookCell[], ind
  * convention.
  */
 export declare function stripCellMarkers(text: string): string;
-/** Compiles and reports through `onRun`; does not move the cursor. */
+/** Compiles and reports through `onRun`, but does not move the cursor. */
 export declare function runCell(view: EditorView, index: number): boolean;
 export declare function runAllCells(view: EditorView): boolean;
 export declare function focusCell(view: EditorView, index: number, edge?: "start" | "end"): boolean;
@@ -152,15 +152,15 @@ export interface TypstPluginOptions {
   /**
    * Called when a compile into the wasm instance threw. On wasm32 a panic
    * aborts the instance, so the host must recreate `typstState` and remount
-   * the editor; the plugin drops the decorations for the failed pass.
+   * the editor. The plugin drops the decorations for the failed pass.
    */
   onPanic?: (fileId: FileId) => void;
-  /** Called after a compile pass succeeds; the host resets its health and
+  /** Called after a compile pass succeeds. The host resets its health and
    *  heap watchdog on it. */
   onCompile?: () => void;
   /**
    * Opens a link clicked inside a rendered frame. Defaults to a new browser
-   * tab; the app passes its Tauri-aware `openExternal`.
+   * tab. The app passes its Tauri-aware `openExternal`.
    */
   onExternalLink?: (url: string) => void;
   /**
@@ -209,14 +209,14 @@ export interface TypstLinterOptions {
  *
  * This runs in every editor mode and combines with other sources (the
  * spellcheck linter), so neither one replaces the other. The WYSIWYG plugin's
- * compile feeds the cache; split and source mode fall back to a compile here
+ * compile feeds the cache. Split and source mode fall back to a compile here
  * so they get diagnostics too.
  */
 export declare const typstLinter: (fileId: FileId, spaceId: string, path: string, prelude: TextRef, typstState: TypstState, options?: TypstLinterOptions) => import("@codemirror/state").Extension;
 //#endregion
 //#region src/frames.d.ts
 /**
- * Opens an external link for the host. Browsers get a new tab; the app passes
+ * Opens an external link for the host. Browsers get a new tab. The app passes
  * its `openExternal`, which hands the URL to the system browser in Tauri
  * (a webview has no tab strip, so `window.open` is dropped there).
  */
@@ -241,8 +241,8 @@ export declare function frameSize(frame: SvgRangedFrame): {
  * container keeps max-width: 100% so it never exceeds the line. An explicit
  * container width would make CodeMirror's flex layout grow the content width
  * forever (resize -> wider widget -> wider content). The pinned SVG overflows
- * the clamped container while the pane is narrower than the compiled width;
- * the scroller clips it, so the render stays its size instead of scaling.
+ * the clamped container while the pane is narrower than the compiled width.
+ * The scroller clips it, so the render stays its size instead of scaling.
  */
 export declare function syncFrameContainer(container: HTMLElement, frame: SvgRangedFrame): void;
 /** Fresh frame container for widgets that own their DOM (notebook outputs). */
@@ -266,7 +266,7 @@ export declare function frameIsInactive(view: EditorView, state: EditorState, st
  * the source stays visible with the frame's height reserved, so the pane does
  * not jump between render and source. Matches the inline WYSIWYG behavior.
  *
- * `lineHeights` carries measured source heights from the remeasure pass; when
+ * `lineHeights` carries measured source heights from the remeasure pass. When
  * it is absent the view still reports the widget's height for those lines.
  */
 export declare function frameActiveDecorations(view: EditorView, state: EditorState, frame: SvgRangedFrame, lineHeights?: Map<number, number>): Range<Decoration>[];
@@ -330,7 +330,7 @@ export interface TypstViewPluginOptions {
   revision?: () => string | number | undefined;
   /** See TypstPluginOptions#onPanic. */
   onPanic?: (fileId: FileId) => void;
-  /** Called after a compile pass succeeds; the host resets its health and
+  /** Called after a compile pass succeeds. The host resets its health and
    *  heap watchdog on it. */
   onCompile?: () => void;
   /** See TypstPluginOptions#onExternalLink. */

package/dist/index.mjs

@@ -599,7 +599,7 @@ function cellStart(cell) {
 function hasMarker(cell) {
 	return cell.marker_end > cell.marker_start;
 }
-/** Index of the cell containing `pos`; gaps belong to the cell above. */
+/** Index of the cell containing `pos`. Gaps belong to the cell above. */
 function cellIndexAt(cells, pos) {
 	let index = cells.length ? 0 : -1;
 	for (let i = 0; i < cells.length; i++) if (pos >= cellStart(cells[i])) index = i;
@@ -746,7 +746,7 @@ function dispatchEdit(view, edit) {
 	});
 	return true;
 }
-/** Compiles and reports through `onRun`; does not move the cursor. */
+/** Compiles and reports through `onRun`, but does not move the cursor. */
 function runCell(view, index) {
 	if (!notebookOptions(view.state) || index < 0) return false;
 	view.dispatch({ effects: notebookRunEffect.of({ index }) });
@@ -961,7 +961,7 @@ function toLintDiagnostics(typstDiagnostics) {
 *
 * This runs in every editor mode and combines with other sources (the
 * spellcheck linter), so neither one replaces the other. The WYSIWYG plugin's
-* compile feeds the cache; split and source mode fall back to a compile here
+* compile feeds the cache. Split and source mode fall back to a compile here
 * so they get diagnostics too.
 */
 const typstLinter = (fileId, spaceId, path, prelude, typstState, options = {}) => linter(async (view) => {
@@ -1012,8 +1012,8 @@ function frameSize(frame) {
 * container keeps max-width: 100% so it never exceeds the line. An explicit
 * container width would make CodeMirror's flex layout grow the content width
 * forever (resize -> wider widget -> wider content). The pinned SVG overflows
-* the clamped container while the pane is narrower than the compiled width;
-* the scroller clips it, so the render stays its size instead of scaling.
+* the clamped container while the pane is narrower than the compiled width.
+* The scroller clips it, so the render stays its size instead of scaling.
 */
 function syncFrameContainer(container, frame) {
 	const size = frameSize(frame);
@@ -1082,7 +1082,7 @@ function frameIsInactive(view, state, start, end) {
 * the source stays visible with the frame's height reserved, so the pane does
 * not jump between render and source. Matches the inline WYSIWYG behavior.
 *
-* `lineHeights` carries measured source heights from the remeasure pass; when
+* `lineHeights` carries measured source heights from the remeasure pass. When
 * it is absent the view still reports the widget's height for those lines.
 */
 function frameActiveDecorations(view, state, frame, lineHeights) {
@@ -1251,7 +1251,7 @@ var NotebookOutputWidget = class extends WidgetType {
 		this.args = args;
 		this.openExternal = openExternal;
 	}
-	/** Hash of everything the DOM depends on; DOM identity is expensive. */
+	/** Hash of everything the DOM depends on, since DOM identity is expensive. */
 	get key() {
 		const frames = this.args.frames.map((frame) => {
 			const size = frameSize(frame);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typbase/codemirror",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "CodeMirror 6 editing experience for Typst: WYSIWYG inline preview, highlighting, hover, autocomplete.",
   "keywords": [
     "atproto",
@@ -40,7 +40,7 @@
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@typbase/engine": "^0.3.1"
+    "@typbase/engine": "^0.3.2"
   },
   "scripts": {
     "build": "tsdown",