reorganize API definitions to avoid circular imports

jupyter-lsp · Mar 21, 2021 · 76bef7d · 76bef7d
1 parent 93e7d4d
commit 76bef7d
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 32 deletions.
diff --git a/packages/jupyterlab-lsp/src/api/extractor.ts b/packages/jupyterlab-lsp/src/api/extractor.ts
@@ -0,0 +1,14 @@
+/**
+ * Extractor Public API
+ *
+ * Please note that this APIs can be subject to change and relocation to separate package in the future releases.
+ *
+ * @see https://github.com/krassowski/jupyterlab-lsp/issues/561
+ */
+export { LanguageIdentifier } from '../lsp';
+export {
+  IForeignCodeExtractor,
+  IForeignCodeExtractorsRegistry,
+  IExtractedCode
+} from '../extractors/types';
+export { RegExpForeignCodeExtractor } from '../extractors/regexp';
diff --git a/packages/jupyterlab-lsp/src/api/index.ts b/packages/jupyterlab-lsp/src/api/index.ts
@@ -0,0 +1,5 @@
+/** Extractor Public API */
+export * from './extractor';
+
+/** Overrides Public API */
+export * from './overrides';
diff --git a/packages/jupyterlab-lsp/src/api/overrides.ts b/packages/jupyterlab-lsp/src/api/overrides.ts
@@ -0,0 +1,11 @@
+/**
+ * Overrides Public API
+ *
+ * Please note that this APIs can be subject to change and relocation to separate package in the future releases.
+ *
+ * @see https://github.com/krassowski/jupyterlab-lsp/issues/561
+ */
+export {
+  ILSPCodeOverridesManager,
+  IScopedCodeOverride
+} from '../overrides/tokens';
diff --git a/packages/jupyterlab-lsp/src/index.ts b/packages/jupyterlab-lsp/src/index.ts
@@ -1,3 +1,11 @@
+/** The Public API, as exposed in the `main` field of package.json */
+
+/** General public tokens, including lumino Tokens and namespaces */
+export * from './tokens';
+
+/** Component- and feature-specific APIs */
+export * from './api';
+
 import {
   JupyterFrontEnd,
   JupyterFrontEndPlugin
@@ -51,8 +59,6 @@ import { CODE_OVERRIDES_MANAGER } from './overrides';
 import IPaths = JupyterFrontEnd.IPaths;
 import { LOG_CONSOLE } from './virtual/console';
 
-export * from './tokens';
-
 export interface IFeatureOptions {
   /**
    * The feature to be registered.

diff --git a/packages/jupyterlab-lsp/src/tokens.ts b/packages/jupyterlab-lsp/src/tokens.ts
@@ -17,39 +17,11 @@ import {
   IContextMenuOptions
 } from './command_manager';
 import IEditor = CodeEditor.IEditor;
-
-/**
- * Extractor API
- *
- * Please note that this APIs can be subject to change and relocation to separate package in the future releases.
- *
- * @see https://github.com/krassowski/jupyterlab-lsp/issues/561
- */
-import { LanguageIdentifier } from './lsp';
 import {
   IForeignCodeExtractor,
-  IForeignCodeExtractorsRegistry,
-  IExtractedCode
+  IForeignCodeExtractorsRegistry
 } from './extractors/types';
-export {
-  IExtractedCode,
-  IForeignCodeExtractorsRegistry,
-  IForeignCodeExtractor,
-  LanguageIdentifier
-};
-export { RegExpForeignCodeExtractor } from './extractors/regexp';
-
-/**
- * Overrides API
- *
- * Please note that this APIs can be subject to change and relocation to separate package in the future releases.
- *
- * @see https://github.com/krassowski/jupyterlab-lsp/issues/561
- */
-export {
-  ILSPCodeOverridesManager,
-  IScopedCodeOverride
-} from './overrides/tokens';
+import { LanguageIdentifier } from './lsp';
 
 export type TLanguageServerId = string;
 export type TLanguageId = string;