@difizen/libro-code-editor 0.0.0-snapshot-20241017072317

package/src/index.ts

@@ -0,0 +1,8 @@
+export * from './code-editor-manager.js';
+export * from './code-editor-model.js';
+export * from './code-editor-protocol.js';
+export * from './code-editor-settings.js';
+export * from './code-editor-view.js';
+export * from './mimetype.js';
+export * from './module.js';
+export * from './language-specs.js';

package/src/language-specs.ts

@@ -0,0 +1,69 @@
+import type { Contribution } from '@difizen/mana-app';
+import { ApplicationContribution } from '@difizen/mana-app';
+import { contrib, singleton, Syringe } from '@difizen/mana-app';
+
+export const LanguageSpecContribution = Syringe.defineToken('LanguageSpecContribution');
+export interface LanguageSpecContribution {
+  registerLanguageSpec: (register: LanguageSpecRegistry) => void;
+}
+export interface LanguageSpec {
+  /**
+   * language name
+   */
+  name: string;
+  /**
+   * https://code.visualstudio.com/docs/languages/identifiers
+   */
+  language: string;
+  /**
+   * https://www.iana.org/assignments/media-types/media-types.xhtml
+   */
+  mime: string;
+  /**
+   * file extension
+   */
+  ext: string[];
+}
+
+@singleton({ contrib: [ApplicationContribution] })
+export class LanguageSpecRegistry implements ApplicationContribution {
+  get languageSpecs(): LanguageSpec[] {
+    return this.languageSpecsData;
+  }
+  protected languageSpecsData: LanguageSpec[] = [];
+
+  protected readonly languageSpecProvider: Contribution.Provider<LanguageSpecContribution>;
+
+  constructor(
+    @contrib(LanguageSpecContribution)
+    languageSpecProvider: Contribution.Provider<LanguageSpecContribution>,
+  ) {
+    this.languageSpecProvider = languageSpecProvider;
+  }
+
+  initialize() {
+    this.languageSpecProvider.getContributions().forEach((item) => {
+      item.registerLanguageSpec(this);
+    });
+  }
+
+  /**
+   * 注册语言元信息，代码编辑器根据这些信息来设置语言；使用代码编辑器的cell一般需要注册语言元信息
+   */
+  registerLanguageSpec(spec: LanguageSpec) {
+    const index = this.languageSpecsData.findIndex(
+      (item) => item.language === spec.language,
+    );
+    if (index >= 0) {
+      this.languageSpecsData.splice(index, 1, spec);
+    } else {
+      this.languageSpecsData.push(spec);
+    }
+  }
+
+  hasLanguage(spec: LanguageSpec) {
+    return (
+      this.languageSpecsData.findIndex((item) => item.language === spec.language) > 0
+    );
+  }
+}

package/src/mimetype.ts

@@ -0,0 +1,37 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+
+import type { ILanguageInfoMetadata } from '@difizen/libro-common';
+
+/**
+ * The mime type service of a code editor.
+ */
+export interface IEditorMimeTypeService {
+  /**
+   * Get a mime type for the given language info.
+   *
+   * @param info - The language information.
+   *
+   * @returns A valid mimetype.
+   *
+   * #### Notes
+   * If a mime type cannot be found returns the default mime type `text/plain`, never `null`.
+   */
+  getMimeTypeByLanguage: (info: ILanguageInfoMetadata) => string;
+  /**
+   * Get a mime type for the given file path.
+   *
+   * @param filePath - The full path to the file.
+   *
+   * @returns A valid mimetype.
+   *
+   * #### Notes
+   * If a mime type cannot be found returns the default mime type `text/plain`, never `null`.
+   */
+  getMimeTypeByFilePath: (filePath: string) => string;
+}
+
+/**
+ * The default mime type.
+ */
+export const defaultMimeType = 'text/plain';

package/src/module.ts

@@ -0,0 +1,22 @@
+import { ManaModule } from '@difizen/mana-app';
+
+import { CodeEditorInfoManager } from './code-editor-info-manager.js';
+import { CodeEditorManager } from './code-editor-manager.js';
+import { Model } from './code-editor-model.js';
+import { CodeEditorContribution } from './code-editor-protocol.js';
+import { CodeEditorSettings } from './code-editor-settings.js';
+import { CodeEditorStateManager } from './code-editor-state-manager.js';
+import { CodeEditorView } from './code-editor-view.js';
+import { LanguageSpecContribution, LanguageSpecRegistry } from './language-specs.js';
+
+export const CodeEditorModule = ManaModule.create()
+  .register(
+    CodeEditorInfoManager,
+    CodeEditorView,
+    CodeEditorManager,
+    Model,
+    CodeEditorSettings,
+    CodeEditorStateManager,
+    LanguageSpecRegistry,
+  )
+  .contribution(CodeEditorContribution, LanguageSpecContribution);