@motion-script/code 0.1.0

package/dist/highlighter.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 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.
+     */
+    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.
+     */
+    tokenize(code: string): string[];
+}
+//# sourceMappingURL=highlighter.d.ts.map

package/dist/highlighter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"highlighter.d.ts","sourceRoot":"","sources":["../src/highlighter.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;;;;;;;OAUG;IACH,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,OAAO;IACxC;;;;;;;;;;;;;OAaG;IACH,UAAU,IAAI,OAAO,CAAC;IAEtB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,CAAC;IAEzB;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,eAAe,CAAC;IAEpD;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CACpC"}

package/dist/highlighter.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=highlighter.js.map

package/dist/highlighter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"highlighter.js","sourceRoot":"","sources":["../src/highlighter.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './node';
+export * from './props';
+export { word, lines, range } from './code-range';
+export type { CodeRange } from './code-range';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAClD,YAAY,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from './node';
+export * from './props';
+export { word, lines, range } from './code-range';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC"}

package/dist/node.d.ts

@@ -0,0 +1,96 @@
+import type { CodeProps } from "./props";
+import { CodeRange } from "./code-range";
+import { RenderContext, EaseFunction, FrameGenerator, NodeConfig, Size2D, SizeConstraints, Node, MeasureScope, AssetTracker, PaddingResolved } from "@motion-script/core";
+export declare function initSyntaxHighlighter(themes?: string[], langs?: string[]): Promise<void>;
+export declare class Code extends Node<CodeProps> {
+    readonly code: string;
+    readonly language: string;
+    readonly fontFamily: string;
+    readonly theme: string;
+    readonly fontSize: number;
+    readonly lineHeight: number;
+    readonly letterSpacing: number;
+    readonly showLineNumbers: boolean;
+    readonly lineNumberGap: number;
+    readonly padding: PaddingResolved;
+    private tokenLines;
+    private tokenized;
+    private transitions;
+    private highlightDimOpacity;
+    private highlightedIds;
+    constructor(props: NodeConfig<Code, CodeProps>);
+    set(props: {
+        [K in keyof CodeProps]?: CodeProps[K] | (() => CodeProps[K]);
+    }): void;
+    private tokenize;
+    prepare(storage: AssetTracker): void;
+    private tokenAdvance;
+    private gutterGap;
+    private gutterWidth;
+    measure(constraints: SizeConstraints, scope: MeasureScope): Partial<Size2D>;
+    onRender(ctx: RenderContext): void;
+    append(code: string, duration: number, easing?: EaseFunction): FrameGenerator;
+    prepend(code: string, duration: number, easing?: EaseFunction): FrameGenerator;
+    /**
+     * Highlight a range of code: tokens within the range stay at opacity 1,
+     * tokens outside dim to `opacity`. Persistent — call resetHighlight() to
+     * undo, or call highlight() again with a different range to cross-fade.
+     */
+    highlight(codeRange: CodeRange, duration?: number, easing?: EaseFunction, opacity?: number): FrameGenerator;
+    /**
+     * Fade all dimmed tokens back to opacity 1 and clear the persistent
+     * highlight state.
+     */
+    resetHighlight(duration?: number, easing?: EaseFunction): FrameGenerator;
+    /**
+     * Replace the tokens in `codeRange` with `next`, cross-fading widths and
+     * opacities.
+     */
+    replace(codeRange: CodeRange, next: string, duration: number, easing?: EaseFunction): FrameGenerator;
+    /**
+     * Insert `code` at the given (line, col). Both are 1-indexed; col is the
+     * column BEFORE which the new content is inserted (col=1 means start of
+     * line). If `code` contains newlines, new lines are created in the middle
+     * of the existing line.
+     */
+    insert(position: [number, number], code: string, duration: number, easing?: EaseFunction): FrameGenerator;
+    /**
+     * Remove the tokens in `codeRange`. If the range spans whole lines, those
+     * lines collapse their height; partial line ranges only remove tokens
+     * (the surrounding text reflows).
+     */
+    remove(codeRange: CodeRange, duration: number, easing?: EaseFunction): FrameGenerator;
+    /**
+     * Find every range matching the literal string `text` in the current
+     * source. Multi-line matches are supported.
+     */
+    findAllRanges(text: string): CodeRange[];
+    /**
+     * Find the `index`th range matching `text`. Returns null if not found.
+     */
+    findRangeAt(text: string, index: number): CodeRange | null;
+    /**
+     * Find the first range matching `text`. Returns null if not found.
+     */
+    findFirstRange(text: string): CodeRange | null;
+    private runTransition;
+    private joinedSource;
+    private lineLengths;
+    /**
+     * Resolve a CodeRange to the set of token ids whose content overlaps the
+     * range. Tokens that partially overlap are included.
+     */
+    private tokenIdsInRange;
+    /**
+     * Resolve a CodeRange to a structural (fromLine, fromIdx)..(toLine, toIdx)
+     * token span. Snaps to whole tokens (any token that overlaps the range is
+     * included). Returns null if no tokens overlap.
+     */
+    private rangeToTokenSpan;
+    protected drawSelf(draw: RenderContext): void;
+    private isHighlightActive;
+    private lineHighlightOpacity;
+    private resolveTokenStates;
+    private resolveLineHeightScales;
+}
+//# sourceMappingURL=node.d.ts.map

package/dist/node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../src/node.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,EAAE,SAAS,EAAsB,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAc,MAAM,EAAE,eAAe,EAAE,IAAI,EAAS,YAAY,EAAE,YAAY,EAAE,eAAe,EAA4D,MAAM,qBAAqB,CAAC;AAoBvP,wBAAsB,qBAAqB,CACvC,MAAM,GAAE,MAAM,EAAoB,EAClC,KAAK,GAAE,MAAM,EAAmD,iBAGnE;AAkFD,qBAAa,IAAK,SAAQ,IAAI,CAAC,SAAS,CAAC;IAGrC,SAA4C,IAAI,EAAE,MAAM,CAAC;IACzD,SAAsD,QAAQ,EAAE,MAAM,CAAC;IACvE,SAA0D,UAAU,EAAE,MAAM,CAAC;IAC7E,SAAuD,KAAK,EAAE,MAAM,CAAC;IACrE,SAA4C,QAAQ,EAAE,MAAM,CAAC;IAC7D,SAA6C,UAAU,EAAE,MAAM,CAAC;IAMhE,SAA6C,aAAa,EAAE,MAAM,CAAC;IACnE,SAA+C,eAAe,EAAE,OAAO,CAAC;IAIxE,SAA2C,aAAa,EAAE,MAAM,CAAC;IACjE,SAAyF,OAAO,EAAE,eAAe,CAAC;IAElH,OAAO,CAAC,UAAU,CAAgB;IAClC,OAAO,CAAC,SAAS,CAAkB;IAEnC,OAAO,CAAC,WAAW,CAAoB;IAIvC,OAAO,CAAC,mBAAmB,CAAuB;IAClD,OAAO,CAAC,cAAc,CAA0B;gBAEpC,KAAK,EAAE,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC;IAS9C,GAAG,CAAC,KAAK,EAAE;SAAG,CAAC,IAAI,MAAM,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC;KAAE,GAAG,IAAI;IAOlF,OAAO,CAAC,QAAQ;IAOhB,OAAO,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;IAOpC,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,WAAW;IASV,OAAO,CAAC,WAAW,EAAE,eAAe,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAwCpF,QAAQ,CAAC,GAAG,EAAE,aAAa,GAAG,IAAI;IAQjC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,cAAc;IAqB7E,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,cAAc;IAqB/E;;;;OAIG;IACF,SAAS,CACN,SAAS,EAAE,SAAS,EACpB,QAAQ,GAAE,MAAY,EACtB,MAAM,CAAC,EAAE,YAAY,EACrB,OAAO,GAAE,MAAY,GACtB,cAAc;IAkCjB;;;OAGG;IACF,cAAc,CAAC,QAAQ,GAAE,MAAY,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,cAAc;IA6B9E;;;OAGG;IACF,OAAO,CACJ,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,YAAY,GACtB,cAAc;IAqEjB;;;;;OAKG;IACF,MAAM,CACH,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAC1B,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,YAAY,GACtB,cAAc;IAgHjB;;;;OAIG;IACF,MAAM,CACH,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,YAAY,GACtB,cAAc;IAyEjB;;;OAGG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE;IAexC;;OAEG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAK1D;;OAEG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAI9C,OAAO,CAAE,aAAa;IAqBtB,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,WAAW;IAMnB;;;OAGG;IACH,OAAO,CAAC,eAAe;IAwBvB;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IA8BxB,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI;IAmH7C,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,oBAAoB;IAW5B,OAAO,CAAC,kBAAkB;IA+B1B,OAAO,CAAC,uBAAuB;CAWlC"}