@twick/2d 0.13.0 → 0.14.2

package/src/lib/code/CodeDiffer.ts

@@ -1,78 +1,78 @@
-import type {CodeScope, CodeTag} from './CodeScope';
-import {resolveScope} from './CodeScope';
-import type {CodeTokenizer} from './CodeTokenizer';
-import {patienceDiff} from './diff';
-
-/**
- * A function that compares two code snippets and returns a list of
- * {@link CodeTag}s describing a transition between them.
- */
-export type CodeDiffer = (
-  /**
-   * The original code scope.
-   */
-  from: CodeScope,
-  /**
-   * The new code scope.
-   */
-  to: CodeScope,
-  /**
-   * The inherited tokenizer to use.
-   */
-  tokenize: CodeTokenizer,
-) => CodeTag[];
-
-/**
- * Default diffing function utilizing {@link code.patienceDiff}.
- *
- * @param from - The original code scope.
- * @param to - The new code scope.
- * @param tokenize - The inherited tokenizer to use.
- */
-export function defaultDiffer(
-  from: CodeScope,
-  to: CodeScope,
-  tokenize: CodeTokenizer,
-) {
-  const fromString = resolveScope(from, false);
-  const toString = resolveScope(to, true);
-
-  const diff = patienceDiff(tokenize(fromString), tokenize(toString));
-
-  const fragments: CodeTag[] = [];
-  let before = '';
-  let after = '';
-  let lastAdded = false;
-  const flush = () => {
-    if (before !== '' || after !== '') {
-      fragments.push({
-        before,
-        after,
-      });
-      before = '';
-      after = '';
-    }
-  };
-
-  for (const line of diff.lines) {
-    if (line.aIndex === -1) {
-      if (after !== '' && !lastAdded) {
-        flush();
-      }
-      lastAdded = true;
-      after += line.line;
-    } else if (line.bIndex === -1) {
-      if (before !== '' && lastAdded) {
-        flush();
-      }
-      lastAdded = false;
-      before += line.line;
-    } else {
-      flush();
-      fragments.push(line.line);
-    }
-  }
-  flush();
-
-  return fragments;
-}
+import type {CodeScope, CodeTag} from './CodeScope';
+import {resolveScope} from './CodeScope';
+import type {CodeTokenizer} from './CodeTokenizer';
+import {patienceDiff} from './diff';
+
+/**
+ * A function that compares two code snippets and returns a list of
+ * {@link CodeTag}s describing a transition between them.
+ */
+export type CodeDiffer = (
+  /**
+   * The original code scope.
+   */
+  from: CodeScope,
+  /**
+   * The new code scope.
+   */
+  to: CodeScope,
+  /**
+   * The inherited tokenizer to use.
+   */
+  tokenize: CodeTokenizer,
+) => CodeTag[];
+
+/**
+ * Default diffing function utilizing {@link code.patienceDiff}.
+ *
+ * @param from - The original code scope.
+ * @param to - The new code scope.
+ * @param tokenize - The inherited tokenizer to use.
+ */
+export function defaultDiffer(
+  from: CodeScope,
+  to: CodeScope,
+  tokenize: CodeTokenizer,
+) {
+  const fromString = resolveScope(from, false);
+  const toString = resolveScope(to, true);
+
+  const diff = patienceDiff(tokenize(fromString), tokenize(toString));
+
+  const fragments: CodeTag[] = [];
+  let before = '';
+  let after = '';
+  let lastAdded = false;
+  const flush = () => {
+    if (before !== '' || after !== '') {
+      fragments.push({
+        before,
+        after,
+      });
+      before = '';
+      after = '';
+    }
+  };
+
+  for (const line of diff.lines) {
+    if (line.aIndex === -1) {
+      if (after !== '' && !lastAdded) {
+        flush();
+      }
+      lastAdded = true;
+      after += line.line;
+    } else if (line.bIndex === -1) {
+      if (before !== '' && lastAdded) {
+        flush();
+      }
+      lastAdded = false;
+      before += line.line;
+    } else {
+      flush();
+      fragments.push(line.line);
+    }
+  }
+  flush();
+
+  return fragments;
+}

