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

package/lib/factory.js

@@ -1,7 +1,11 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 import { nullTranslator } from '@jupyterlab/translation';
+import { EditorExtensionRegistry } from './extension';
 import { CodeMirrorEditor } from './editor';
+import { EditorLanguageRegistry } from './language';
+import { keymap } from '@codemirror/view';
+import { searchKeymap } from '@codemirror/search';
 /**
  * CodeMirror editor factory.
  */
@@ -9,42 +13,67 @@ export class CodeMirrorEditorFactory {
     /**
      * Construct an IEditorFactoryService for CodeMirrorEditors.
      */
-    constructor(defaults = {}, translator) {
+    constructor(options = {}) {
+        var _a, _b, _c;
         /**
          * Create a new editor for inline code.
          */
         this.newInlineEditor = (options) => {
+            var _a;
             options.host.dataset.type = 'inline';
-            return new CodeMirrorEditor(Object.assign(Object.assign({}, options), { config: Object.assign(Object.assign({}, this.inlineCodeMirrorConfig), (options.config || {})), translator: this.translator }));
+            return this.newEditor({
+                ...options,
+                config: { ...this.inlineCodeMirrorConfig, ...(options.config || {}) },
+                inline: true,
+                // FIXME the search keymap should be added in the search plugin
+                extensions: [keymap.of(searchKeymap)].concat((_a = options.extensions) !== null && _a !== void 0 ? _a : [])
+            });
         };
         /**
          * Create a new editor for a full document.
          */
         this.newDocumentEditor = (options) => {
+            var _a, _b;
             options.host.dataset.type = 'document';
-            return new CodeMirrorEditor(Object.assign(Object.assign({}, options), { config: Object.assign(Object.assign({}, this.documentCodeMirrorConfig), (options.config || {})), translator: this.translator }));
+            return this.newEditor({
+                ...options,
+                config: { ...this.documentCodeMirrorConfig, ...((_a = options.config) !== null && _a !== void 0 ? _a : {}) },
+                inline: false,
+                extensions: [
+                    keymap.of([
+                        {
+                            key: 'Shift-Enter',
+                            run: (target) => {
+                                return true;
+                            }
+                        }
+                    ])
+                ].concat((_b = options.extensions) !== null && _b !== void 0 ? _b : [])
+            });
         };
-        this.translator = translator || nullTranslator;
-        this.inlineCodeMirrorConfig = Object.assign(Object.assign(Object.assign({}, CodeMirrorEditor.defaultConfig), { extraKeys: {
-                'Cmd-Right': 'goLineRight',
-                End: 'goLineRight',
-                'Cmd-Left': 'goLineLeft',
-                Tab: 'indentMoreOrinsertTab',
-                'Shift-Tab': 'indentLess',
-                'Cmd-/': cm => cm.toggleComment({ indent: true }),
-                'Ctrl-/': cm => cm.toggleComment({ indent: true }),
-                'Ctrl-G': 'find',
-                'Cmd-G': 'find'
-            } }), defaults);
-        this.documentCodeMirrorConfig = Object.assign(Object.assign(Object.assign({}, CodeMirrorEditor.defaultConfig), { extraKeys: {
-                Tab: 'indentMoreOrinsertTab',
-                'Shift-Tab': 'indentLess',
-                'Cmd-/': cm => cm.toggleComment({ indent: true }),
-                'Ctrl-/': cm => cm.toggleComment({ indent: true }),
-                'Shift-Enter': () => {
-                    /* no-op */
-                }
-            }, lineNumbers: true, scrollPastEnd: true }), defaults);
+        this.languages = (_a = options.languages) !== null && _a !== void 0 ? _a : new EditorLanguageRegistry();
+        this.extensions = (_b = options.extensions) !== null && _b !== void 0 ? _b : new EditorExtensionRegistry();
+        this.translator = (_c = options.translator) !== null && _c !== void 0 ? _c : nullTranslator;
+        this.inlineCodeMirrorConfig = {};
+        this.documentCodeMirrorConfig = {
+            lineNumbers: true,
+            scrollPastEnd: true
+        };
+    }
+    /**
+     * Create a new editor
+     *
+     * @param options Editor options
+     * @returns The editor
+     */
+    newEditor(options) {
+        const editor = new CodeMirrorEditor({
+            extensionsRegistry: this.extensions,
+            languages: this.languages,
+            translator: this.translator,
+            ...options
+        });
+        return editor;
     }
 }
 //# sourceMappingURL=factory.js.map

package/lib/factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"factory.js","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAG3D,OAAO,EAAe,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C;;GAEG;AACH,MAAM,OAAO,uBAAuB;IAClC;;OAEG;IACH,YACE,WAA8C,EAAE,EAChD,UAAwB;QAmC1B;;WAEG;QACH,oBAAe,GAAG,CAAC,OAA4B,EAAoB,EAAE;YACnE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC;YACrC,OAAO,IAAI,gBAAgB,iCACtB,OAAO,KACV,MAAM,kCAAO,IAAI,CAAC,sBAAsB,GAAK,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,GACnE,UAAU,EAAE,IAAI,CAAC,UAAU,IAC3B,CAAC;QACL,CAAC,CAAC;QAEF;;WAEG;QACH,sBAAiB,GAAG,CAAC,OAA4B,EAAoB,EAAE;YACrE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,UAAU,CAAC;YACvC,OAAO,IAAI,gBAAgB,iCACtB,OAAO,KACV,MAAM,kCAAO,IAAI,CAAC,wBAAwB,GAAK,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,GACrE,UAAU,EAAE,IAAI,CAAC,UAAU,IAC3B,CAAC;QACL,CAAC,CAAC;QAvDA,IAAI,CAAC,UAAU,GAAG,UAAU,IAAI,cAAc,CAAC;QAC/C,IAAI,CAAC,sBAAsB,iDACtB,gBAAgB,CAAC,aAAa,KACjC,SAAS,EAAE;gBACT,WAAW,EAAE,aAAa;gBAC1B,GAAG,EAAE,aAAa;gBAClB,UAAU,EAAE,YAAY;gBACxB,GAAG,EAAE,uBAAuB;gBAC5B,WAAW,EAAE,YAAY;gBACzB,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;gBACjD,QAAQ,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;gBAClD,QAAQ,EAAE,MAAM;gBAChB,OAAO,EAAE,MAAM;aAChB,KACE,QAAQ,CACZ,CAAC;QACF,IAAI,CAAC,wBAAwB,iDACxB,gBAAgB,CAAC,aAAa,KACjC,SAAS,EAAE;gBACT,GAAG,EAAE,uBAAuB;gBAC5B,WAAW,EAAE,YAAY;gBACzB,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;gBACjD,QAAQ,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;gBAClD,aAAa,EAAE,GAAG,EAAE;oBAClB,WAAW;gBACb,CAAC;aACF,EACD,WAAW,EAAE,IAAI,EACjB,aAAa,EAAE,IAAI,KAChB,QAAQ,CACZ,CAAC;IACJ,CAAC;CA6BF"}
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAG3D,OAAO,EAAe,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAOpD,OAAO,EAAc,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,MAAM,OAAO,uBAAuB;IAClC;;OAEG;IACH,YAAY,UAAiC,EAAE;;QAW/C;;WAEG;QACM,oBAAe,GAAG,CACzB,OAA4B,EACV,EAAE;;YACpB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC;YACrC,OAAO,IAAI,CAAC,SAAS,CAAC;gBACpB,GAAG,OAAO;gBACV,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,sBAAsB,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE;gBACrE,MAAM,EAAE,IAAI;gBACZ,+DAA+D;gBAC/D,UAAU,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,MAAA,OAAO,CAAC,UAAU,mCAAI,EAAE,CAAC;aACvE,CAAC,CAAC;QACL,CAAC,CAAC;QAEF;;WAEG;QACM,sBAAiB,GAAG,CAC3B,OAA4B,EACV,EAAE;;YACpB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,UAAU,CAAC;YACvC,OAAO,IAAI,CAAC,SAAS,CAAC;gBACpB,GAAG,OAAO;gBACV,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,wBAAwB,EAAE,GAAG,CAAC,MAAA,OAAO,CAAC,MAAM,mCAAI,EAAE,CAAC,EAAE;gBACvE,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,MAAM,CAAC,EAAE,CAAC;wBACR;4BACE,GAAG,EAAE,aAAa;4BAClB,GAAG,EAAE,CAAC,MAAkB,EAAE,EAAE;gCAC1B,OAAO,IAAI,CAAC;4BACd,CAAC;yBACF;qBACF,CAAC;iBACH,CAAC,MAAM,CAAC,MAAA,OAAO,CAAC,UAAU,mCAAI,EAAE,CAAC;aACnC,CAAC,CAAC;QACL,CAAC,CAAC;QAhDA,IAAI,CAAC,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,IAAI,sBAAsB,EAAE,CAAC;QACnE,IAAI,CAAC,UAAU,GAAG,MAAA,OAAO,CAAC,UAAU,mCAAI,IAAI,uBAAuB,EAAE,CAAC;QACtE,IAAI,CAAC,UAAU,GAAG,MAAA,OAAO,CAAC,UAAU,mCAAI,cAAc,CAAC;QACvD,IAAI,CAAC,sBAAsB,GAAG,EAAE,CAAC;QACjC,IAAI,CAAC,wBAAwB,GAAG;YAC9B,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,IAAI;SACpB,CAAC;IACJ,CAAC;IA0CD;;;;;OAKG;IACO,SAAS,CACjB,OAA+D;QAE/D,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC;YAClC,kBAAkB,EAAE,IAAI,CAAC,UAAU;YACnC,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,GAAG,OAAO;SACX,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;CAOF"}

