@jupyterlab/codemirror 4.0.0-alpha.2 → 4.0.0-alpha.20

package/lib/theme.js

@@ -0,0 +1,194 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { defaultHighlightStyle, HighlightStyle, syntaxHighlighting } from '@codemirror/language';
+import { EditorView } from '@codemirror/view';
+import { nullTranslator } from '@jupyterlab/translation';
+import { tags as t } from '@lezer/highlight';
+export const jupyterEditorTheme = EditorView.theme({
+    /**
+     * CodeMirror themes are handling the background/color in this way. This works
+     * fine for CodeMirror editors outside the notebook, but the notebook styles
+     * these things differently.
+     */
+    '&': {
+        background: 'var(--jp-layout-color0)',
+        color: 'var(--jp-content-font-color1)'
+    },
+    /* In the notebook, we want this styling to be handled by its container */
+    '.jp-CodeConsole &, .jp-Notebook &': {
+        background: 'transparent'
+    },
+    '.cm-content': {
+        caretColor: 'var(--jp-editor-cursor-color)'
+    },
+    '.cm-cursor, .cm-dropCursor': {
+        borderLeft: 'var(--jp-code-cursor-width0) solid var(--jp-editor-cursor-color)'
+    },
+    '.cm-selectionBackground, .cm-content ::selection': {
+        backgroundColor: 'var(--jp-editor-selected-background)'
+    },
+    '&.cm-focused .cm-selectionBackground': {
+        backgroundColor: 'var(--jp-editor-selected-focused-background)'
+    },
+    '.cm-gutters': {
+        borderRight: '1px solid var(--jp-border-color2)',
+        backgroundColor: 'var(--jp-layout-color2)'
+    },
+    '.cm-gutter, .cm-activeLine': {
+        backgroundColor: 'var(--jp-layout-color2)'
+    },
+    '.cm-searchMatch': {
+        backgroundColor: 'var(--jp-search-unselected-match-background-color)',
+        color: 'var(--jp-search-unselected-match-color)'
+    },
+    '.cm-searchMatch.cm-searchMatch-selected': {
+        backgroundColor: 'var(--jp-search-selected-match-background-color) !important',
+        color: 'var(--jp-search-selected-match-color) !important'
+    }
+});
+// The list of available tags for syntax highlighting is available at
+// https://lezer.codemirror.net/docs/ref/#highlight.tags
+export const jupyterHighlightStyle = HighlightStyle.define([
+    // Order matters - a rule will override the previous ones; important for example for in headings styles.
+    { tag: t.meta, color: 'var(--jp-mirror-editor-meta-color)' },
+    { tag: t.heading, color: 'var(--jp-mirror-editor-header-color)' },
+    {
+        tag: [t.heading1, t.heading2, t.heading3, t.heading4],
+        color: 'var(--jp-mirror-editor-header-color)',
+        fontWeight: 'bold'
+    },
+    {
+        tag: t.keyword,
+        color: 'var(--jp-mirror-editor-keyword-color)',
+        fontWeight: 'bold'
+    },
+    { tag: t.atom, color: 'var(--jp-mirror-editor-atom-color)' },
+    { tag: t.number, color: 'var(--jp-mirror-editor-number-color)' },
+    {
+        tag: [t.definition(t.name), t.function(t.definition(t.variableName))],
+        color: 'var(--jp-mirror-editor-def-color)'
+    },
+    {
+        tag: t.standard(t.variableName),
+        color: 'var(--jp-mirror-editor-builtin-color)'
+    },
+    {
+        tag: [t.special(t.variableName), t.self],
+        color: 'var(--jp-mirror-editor-variable-2-color)'
+    },
+    { tag: t.punctuation, color: 'var(--jp-mirror-editor-punctuation-color)' },
+    { tag: t.propertyName, color: 'var(--jp-mirror-editor-property-color)' },
+    {
+        tag: t.operator,
+        color: 'var(--jp-mirror-editor-operator-color)',
+        fontWeight: 'bold'
+    },
+    {
+        tag: t.comment,
+        color: 'var(--jp-mirror-editor-comment-color)',
+        fontStyle: 'italic'
+    },
+    { tag: t.string, color: 'var(--jp-mirror-editor-string-color)' },
+    {
+        tag: [t.labelName, t.monospace, t.special(t.string)],
+        color: 'var(--jp-mirror-editor-string-2-color)'
+    },
+    { tag: t.bracket, color: 'var(--jp-mirror-editor-bracket-color)' },
+    { tag: t.tagName, color: 'var(--jp-mirror-editor-tag-color)' },
+    { tag: t.attributeName, color: 'var(--jp-mirror-editor-attribute-color)' },
+    { tag: t.quote, color: 'var(--jp-mirror-editor-quote-color)' },
+    {
+        tag: t.link,
+        color: 'var(--jp-mirror-editor-link-color)',
+        textDecoration: 'underline'
+    },
+    { tag: [t.separator, t.derefOperator, t.paren], color: '' },
+    { tag: t.strong, fontWeight: 'bold' },
+    { tag: t.emphasis, fontStyle: 'italic' },
+    { tag: t.strikethrough, textDecoration: 'line-through' }
+]);
+/**
+ * JupyterLab CodeMirror 6 theme
+ */
+export const jupyterTheme = [
+    jupyterEditorTheme,
+    syntaxHighlighting(jupyterHighlightStyle)
+];
+/**
+ * CodeMirror 6 theme registry
+ */
+export class EditorThemeRegistry {
+    constructor() {
+        /**
+         * CodeMirror 6 themes
+         */
+        this._themeMap = new Map([
+            ['jupyter', Object.freeze({ name: 'jupyter', theme: jupyterTheme })]
+        ]);
+    }
+    /**
+     * Get all themes
+     */
+    get themes() {
+        return Array.from(this._themeMap.values());
+    }
+    /**
+     * Get the default CodeMirror 6 theme for JupyterLab
+     *
+     * @returns Default theme
+     */
+    defaultTheme() {
+        return this._themeMap.get('jupyter').theme;
+    }
+    /**
+     * Register a new theme.
+     *
+     * @param theme Codemirror 6 theme
+     */
+    addTheme(theme) {
+        if (this._themeMap.has(theme.name)) {
+            throw new Error(`A theme named '${theme.name}' is already registered.`);
+        }
+        this._themeMap.set(theme.name, { displayName: theme.name, ...theme });
+    }
+    /**
+     * Get a theme.
+     *
+     * #### Notes
+     * It falls back to the default theme
+     *
+     * @param name Theme name
+     * @returns Theme extension
+     */
+    getTheme(name) {
+        var _a;
+        const ext = (_a = this._themeMap.get(name)) === null || _a === void 0 ? void 0 : _a.theme;
+        return ext !== null && ext !== void 0 ? ext : this.defaultTheme();
+    }
+}
+/**
+ * EditorThemeRegistry namespace
+ */
+(function (EditorThemeRegistry) {
+    /**
+     * Get the default editor themes.
+     *
+     * @param translator Application translator
+     * @returns Default CodeMirror 6 themes
+     */
+    function getDefaultThemes(translator) {
+        const trans = (translator !== null && translator !== void 0 ? translator : nullTranslator).load('jupyterlab');
+        return [
+            Object.freeze({
+                name: 'codemirror',
+                displayName: trans.__('codemirror'),
+                theme: [
+                    EditorView.baseTheme({}),
+                    syntaxHighlighting(defaultHighlightStyle)
+                ]
+            })
+        ];
+    }
+    EditorThemeRegistry.getDefaultThemes = getDefaultThemes;
+})(EditorThemeRegistry || (EditorThemeRegistry = {}));
+//# sourceMappingURL=theme.js.map