package/src/lib/code/CodeFragment.ts

@@ -1,97 +1,97 @@
-import type {CodeMetrics} from './CodeMetrics';
-import {isCodeMetrics, measureString} from './CodeMetrics';
-
-export interface CodeFragment {
-  before: CodeMetrics;
-  after: CodeMetrics;
-}
-export interface RawCodeFragment {
-  before: string;
-  after: string;
-}
-
-export type PossibleCodeFragment =
-  | CodeFragment
-  | CodeMetrics
-  | RawCodeFragment
-  | string;
-
-export function metricsToFragment(value: CodeMetrics): CodeFragment {
-  return {
-    before: value,
-    after: value,
-  };
-}
-
-export function parseCodeFragment(
-  value: PossibleCodeFragment,
-  context: CanvasRenderingContext2D,
-  monoWidth: number,
-): CodeFragment {
-  let fragment: CodeFragment;
-  if (typeof value === 'string') {
-    fragment = metricsToFragment(measureString(context, monoWidth, value));
-  } else if (isCodeMetrics(value)) {
-    fragment = metricsToFragment(value);
-  } else {
-    fragment = {
-      before:
-        typeof value.before === 'string'
-          ? measureString(context, monoWidth, value.before)
-          : value.before,
-      after:
-        typeof value.after === 'string'
-          ? measureString(context, monoWidth, value.after)
-          : value.after,
-    };
-  }
-
-  return fragment;
-}
-
-/**
- * Create a code fragment that represents an insertion of code.
- *
- * @remarks
- * Can be used in conjunction with {@link code.CodeSignalHelpers.edit}.
- *
- * @param code - The code to insert.
- */
-export function insert(code: string): RawCodeFragment {
-  return {
-    before: '',
-    after: code,
-  };
-}
-
-/**
- * Create a code fragment that represents a change from one piece of code to
- * another.
- *
- * @remarks
- * Can be used in conjunction with {@link code.CodeSignalHelpers.edit}.
- *
- * @param before - The code to change from.
- * @param after - The code to change to.
- */
-export function replace(before: string, after: string): RawCodeFragment {
-  return {
-    before,
-    after,
-  };
-}
-
-/**
- * Create a code fragment that represents a removal of code.
- *
- * @remarks
- * Can be used in conjunction with {@link code.CodeSignalHelpers.edit}.
- *
- * @param code - The code to remove.
- */
-export function remove(code: string): RawCodeFragment {
-  return {
-    before: code,
-    after: '',
-  };
-}
+import type {CodeMetrics} from './CodeMetrics';
+import {isCodeMetrics, measureString} from './CodeMetrics';
+
+export interface CodeFragment {
+  before: CodeMetrics;
+  after: CodeMetrics;
+}
+export interface RawCodeFragment {
+  before: string;
+  after: string;
+}
+
+export type PossibleCodeFragment =
+  | CodeFragment
+  | CodeMetrics
+  | RawCodeFragment
+  | string;
+
+export function metricsToFragment(value: CodeMetrics): CodeFragment {
+  return {
+    before: value,
+    after: value,
+  };
+}
+
+export function parseCodeFragment(
+  value: PossibleCodeFragment,
+  context: CanvasRenderingContext2D,
+  monoWidth: number,
+): CodeFragment {
+  let fragment: CodeFragment;
+  if (typeof value === 'string') {
+    fragment = metricsToFragment(measureString(context, monoWidth, value));
+  } else if (isCodeMetrics(value)) {
+    fragment = metricsToFragment(value);
+  } else {
+    fragment = {
+      before:
+        typeof value.before === 'string'
+          ? measureString(context, monoWidth, value.before)
+          : value.before,
+      after:
+        typeof value.after === 'string'
+          ? measureString(context, monoWidth, value.after)
+          : value.after,
+    };
+  }
+
+  return fragment;
+}
+
+/**
+ * Create a code fragment that represents an insertion of code.
+ *
+ * @remarks
+ * Can be used in conjunction with {@link code.CodeSignalHelpers.edit}.
+ *
+ * @param code - The code to insert.
+ */
+export function insert(code: string): RawCodeFragment {
+  return {
+    before: '',
+    after: code,
+  };
+}
+
+/**
+ * Create a code fragment that represents a change from one piece of code to
+ * another.
+ *
+ * @remarks
+ * Can be used in conjunction with {@link code.CodeSignalHelpers.edit}.
+ *
+ * @param before - The code to change from.
+ * @param after - The code to change to.
+ */
+export function replace(before: string, after: string): RawCodeFragment {
+  return {
+    before,
+    after,
+  };
+}
+
+/**
+ * Create a code fragment that represents a removal of code.
+ *
+ * @remarks
+ * Can be used in conjunction with {@link code.CodeSignalHelpers.edit}.
+ *
+ * @param code - The code to remove.
+ */
+export function remove(code: string): RawCodeFragment {
+  return {
+    before: code,
+    after: '',
+  };
+}

