@jupyterlab/codemirror 4.6.0-alpha.1 → 4.6.0-alpha.3

package/src/extension.ts

@@ -9,13 +9,9 @@ import {
   indentOnInput,
   indentUnit
 } from '@codemirror/language';
-import {
-  Compartment,
-  EditorState,
-  Extension,
-  Prec,
-  StateEffect
-} from '@codemirror/state';
+import type { Extension } from '@codemirror/state';
+import { Compartment, EditorState, Prec, StateEffect } from '@codemirror/state';
+import type { KeyBinding } from '@codemirror/view';
 import {
   crosshairCursor,
   drawSelection,
@@ -25,20 +21,23 @@ import {
   highlightSpecialChars,
   highlightTrailingWhitespace,
   highlightWhitespace,
-  KeyBinding,
   keymap,
   lineNumbers,
   rectangularSelection,
   scrollPastEnd,
   tooltips
 } from '@codemirror/view';
-import { ITranslator, nullTranslator } from '@jupyterlab/translation';
-import { JSONExt, ReadonlyJSONObject } from '@lumino/coreutils';
-import { IObservableDisposable } from '@lumino/disposable';
-import { ISignal, Signal } from '@lumino/signaling';
+import type { ITranslator } from '@jupyterlab/translation';
+import { nullTranslator } from '@jupyterlab/translation';
+import type { ReadonlyJSONObject } from '@lumino/coreutils';
+import { JSONExt } from '@lumino/coreutils';
+import type { IObservableDisposable } from '@lumino/disposable';
+import type { ISignal } from '@lumino/signaling';
+import { Signal } from '@lumino/signaling';
 import { StateCommands } from './commands';
-import { customTheme, CustomTheme, rulers } from './extensions';
-import {
+import type { CustomTheme } from './extensions';
+import { customTheme, rulers } from './extensions';
+import type {
   IConfigurableExtension,
   IEditorExtensionFactory,
   IEditorExtensionRegistry,

package/src/extensions/customStyle.ts

@@ -3,7 +3,8 @@
  * Distributed under the terms of the Modified BSD License.
  */
 
-import { combineConfig, Extension, Facet } from '@codemirror/state';
+import type { Extension } from '@codemirror/state';
+import { combineConfig, Facet } from '@codemirror/state';
 import { EditorView } from '@codemirror/view';
 
 /**

package/src/extensions/ipython-md.ts

@@ -1,9 +1,10 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 
-import { parseMixed, Parser } from '@lezer/common';
+import type { Parser } from '@lezer/common';
+import { parseMixed } from '@lezer/common';
 import { tags } from '@lezer/highlight';
-import {
+import type {
   DelimiterType,
   InlineContext,
   MarkdownConfig,

package/src/extensions/rulers.ts

@@ -5,8 +5,10 @@
 
 // Inspired by https://discuss.codemirror.net/t/how-to-implement-ruler/4616/
 
-import { Extension, Facet } from '@codemirror/state';
-import { EditorView, ViewPlugin, ViewUpdate } from '@codemirror/view';
+import type { Extension } from '@codemirror/state';
+import { Facet } from '@codemirror/state';
+import type { ViewUpdate } from '@codemirror/view';
+import { EditorView, ViewPlugin } from '@codemirror/view';
 import { JSONExt } from '@lumino/coreutils';
 
 const RULERS_CLASSNAME = 'cm-rulers';

package/src/extensions/ybinding.ts

@@ -7,14 +7,10 @@
  * It is a simplification of https://github.com/yjs/y-codemirror.next
  * licensed under MIT License by Kevin Jahns
  */
-import {
-  Annotation,
-  EditorSelection,
-  Extension,
-  Facet,
-  SelectionRange
-} from '@codemirror/state';
-import { EditorView, ViewPlugin, ViewUpdate } from '@codemirror/view';
+import type { Extension, SelectionRange } from '@codemirror/state';
+import { Annotation, EditorSelection, Facet } from '@codemirror/state';
+import type { EditorView, ViewUpdate } from '@codemirror/view';
+import { ViewPlugin } from '@codemirror/view';
 import {
   yUndoManager,
   YUndoManagerConfig,

package/src/extensions/yundomanager.ts

@@ -14,14 +14,11 @@
  * - simplified `YUndoManagerConfig` by removing public methods
  * - moved `_onStackItemAdded`, `_onStackItemPopped` and `_storeSelection` definitions out of constructor
  */
-import {
-  EditorView,
-  PluginValue,
-  ViewPlugin,
-  ViewUpdate
-} from '@codemirror/view';
+import type { PluginValue, ViewUpdate } from '@codemirror/view';
+import { EditorView, ViewPlugin } from '@codemirror/view';
 import { Facet } from '@codemirror/state';
-import { YRange, ySyncAnnotation, YSyncConfig, ySyncFacet } from './ybinding';
+import type { YRange, YSyncConfig } from './ybinding';
+import { ySyncAnnotation, ySyncFacet } from './ybinding';
 import type { UndoManager } from 'yjs';
 
 interface IStackItem {

package/src/factory.ts

@@ -1,12 +1,13 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 
-import { CodeEditor, IEditorFactoryService } from '@jupyterlab/codeeditor';
-import { ITranslator, nullTranslator } from '@jupyterlab/translation';
+import type { CodeEditor, IEditorFactoryService } from '@jupyterlab/codeeditor';
+import type { ITranslator } from '@jupyterlab/translation';
+import { nullTranslator } from '@jupyterlab/translation';
 import { EditorExtensionRegistry } from './extension';
 import { CodeMirrorEditor } from './editor';
 import { EditorLanguageRegistry } from './language';
-import {
+import type {
   IEditorExtensionFactory,
   IEditorExtensionRegistry,
   IEditorFactoryOptions,

package/src/language.ts

@@ -1,21 +1,23 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 
+import type * as SQLModule from '@codemirror/lang-sql';
+import type { StreamParser } from '@codemirror/language';
 import {
   LanguageDescription,
   LanguageSupport,
   LRLanguage,
-  StreamLanguage,
-  StreamParser
+  StreamLanguage
 } from '@codemirror/language';
 import { IEditorMimeTypeService } from '@jupyterlab/codeeditor';
 import { PathExt } from '@jupyterlab/coreutils';
-import { ITranslator, nullTranslator } from '@jupyterlab/translation';
+import type { ITranslator } from '@jupyterlab/translation';
+import { nullTranslator } from '@jupyterlab/translation';
 import { buildParser } from '@lezer/generator';
 import { highlightTree } from '@lezer/highlight';
 
 import { jupyterHighlightStyle } from './theme';
-import { IEditorLanguage, IEditorLanguageRegistry } from './token';
+import type { IEditorLanguage, IEditorLanguageRegistry } from './token';
 import { pythonBuiltin } from './pythonBuiltin';
 
 /**
@@ -198,7 +200,7 @@ export class EditorLanguageRegistry implements IEditorLanguageRegistry {
   ): IEditorLanguage | null {
     const modename = typeof language === 'string' ? language : language.name;
     const mimetype = typeof language !== 'string' ? language.mime : modename;
-    const ext = typeof language !== 'string' ? language.extensions ?? [] : [];
+    const ext = typeof language !== 'string' ? (language.extensions ?? []) : [];
 
     return (
       (modename ? this.findByName(modename) : null) ??
@@ -286,7 +288,7 @@ export namespace EditorLanguageRegistry {
    * @returns Language object
    */
   async function sql(
-    dialectName: keyof typeof import('@codemirror/lang-sql')
+    dialectName: keyof typeof SQLModule
   ): Promise<LanguageSupport> {
     const m = await import('@codemirror/lang-sql');
     return m.sql({ dialect: (m as any)[dialectName] });
@@ -296,10 +298,12 @@ export namespace EditorLanguageRegistry {
    * Get the default editor languages
    *
    * @param translator Application translator
+   * @param findLanguage Optional function to find a language by name for markdown code block highlighting
    * @returns Default CodeMirror 6 languages
    */
   export function getDefaultLanguages(
-    translator?: ITranslator | null
+    translator?: ITranslator | null,
+    findLanguage?: (info: string) => IEditorLanguage | null
   ): ReadonlyArray<IEditorLanguage> {
     const trans = (translator ?? nullTranslator).load('jupyterlab');
     return [
@@ -416,7 +420,23 @@ export namespace EditorLanguageRegistry {
         extensions: ['md', 'markdown', 'mkd'],
         async load() {
           const m = await import('@codemirror/lang-markdown');
-          return m.markdown({ codeLanguages: this._modeList as any });
+          if (!findLanguage) {
+            return m.markdown();
+          }
+          return m.markdown({
+            codeLanguages: (info: string) => {
+              const language = findLanguage(info);
+              if (!language) {
+                return null;
+              }
+              if (language instanceof LanguageDescription) {
+                // Sometimes the IEditorLanguage returned is a
+                // LanguageDescription instance, so early return in this case.
+                return language;
+              }
+              return LanguageDescription.of(language);
+            }
+          });
         }
       },
       {

package/src/mimetype.ts

@@ -3,8 +3,8 @@
 
 import { IEditorMimeTypeService } from '@jupyterlab/codeeditor';
 import { PathExt } from '@jupyterlab/coreutils';
-import * as nbformat from '@jupyterlab/nbformat';
-import { IEditorLanguageRegistry } from './token';
+import type * as nbformat from '@jupyterlab/nbformat';
+import type { IEditorLanguageRegistry } from './token';
 
 /**
  * The mime type service for CodeMirror.
@@ -29,9 +29,9 @@ export class CodeMirrorMimeTypeService implements IEditorMimeTypeService {
       }
     );
     return mode
-      ? Array.isArray(mode.mime)
-        ? mode.mime[0] ?? IEditorMimeTypeService.defaultMimeType
-        : mode.mime
+      ? typeof mode.mime === 'string'
+        ? mode.mime
+        : (mode.mime[0] ?? IEditorMimeTypeService.defaultMimeType)
       : IEditorMimeTypeService.defaultMimeType;
   }
 
@@ -52,9 +52,9 @@ export class CodeMirrorMimeTypeService implements IEditorMimeTypeService {
     }
     const mode = this.languages.findByFileName(path);
     return mode
-      ? Array.isArray(mode.mime)
-        ? mode.mime[0] ?? IEditorMimeTypeService.defaultMimeType
-        : mode.mime
+      ? typeof mode.mime === 'string'
+        ? mode.mime
+        : (mode.mime[0] ?? IEditorMimeTypeService.defaultMimeType)
       : IEditorMimeTypeService.defaultMimeType;
   }
 }

package/src/pythonBuiltin.ts

@@ -3,16 +3,13 @@
  * Distributed under the terms of the Modified BSD License.
  */
 
-import { Language, syntaxTree } from '@codemirror/language';
+import type { Language } from '@codemirror/language';
+import { syntaxTree } from '@codemirror/language';
 import { RangeSetBuilder } from '@codemirror/state';
-import {
-  Decoration,
-  DecorationSet,
-  EditorView,
-  ViewPlugin,
-  ViewUpdate
-} from '@codemirror/view';
-import { NodeProp, SyntaxNodeRef, Tree } from '@lezer/common';
+import type { DecorationSet, EditorView, ViewUpdate } from '@codemirror/view';
+import { Decoration, ViewPlugin } from '@codemirror/view';
+import type { SyntaxNodeRef, Tree } from '@lezer/common';
+import { NodeProp } from '@lezer/common';
 
 export class PythonBuiltin {
   decorations: DecorationSet;

package/src/searchprovider.ts

@@ -30,26 +30,25 @@
   THE SOFTWARE.
 */
 
-import { ISearchMatch } from '@jupyterlab/documentsearch';
-import { CodeMirrorEditor } from './editor';
-import {
-  EditorSelection,
-  Extension,
-  StateEffect,
-  StateEffectType,
-  StateField
-} from '@codemirror/state';
-import { Decoration, DecorationSet, EditorView } from '@codemirror/view';
-import { CodeEditor } from '@jupyterlab/codeeditor';
-import {
-  GenericSearchProvider,
+import type { ISearchMatch } from '@jupyterlab/documentsearch';
+import type { CodeMirrorEditor } from './editor';
+import type { Extension, StateEffectType } from '@codemirror/state';
+import { EditorSelection, StateEffect, StateField } from '@codemirror/state';
+import type { DecorationSet } from '@codemirror/view';
+import { Decoration, EditorView } from '@codemirror/view';
+import type { CodeEditor } from '@jupyterlab/codeeditor';
+import type {
   IBaseSearchProvider,
   IFilters,
-  IReplaceOptions,
+  IReplaceOptions
+} from '@jupyterlab/documentsearch';
+import {
+  GenericSearchProvider,
   TextSearchEngine
 } from '@jupyterlab/documentsearch';
-import { ISignal, Signal } from '@lumino/signaling';
-import { ISharedText, SourceChange } from '@jupyter/ydoc';
+import type { ISignal } from '@lumino/signaling';
+import { Signal } from '@lumino/signaling';
+import type { ISharedText, SourceChange } from '@jupyter/ydoc';
 
 /**
  * Defines from which position the search should be executed.
@@ -93,8 +92,7 @@ export interface IHighlightAdjacentMatchOptions extends IHighlightMatchOptions {
  */
 export abstract class EditorSearchProvider<
   T extends CodeEditor.IModel = CodeEditor.IModel
-> implements IBaseSearchProvider
-{
+> implements IBaseSearchProvider {
   /**
    * Constructor
    */

package/src/theme.ts

@@ -6,11 +6,12 @@ import {
   HighlightStyle,
   syntaxHighlighting
 } from '@codemirror/language';
-import { Extension } from '@codemirror/state';
+import type { Extension } from '@codemirror/state';
 import { EditorView } from '@codemirror/view';
-import { ITranslator, nullTranslator } from '@jupyterlab/translation';
+import type { ITranslator } from '@jupyterlab/translation';
+import { nullTranslator } from '@jupyterlab/translation';
 import { tags as t } from '@lezer/highlight';
-import { IEditorTheme, IEditorThemeRegistry } from './token';
+import type { IEditorTheme, IEditorThemeRegistry } from './token';
 
 export const jupyterEditorTheme = EditorView.theme({
   /**

package/src/token.ts

@@ -8,7 +8,8 @@ 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 { ReadonlyJSONObject } from '@lumino/coreutils';
+import { Token } from '@lumino/coreutils';
 import type { IDisposable } from '@lumino/disposable';
 import type { ISignal } from '@lumino/signaling';
 

package/src/typings.d.ts

@@ -4,7 +4,7 @@
  */
 
 declare module '@codemirror/legacy-modes/mode/python' {
-  import { StreamParser } from '@codemirror/language';
+  import type { StreamParser } from '@codemirror/language';
 
   export const python: StreamParser<unknown>;
   export const cython: StreamParser<unknown>;