package/lib/theme.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme.js","sourceRoot":"","sources":["../src/theme.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,OAAO,EACL,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EACnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAe,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,IAAI,IAAI,CAAC,EAAE,MAAM,kBAAkB,CAAC;AAG7C,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC,KAAK,CAAC;IACjD;;;;OAIG;IACH,GAAG,EAAE;QACH,UAAU,EAAE,yBAAyB;QACrC,KAAK,EAAE,+BAA+B;KACvC;IAED,0EAA0E;IAC1E,mCAAmC,EAAE;QACnC,UAAU,EAAE,aAAa;KAC1B;IAED,aAAa,EAAE;QACb,UAAU,EAAE,+BAA+B;KAC5C;IAED,4BAA4B,EAAE;QAC5B,UAAU,EACR,kEAAkE;KACrE;IAED,kDAAkD,EAAE;QAClD,eAAe,EAAE,sCAAsC;KACxD;IAED,sCAAsC,EAAE;QACtC,eAAe,EAAE,8CAA8C;KAChE;IAED,aAAa,EAAE;QACb,WAAW,EAAE,mCAAmC;QAChD,eAAe,EAAE,yBAAyB;KAC3C;IAED,4BAA4B,EAAE;QAC5B,eAAe,EAAE,yBAAyB;KAC3C;IAED,iBAAiB,EAAE;QACjB,eAAe,EAAE,oDAAoD;QACrE,KAAK,EAAE,yCAAyC;KACjD;IAED,yCAAyC,EAAE;QACzC,eAAe,EACb,6DAA6D;QAC/D,KAAK,EAAE,kDAAkD;KAC1D;CACF,CAAC,CAAC;AAEH,qEAAqE;AACrE,wDAAwD;AACxD,MAAM,CAAC,MAAM,qBAAqB,GAAG,cAAc,CAAC,MAAM,CAAC;IACzD,wGAAwG;IACxG,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,oCAAoC,EAAE;IAC5D,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,sCAAsC,EAAE;IACjE;QACE,GAAG,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC;QACrD,KAAK,EAAE,sCAAsC;QAC7C,UAAU,EAAE,MAAM;KACnB;IACD;QACE,GAAG,EAAE,CAAC,CAAC,OAAO;QACd,KAAK,EAAE,uCAAuC;QAC9C,UAAU,EAAE,MAAM;KACnB;IACD,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,oCAAoC,EAAE;IAC5D,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,sCAAsC,EAAE;IAChE;QACE,GAAG,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;QACrE,KAAK,EAAE,mCAAmC;KAC3C;IACD;QACE,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;QAC/B,KAAK,EAAE,uCAAuC;KAC/C;IACD;QACE,GAAG,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC;QACxC,KAAK,EAAE,0CAA0C;KAClD;IACD,EAAE,GAAG,EAAE,CAAC,CAAC,WAAW,EAAE,KAAK,EAAE,2CAA2C,EAAE;IAC1E,EAAE,GAAG,EAAE,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,wCAAwC,EAAE;IACxE;QACE,GAAG,EAAE,CAAC,CAAC,QAAQ;QACf,KAAK,EAAE,wCAAwC;QAC/C,UAAU,EAAE,MAAM;KACnB;IACD;QACE,GAAG,EAAE,CAAC,CAAC,OAAO;QACd,KAAK,EAAE,uCAAuC;QAC9C,SAAS,EAAE,QAAQ;KACpB;IACD,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,sCAAsC,EAAE;IAChE;QACE,GAAG,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACpD,KAAK,EAAE,wCAAwC;KAChD;IACD,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,uCAAuC,EAAE;IAClE,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,mCAAmC,EAAE;IAC9D,EAAE,GAAG,EAAE,CAAC,CAAC,aAAa,EAAE,KAAK,EAAE,yCAAyC,EAAE;IAC1E,EAAE,GAAG,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,qCAAqC,EAAE;IAC9D;QACE,GAAG,EAAE,CAAC,CAAC,IAAI;QACX,KAAK,EAAE,oCAAoC;QAC3C,cAAc,EAAE,WAAW;KAC5B;IACD,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;IAC3D,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE;IACrC,EAAE,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE;IACxC,EAAE,GAAG,EAAE,CAAC,CAAC,aAAa,EAAE,cAAc,EAAE,cAAc,EAAE;CACzD,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAc;IACrC,kBAAkB;IAClB,kBAAkB,CAAC,qBAAqB,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAAhC;QACE;;WAEG;QACK,cAAS,GAA8B,IAAI,GAAG,CAAC;YACrD,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;SACrE,CAAC,CAAC;IA4CL,CAAC;IA1CC;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAE,CAAC,KAAK,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,KAAmB;QAC1B,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,kBAAkB,KAAK,CAAC,IAAI,0BAA0B,CAAC,CAAC;SACzE;QACD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAY;;QACnB,MAAM,GAAG,GAAG,MAAA,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,0CAAE,KAAK,CAAC;QAE5C,OAAO,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,IAAI,CAAC,YAAY,EAAE,CAAC;IACpC,CAAC;CACF;AAED;;GAEG;AACH,WAAiB,mBAAmB;IAClC;;;;;OAKG;IACH,SAAgB,gBAAgB,CAC9B,UAA+B;QAE/B,MAAM,KAAK,GAAG,CAAC,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,cAAc,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAChE,OAAO;YACL,MAAM,CAAC,MAAM,CAAC;gBACZ,IAAI,EAAE,YAAY;gBAClB,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC;gBACnC,KAAK,EAAE;oBACL,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;oBACxB,kBAAkB,CAAC,qBAAqB,CAAC;iBAC1C;aACF,CAAC;SACH,CAAC;IACJ,CAAC;IAde,oCAAgB,mBAc/B,CAAA;AACH,CAAC,EAtBgB,mBAAmB,KAAnB,mBAAmB,QAsBnC"}