package/src/lib/code/CodeHighlighter.ts

@@ -1,75 +1,75 @@
-/**
- * Describes the result of a highlight operation.
- */
-export interface HighlightResult {
-  /**
-   * The color of the code at the given index.
-   */
-  color: string | null;
-
-  /**
-   * The number of characters to skip ahead.
-   *
-   * @remarks
-   * This should be used to skip to the end of the currently highlighted token.
-   * The returned style will be used for the skipped characters, and they will
-   * be drawn as one continuous string keeping emojis and ligatures intact.
-   *
-   * The returned value is the number of characters to skip ahead, not the
-   * index of the end of the token.
-   */
-  skipAhead: number;
-}
-
-/**
- * Describes custom highlighters used by the Code node.
- *
- * @typeParam T - The type of the cache used by the highlighter.
- */
-export interface CodeHighlighter<T = unknown> {
-  /**
-   * Initializes the highlighter.
-   *
-   * @remarks
-   * This method is called when collecting async resources for the node.
-   * It can be called multiple times so caching the initialization is
-   * recommended.
-   *
-   * If initialization is asynchronous, a promise should be registered using
-   * {@link DependencyContext.collectPromise} and the value of `false` should
-   * be returned. The hook will be called again when the promise resolves.
-   * This process can be repeated until the value of `true` is returned which
-   * will mark the highlighter as ready.
-   */
-  initialize(): boolean;
-
-  /**
-   * Prepares the code for highlighting.
-   *
-   * @remarks
-   * This method is called each time the code changes. It can be used to do
-   * any preprocessing of the code before highlighting. The result of this
-   * method is cached and passed to {@link highlight} when the code is
-   * highlighted.
-   *
-   * @param code - The code to prepare.
-   * @param dialect - The language in which the code is written.
-   */
-  prepare(code: string): T;
-
-  /**
-   * Highlights the code at the given index.
-   *
-   * @param index - The index of the code to highlight.
-   * @param cache - The result of {@link prepare}.
-   */
-  highlight(index: number, cache: T): HighlightResult;
-
-  /**
-   * Tokenize the code.
-   *
-   * @param code - The code to tokenize.
-   * @param dialect - The language in which the code is written.
-   */
-  tokenize(code: string): string[];
-}
+/**
+ * Describes the result of a highlight operation.
+ */
+export interface HighlightResult {
+  /**
+   * The color of the code at the given index.
+   */
+  color: string | null;
+
+  /**
+   * The number of characters to skip ahead.
+   *
+   * @remarks
+   * This should be used to skip to the end of the currently highlighted token.
+   * The returned style will be used for the skipped characters, and they will
+   * be drawn as one continuous string keeping emojis and ligatures intact.
+   *
+   * The returned value is the number of characters to skip ahead, not the
+   * index of the end of the token.
+   */
+  skipAhead: number;
+}
+
+/**
+ * Describes custom highlighters used by the Code node.
+ *
+ * @typeParam T - The type of the cache used by the highlighter.
+ */
+export interface CodeHighlighter<T = unknown> {
+  /**
+   * Initializes the highlighter.
+   *
+   * @remarks
+   * This method is called when collecting async resources for the node.
+   * It can be called multiple times so caching the initialization is
+   * recommended.
+   *
+   * If initialization is asynchronous, a promise should be registered using
+   * {@link DependencyContext.collectPromise} and the value of `false` should
+   * be returned. The hook will be called again when the promise resolves.
+   * This process can be repeated until the value of `true` is returned which
+   * will mark the highlighter as ready.
+   */
+  initialize(): boolean;
+
+  /**
+   * Prepares the code for highlighting.
+   *
+   * @remarks
+   * This method is called each time the code changes. It can be used to do
+   * any preprocessing of the code before highlighting. The result of this
+   * method is cached and passed to {@link highlight} when the code is
+   * highlighted.
+   *
+   * @param code - The code to prepare.
+   * @param dialect - The language in which the code is written.
+   */
+  prepare(code: string): T;
+
+  /**
+   * Highlights the code at the given index.
+   *
+   * @param index - The index of the code to highlight.
+   * @param cache - The result of {@link prepare}.
+   */
+  highlight(index: number, cache: T): HighlightResult;
+
+  /**
+   * Tokenize the code.
+   *
+   * @param code - The code to tokenize.
+   * @param dialect - The language in which the code is written.
+   */
+  tokenize(code: string): string[];
+}

