Keep get_breadcrumbs as deprecated to avoid breaking compatibility

in case if anyone uses it
jupyter-lsp · Oct 9, 2021 · e5363da · e5363da
1 parent 9bd55aa
commit e5363da
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 3 deletions.
diff --git a/packages/jupyterlab-lsp/src/components/utils.spec.ts b/packages/jupyterlab-lsp/src/components/utils.spec.ts
@@ -20,7 +20,7 @@ function create_dummy_document(options: Partial<VirtualDocument.IOptions>) {
   });
 }
 
-describe('get_breadcrumbs', () => {
+describe('getBreadcrumbs', () => {
   const trans = nullTranslator.load('jupyterlab_lsp');
   it('should collapse long paths', () => {
     let document = create_dummy_document({

diff --git a/packages/jupyterlab-lsp/src/components/utils.tsx b/packages/jupyterlab-lsp/src/components/utils.tsx
@@ -1,5 +1,5 @@
 import { IDocumentWidget } from '@jupyterlab/docregistry';
-import { TranslationBundle } from '@jupyterlab/translation';
+import { nullTranslator, TranslationBundle } from '@jupyterlab/translation';
 import React from 'react';
 
 import { WidgetAdapter } from '../adapters/adapter';
@@ -8,9 +8,12 @@ import { VirtualDocument } from '../virtual/document';
 export function getBreadcrumbs(
   document: VirtualDocument,
   adapter: WidgetAdapter<IDocumentWidget>,
-  trans: TranslationBundle,
+  trans?: TranslationBundle,
   collapse = true
 ): JSX.Element[] {
+  if (!trans) {
+    trans = nullTranslator.load('');
+  }
   return document.ancestry.map((document: VirtualDocument) => {
     if (!document.parent) {
       let path = document.path;
@@ -64,6 +67,17 @@ export function getBreadcrumbs(
   });
 }
 
+/**
+ * @deprecated please use getBreadcrumbs instead; `get_breadcrumbs` will be removed in 4.0
+ */
+export function get_breadcrumbs(
+  document: VirtualDocument,
+  adapter: WidgetAdapter<IDocumentWidget>,
+  collapse = true
+) {
+  return getBreadcrumbs(document, adapter, null, collapse);
+}
+
 export function focus_on(node: HTMLElement) {
   if (!node) {
     return;