@jupyter-lsp/code-jumpers/src/positions.ts

Implementation underlying the jump to definition functionality in JupyterLab-LSP

import { CodeEditor } from '@jupyterlab/codeeditor';

export interface ILocalPosition {
  /**
   * The token of origin (variable/function usage).
   */
  token: CodeEditor.IToken;
  /**
   * Optional number identifying the cell in a notebook.
   * 0 in widgets with single editor
   */
  index: number;
}

export interface IGlobalPosition {
  /**
   * In notebooks, the index of the target editor; 0 in widgets with single editor.
   */
  editorIndex: number;

  line: number;
  column: number;

  /**
   * The Jupyter ContentsManager path, _not_ passed through encode URI.
   */
  contentsPath: string;

  isSymlink: boolean;
}