package/src/lib/code/CodeMetrics.ts

@@ -1,47 +1,47 @@
-export interface CodeMetrics {
-  content: string;
-  newRows: number;
-  endColumn: number;
-  firstWidth: number;
-  maxWidth: number;
-  lastWidth: number;
-}
-
-export function measureString(
-  context: CanvasRenderingContext2D,
-  monoWidth: number,
-  value: string,
-): CodeMetrics {
-  const lines = value.split('\n');
-  const lastLine = lines[lines.length - 1];
-  const firstWidth = Math.round(
-    context.measureText(lines[0]).width / monoWidth,
-  );
-  let lastWidth = firstWidth;
-  let maxWidth = firstWidth;
-
-  for (let i = 1; i < lines.length; i++) {
-    const line = lines[i];
-    const width = Math.round(context.measureText(line).width / monoWidth);
-    if (width > maxWidth) {
-      maxWidth = width;
-    }
-  }
-
-  if (lines.length > 0) {
-    lastWidth = Math.round(context.measureText(lastLine).width / monoWidth);
-  }
-
-  return {
-    content: value,
-    newRows: lines.length - 1,
-    endColumn: lastLine.length,
-    firstWidth,
-    maxWidth,
-    lastWidth,
-  };
-}
-
-export function isCodeMetrics(value: any): value is CodeMetrics {
-  return value?.content !== undefined;
-}
+export interface CodeMetrics {
+  content: string;
+  newRows: number;
+  endColumn: number;
+  firstWidth: number;
+  maxWidth: number;
+  lastWidth: number;
+}
+
+export function measureString(
+  context: CanvasRenderingContext2D,
+  monoWidth: number,
+  value: string,
+): CodeMetrics {
+  const lines = value.split('\n');
+  const lastLine = lines[lines.length - 1];
+  const firstWidth = Math.round(
+    context.measureText(lines[0]).width / monoWidth,
+  );
+  let lastWidth = firstWidth;
+  let maxWidth = firstWidth;
+
+  for (let i = 1; i < lines.length; i++) {
+    const line = lines[i];
+    const width = Math.round(context.measureText(line).width / monoWidth);
+    if (width > maxWidth) {
+      maxWidth = width;
+    }
+  }
+
+  if (lines.length > 0) {
+    lastWidth = Math.round(context.measureText(lastLine).width / monoWidth);
+  }
+
+  return {
+    content: value,
+    newRows: lines.length - 1,
+    endColumn: lastLine.length,
+    firstWidth,
+    maxWidth,
+    lastWidth,
+  };
+}
+
+export function isCodeMetrics(value: any): value is CodeMetrics {
+  return value?.content !== undefined;
+}