package/lib/token.d.ts

@@ -0,0 +1,375 @@
+import type { LanguageSupport } from '@codemirror/language';
+import type { Extension, StateEffect } from '@codemirror/state';
+import type { EditorView } from '@codemirror/view';
+import type { CodeEditor } from '@jupyterlab/codeeditor';
+import type { ITranslator } from '@jupyterlab/translation';
+import { ReadonlyJSONObject, Token } from '@lumino/coreutils';
+import type { IDisposable } from '@lumino/disposable';
+import type { ISignal } from '@lumino/signaling';
+/**
+ * Dynamically configurable editor extension interface.
+ */
+export interface IConfigurableExtension<T> {
+    /**
+     * Create an editor extension for the provided value.
+     *
+     * @param value Editor extension parameter value
+     * @returns The editor extension
+     */
+    instance(value: T): Extension;
+    /**
+     * Reconfigure an editor extension.
+     *
+     * ### Notes
+     * Return `null` if the value does not trigger
+     * a state effect. In particular for immutable extension.
+     *
+     * @param value Editor extension value
+     * @returns Editor state effect
+     */
+    reconfigure(value: T): StateEffect<T> | null;
+}
+/**
+ * Editor language token.
+ */
+export declare const IEditorExtensionRegistry: Token<IEditorExtensionRegistry>;
+/**
+ * Interface of CodeMirror editor extensions handler
+ *
+ * ### Notes
+ * This handler is instantiated for each editor to manage its own
+ * set of extensions.
+ */
+export interface IExtensionsHandler extends IDisposable {
+    /**
+     * Signal triggered when the editor configuration changes.
+     * It provides the mapping of the new configuration (only those that changed).
+     *
+     * It should result in a call to `IExtensionsHandler.reconfigureExtensions`.
+     */
+    readonly configChanged: ISignal<this, Record<string, any>>;
+    /**
+     * Get a config option for the editor.
+     */
+    getOption(option: string): unknown;
+    /**
+     * Whether the option exists or not.
+     */
+    hasOption(option: string): boolean;
+    /**
+     * Set a config option for the editor.
+     *
+     * You will need to reconfigure the editor extensions by listening
+     * to `IExtensionsHandler.configChanged`.
+     */
+    setOption(option: string, value: unknown): void;
+    /**
+     * Set config options for the editor.
+     *
+     * You will need to reconfigure the editor extensions by listening
+     * to `IExtensionsHandler.configChanged`.
+     *
+     * This method is preferred when setting several options. The
+     * options are set within an operation, which only performs
+     * the costly update at the end, and not after every option
+     * is set.
+     */
+    setOptions(options: Record<string, any>): void;
+    /**
+     * Returns the list of initial extensions of an editor.
+     *
+     * @returns The initial editor extensions
+     */
+    getInitialExtensions(): Extension[];
+    /**
+     * Appends extensions to the top-level configuration of the
+     * editor.
+     *
+     * @alpha
+     * @param view Editor view
+     * @param extension Editor extension to inject
+     */
+    injectExtension(view: EditorView, extension: Extension): void;
+    /**
+     * Reconfigures the extension mapped with key with the provided value.
+     *
+     * @param view Editor view
+     * @param key Parameter unique key
+     * @param value Parameter value to be applied
+     */
+    reconfigureExtension<T>(view: EditorView, key: string, value: T): void;
+    /**
+     * Reconfigures all the extensions mapped with the options from the
+     * provided partial configuration.
+     *
+     * @param view Editor view
+     * @param configuration Editor configuration
+     */
+    reconfigureExtensions(view: EditorView, configuration: Record<string, any>): void;
+}
+/**
+ * Editor extension factory interface.
+ *
+ * @template T Extension parameter type.
+ */
+export interface IEditorExtensionFactory<T = undefined> {
+    /**
+     * Editor extension unique identifier.
+     */
+    readonly name: string;
+    /**
+     * Extension factory.
+     *
+     * @param options
+     * @returns The extension builder or null if the extension is not active for that document
+     */
+    readonly factory: (options: IEditorExtensionFactory.IOptions) => IConfigurableExtension<T> | null;
+    /**
+     * Extension default value
+     *
+     * ### Notes
+     * If undefined but has a schema, the default value will be `null` to be JSON serializable.
+     */
+    readonly default?: T;
+    /**
+     * JSON schema defining the configurable option through user settings.
+     *
+     * If this is defined, every time the setting changes, `IConfigurableExtension.reconfigure`
+     * will be called with the new setting value.
+     *
+     * ### Notes
+     * If no default value is provided, `IEditorExtensionFactory.default` will be used.
+     * If the extension is to be handled by the code only, this should not be defined.
+     */
+    readonly schema?: ReadonlyJSONObject;
+}
+/**
+ * CodeMirror extension factory namespace
+ */
+export declare namespace IEditorExtensionFactory {
+    /**
+     * CodeMirror extension factory options
+     */
+    interface IOptions {
+        /**
+         * Whether the editor will be inline or not.
+         */
+        inline: boolean;
+        /**
+         * The model used by the editor.
+         */
+        model: CodeEditor.IModel;
+    }
+}
+/**
+ * Interface for generating editor configuration registry.
+ */
+export interface IEditorExtensionRegistry {
+    /**
+     * Base editor configuration
+     *
+     * This is the default configuration.
+     */
+    readonly baseConfiguration: Record<string, any>;
+    /**
+     * Add a default editor extension
+     *
+     * @template T Extension parameter type
+     * @param factory Extension factory
+     */
+    addExtension<T>(factory: IEditorExtensionFactory<T>): void;
+    /**
+     * Create a new extensions handler for an editor
+     *
+     * @param options Extensions options and initial editor configuration
+     */
+    createNew(options: IEditorExtensionFactory.IOptions & {
+        /**
+         * The configuration options for the editor.
+         */
+        config?: Record<string, any>;
+    }): IExtensionsHandler;
+}
+/**
+ * Editor factory constructor options
+ */
+export interface IEditorFactoryOptions {
+    /**
+     * Editor extensions registry
+     */
+    extensions?: IEditorExtensionRegistry;
+    /**
+     * Editor languages registry
+     */
+    languages?: IEditorLanguageRegistry;
+    /**
+     * Application translation registry
+     */
+    translator?: ITranslator;
+}
+/**
+ * Editor language token.
+ */
+export declare const IEditorLanguageRegistry: Token<IEditorLanguageRegistry>;
+/**
+ * The interface of a codemirror language specification.
+ */
+export interface IEditorLanguage {
+    /**
+     * Language name.
+     */
+    readonly name: string;
+    /**
+     * Language displayed name.
+     */
+    readonly displayName?: string;
+    /**
+     * Language name alias.
+     */
+    readonly alias?: readonly string[];
+    /**
+     * Language mime types.
+     */
+    readonly mime: string | readonly string[];
+    /**
+     * Language support loader.
+     */
+    readonly load?: () => Promise<LanguageSupport>;
+    /**
+     * Supported file extensions.
+     */
+    readonly extensions?: readonly string[];
+    /**
+     * Filename expression supported by the language.
+     */
+    readonly filename?: RegExp;
+    /**
+     * CodeMirror language support.
+     *
+     * ### Notes
+     * It can provided directly or it will be obtained using `load`.
+     */
+    support?: LanguageSupport;
+}
+/**
+ * Editor language interface
+ */
+export interface IEditorLanguageRegistry {
+    /**
+     * Register a new language for CodeMirror
+     *
+     * @param language Language to register
+     */
+    addLanguage(language: IEditorLanguage): void;
+    /**
+     * Find a codemirror language by name or CodeMirror spec.
+     *
+     * @param language The CodeMirror language
+     * @param fallback Whether to fallback to default mimetype spec or not
+     * @returns The language or null
+     */
+    findBest(language: string | IEditorLanguage, fallback?: boolean): IEditorLanguage | null;
+    /**
+     * Find a codemirror language by MIME.
+     *
+     * @param mime Mime type to look for
+     * @returns The language or null
+     */
+    findByMIME(mime: string | readonly string[]): IEditorLanguage | null;
+    /**
+     * Find a codemirror language by name.
+     *
+     * @param name The language name
+     * @returns The language or null
+     */
+    findByName(name: string): IEditorLanguage | null;
+    /**
+     * Find a codemirror language by extension.
+     *
+     * @param ext The extension name
+     * @returns The language or null
+     */
+    findByExtension(ext: string | readonly string[]): IEditorLanguage | null;
+    /**
+     * Find a codemirror language by filename.
+     *
+     * @param name File name
+     * @returns The language or null
+     */
+    findByFileName(name: string): IEditorLanguage | null;
+    /**
+     * Load a CodeMirror language specified by name or Codemirror spec.
+     *
+     * @param language - The language to ensure.  If it is a string, uses {@link findBest}
+     *   to get the appropriate spec.
+     *
+     * @returns A promise that resolves when the language is available.
+     */
+    getLanguage(language: string | IEditorLanguage): Promise<IEditorLanguage | null>;
+    /**
+     * Get the raw list of available languages specs.
+     *
+     * @returns The available languages
+     */
+    getLanguages(): IEditorLanguage[];
+    /**
+     * Parse and style a string.
+     *
+     * @param code Code to highlight
+     * @param language Code language
+     * @param el HTML element into which the highlighted code will be inserted
+     */
+    highlight(code: string, language: IEditorLanguage | null, el: HTMLElement): Promise<void>;
+}
+/**
+ * Editor theme token.
+ */
+export declare const IEditorThemeRegistry: Token<IEditorThemeRegistry>;
+/**
+ * Editor theme interface
+ */
+export interface IEditorTheme {
+    /**
+     * Theme unique identifier
+     */
+    readonly name: string;
+    /**
+     * Theme name
+     */
+    readonly displayName?: string;
+    /**
+     * Editor extension for the theme
+     */
+    readonly theme: Extension;
+}
+/**
+ * Theme editor registry interface
+ */
+export interface IEditorThemeRegistry {
+    /**
+     * Register a new theme.
+     *
+     * @param theme Codemirror 6 theme
+     */
+    addTheme(theme: IEditorTheme): void;
+    /**
+     * Get the default CodeMirror 6 theme for JupyterLab
+     *
+     * @returns Default theme as a CodeMirror extension
+     */
+    defaultTheme(): Extension;
+    /**
+     * Get a theme.
+     *
+     * #### Notes
+     * It falls back to the default theme
+     *
+     * @param name Theme name
+     * @returns Theme extension
+     */
+    getTheme(name: string): Extension;
+    /**
+     * Get all themes
+     */
+    readonly themes: IEditorTheme[];
+}

package/lib/token.js

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+import { Token } from '@lumino/coreutils';
+/**
+ * Editor language token.
+ */
+export const IEditorExtensionRegistry = new Token('@jupyterlab/codemirror:IEditorExtensionRegistry');
+/**
+ * Editor language token.
+ */
+export const IEditorLanguageRegistry = new Token('@jupyterlab/codemirror:IEditorLanguageRegistry');
+/**
+ * Editor theme token.
+ */
+export const IEditorThemeRegistry = new Token('@jupyterlab/codemirror:IEditorThemeRegistry');
+//# sourceMappingURL=token.js.map

package/lib/token.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token.js","sourceRoot":"","sources":["../src/token.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,EAAsB,KAAK,EAAE,MAAM,mBAAmB,CAAC;AA4B9D;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,IAAI,KAAK,CAC/C,iDAAiD,CAClD,CAAC;AAsMF;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,KAAK,CAC9C,gDAAgD,CACjD,CAAC;AAmIF;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,KAAK,CAC3C,6CAA6C,CAC9C,CAAC"}