package/lib/index.d.ts

@@ -2,25 +2,13 @@
  * @packageDocumentation
  * @module codemirror
  */
-import { IEditorServices } from '@jupyterlab/codeeditor';
+export * from './commands';
 export * from './editor';
+export * from './extension';
+export * from './extensions';
 export * from './factory';
+export * from './language';
 export * from './mimetype';
-export * from './mode';
-export * from './syntaxstatus';
-export * from './tokens';
-/**
- * The default editor services.
- */
-export declare const editorServices: IEditorServices;
-/**
- * FIXME-TRANS: Maybe an option to be able to pass a translator to the factories?
- *
-
-export function getEditorServices(translator: ITranslator): IEditorServices {
-  return {
-    factoryService: new CodeMirrorEditorFactory({}, translator),
-    mimeTypeService: new CodeMirrorMimeTypeService(translator)
-  };
-}
- */
+export * from './searchprovider';
+export * from './theme';
+export * from './token';

package/lib/index.js

@@ -4,30 +4,14 @@
  * @packageDocumentation
  * @module codemirror
  */
-import { CodeMirrorEditorFactory } from './factory';
-import { CodeMirrorMimeTypeService } from './mimetype';
+export * from './commands';
 export * from './editor';
+export * from './extension';
+export * from './extensions';
 export * from './factory';
