refactored ICellRange definition to type.ts since it's now used acros…

…s multiple modules
Rich Chiodo (rchiodo) · Aug 3, 2020 · Jun 19, 2020 · Jun 20, 2020 · Jun 20, 2020 · Jun 20, 2020
commit 8f1fd7b865fb7f8c61ed416270a681c4c74180ad
diff --git a/src/client/datascience/cellFactory.ts b/src/client/datascience/cellFactory.ts
@@ -12,7 +12,7 @@ import { IDataScienceSettings, Resource } from '../common/types';
 import { noop } from '../common/utils/misc';
 import { CellMatcher } from './cellMatcher';
 import { Identifiers } from './constants';
-import { CellState, ICell } from './types';
+import { CellState, ICell, ICellRange } from './types';
 
 function generateCodeCell(
     code: string[],
@@ -109,13 +109,6 @@ export function hasCells(document: TextDocument, settings?: IDataScienceSettings
     return false;
 }
 
-// CellRange is used as the basis for creating new ICells. We only use it in this file.
-export interface ICellRange {
-    range: Range;
-    title: string;
-    cell_type: string;
-}
-
 export function generateCellsFromString(source: string, settings?: IDataScienceSettings): ICell[] {
     const lines: string[] = source.splitLines({ trim: false, removeEmptyEntries: false });
 

diff --git a/src/client/datascience/editor-integration/codeLensFactory.ts b/src/client/datascience/editor-integration/codeLensFactory.ts
@@ -10,7 +10,7 @@ import { IFileSystem } from '../../common/platform/types';
 import { IConfigurationService, Resource } from '../../common/types';
 import * as localize from '../../common/utils/localize';
 import { noop } from '../../common/utils/misc';
-import { generateCellRangesFromDocument, ICellRange } from '../cellFactory';
+import { generateCellRangesFromDocument } from '../cellFactory';
 import { CodeLensCommands, Commands, Identifiers } from '../constants';
 import {
     INotebookIdentity,
@@ -20,6 +20,7 @@ import {
 import {
     ICell,
     ICellHashProvider,
+    ICellRange,
     ICodeLensFactory,
     IFileHashes,
     IInteractiveWindowListener,
@@ -41,6 +42,7 @@ type CodeLensCacheData = {
  */
 @injectable()
 export class CodeLensFactory implements ICodeLensFactory, IInteractiveWindowListener {
+    public cells: ICellRange[];
     private updateEvent: EventEmitter<void> = new EventEmitter<void>();
     // tslint:disable-next-line: no-any
     private postEmitter: EventEmitter<{ message: string; payload: any }> = new EventEmitter<{
@@ -60,6 +62,7 @@ export class CodeLensFactory implements ICodeLensFactory, IInteractiveWindowList
         @inject(IFileSystem) private fileSystem: IFileSystem,
         @inject(IDocumentManager) private documentManager: IDocumentManager
     ) {
+        this.cells = [];
         this.documentManager.onDidCloseTextDocument(this.onClosedDocument.bind(this));
         this.configService.getSettings(undefined).onDidChange(this.onChangedSettings.bind(this));
     }
@@ -204,6 +207,8 @@ export class CodeLensFactory implements ICodeLensFactory, IInteractiveWindowList
             });
         }
 
+        this.cells = cache.cellRanges;
+
         return [...cache.documentLenses, ...cache.gotoCellLens];
     }
 

diff --git a/src/client/datascience/types.ts b/src/client/datascience/types.ts
@@ -632,6 +632,7 @@ export interface ICodeWatcher {
 
 export const ICodeLensFactory = Symbol('ICodeLensFactory');
 export interface ICodeLensFactory {
+    cells: ICellRange[];
     updateRequired: Event<void>;
     createCodeLenses(document: TextDocument): CodeLens[];
 }
@@ -654,6 +655,18 @@ export interface ICell {
     extraLines?: number[];
 }
 
+// CellRange is used as the basis for creating new ICells.
+// Was only intended to aggregate together ranges to create an ICell
+// However the "range" aspect is useful when working with plain text document
+// Ultimately, it would probably be ideal to be ICell and change line to range.
+// Specificially see how this is being used for the ICodeLensFactory to
+// provide cells for the CodeWatcher to use.
+export interface ICellRange {
+    range: Range;
+    title: string;
+    cell_type: string;
+}
+
 export interface IInteractiveWindowInfo {
     cellCount: number;
     undoCount: number;