+export * from './language';
 export * from './mimetype';
-export * from './mode';
-export * from './syntaxstatus';
-export * from './tokens';
-/**
- * The default editor services.
- */
-export const editorServices = {
-    factoryService: new CodeMirrorEditorFactory(),
-    mimeTypeService: new CodeMirrorMimeTypeService()
-};
-/**
- * FIXME-TRANS: Maybe an option to be able to pass a translator to the factories?
- *
-
-export function getEditorServices(translator: ITranslator): IEditorServices {
-  return {
-    factoryService: new CodeMirrorEditorFactory({}, translator),
-    mimeTypeService: new CodeMirrorMimeTypeService(translator)
-  };
-}
- */
+export * from './searchprovider';
+export * from './theme';
+export * from './token';
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAC3D;;;GAGG;AAGH,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAEvD,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAoB;IAC7C,cAAc,EAAE,IAAI,uBAAuB,EAAE;IAC7C,eAAe,EAAE,IAAI,yBAAyB,EAAE;CACjD,CAAC;AAEF;;;;;;;;;;GAUG"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAC3D;;;GAGG;AAEH,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}

package/lib/language.d.ts

@@ -0,0 +1,96 @@
+import { LanguageSupport, StreamParser } from '@codemirror/language';
+import { IEditorLanguage, IEditorLanguageRegistry } from './token';
+import { ITranslator } from '@jupyterlab/translation';
+/**
+ * CodeMirror language registry
+ */
+export declare class EditorLanguageRegistry implements IEditorLanguageRegistry {
+    private _modeList;
+    constructor();
+    /**
+     * Register a new language for CodeMirror
+     *
+     * @param language Language to register
+     */
+    addLanguage(language: IEditorLanguage): void;
+    /**
+     * Ensure a codemirror mode is available by name or Codemirror spec.
+     *
+     * @param language - The mode to ensure.  If it is a string, uses [findBest]
+     *   to get the appropriate spec.
+     *
+     * @returns A promise that resolves when the mode is available.
+     */
+    getLanguage(language: string | IEditorLanguage): Promise<IEditorLanguage | null>;
+    /**
+     * Get the raw list of available modes specs.
+     *
+     * @returns The available modes
+     */
+    getLanguages(): IEditorLanguage[];
+    /**
+     * Find a codemirror mode by MIME.
+     *
+     * @param mime Mime type to look for
+     * @param strict Whether xml and json should be assimilated to the generic mimetype
+     * @returns The mode or null
+     */
+    findByMIME(mime: string | readonly string[], strict?: boolean): IEditorLanguage | null;
+    /**
+     * Find a codemirror mode by name.
+     *
+     * @param name The mode name
+     * @returns The mode or null
+     */
+    findByName(name: string): IEditorLanguage | null;
+    /**
+     * Find a codemirror mode by extension.
+     *
+     * @param ext The extension name
+     * @returns The mode or null
+     */
+    findByExtension(ext: string | readonly string[]): IEditorLanguage | null;
+    /**
+     * Find a codemirror mode by filename.
+     *
+     * @param name File name
+     * @returns The mode or null
+     */
+    findByFileName(name: string): IEditorLanguage | null;
+    /**
+     * Find a codemirror mode by name or CodeMirror spec.
+     *
+     * @param language The CodeMirror mode
+     * @param fallback Whether to fallback to default mimetype spec or not
+     * @returns The mode or null
+     */
+    findBest(language: string | IEditorLanguage, fallback?: boolean): IEditorLanguage | null;
+    /**
+     * 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>;
+    protected makeSpec(spec: IEditorLanguage): IEditorLanguage;
+}
+/**
+ * EditorLanguageRegistry namespace
+ */
+export declare namespace EditorLanguageRegistry {
+    /**
+     * Convert an CodeMirror 5 language parser to CodeMirror 6
+     *
+     * @param parser Legacy parser
+     * @returns Language object
+     */
+    function legacy(parser: StreamParser<unknown>): LanguageSupport;
+    /**
+     * Get the default editor languages
+     *
+     * @param translator Application translator
+     * @returns Default CodeMirror 6 languages
+     */
+    function getDefaultLanguages(translator?: ITranslator | null): ReadonlyArray<IEditorLanguage>;
+}