mirror of
https://github.com/Azure/cosmos-explorer.git
synced 2025-06-04 22:52:31 +01:00
fixed lint issue of NoteBookUtils
This commit is contained in:
parent
69975cd0e8
commit
7bc4894382
@ -122,7 +122,6 @@ src/Explorer/Notebook/NotebookComponent/types.ts
|
|||||||
src/Explorer/Notebook/NotebookContainerClient.ts
|
src/Explorer/Notebook/NotebookContainerClient.ts
|
||||||
src/Explorer/Notebook/NotebookContentClient.ts
|
src/Explorer/Notebook/NotebookContentClient.ts
|
||||||
src/Explorer/Notebook/NotebookContentItem.ts
|
src/Explorer/Notebook/NotebookContentItem.ts
|
||||||
src/Explorer/Notebook/NotebookUtil.ts
|
|
||||||
src/Explorer/OpenActions.test.ts
|
src/Explorer/OpenActions.test.ts
|
||||||
src/Explorer/OpenActions.ts
|
src/Explorer/OpenActions.ts
|
||||||
src/Explorer/OpenActionsStubs.ts
|
src/Explorer/OpenActionsStubs.ts
|
||||||
|
@ -49,7 +49,7 @@ import { LoadQueryPane } from "./Panes/LoadQueryPane";
|
|||||||
import * as Logger from "../Common/Logger";
|
import * as Logger from "../Common/Logger";
|
||||||
import { sendMessage, sendCachedDataMessage } from "../Common/MessageHandler";
|
import { sendMessage, sendCachedDataMessage } from "../Common/MessageHandler";
|
||||||
import { NotebookContentItem, NotebookContentItemType } from "./Notebook/NotebookContentItem";
|
import { NotebookContentItem, NotebookContentItemType } from "./Notebook/NotebookContentItem";
|
||||||
import { NotebookUtil } from "./Notebook/NotebookUtil";
|
import * as NotebookUtil from "./Notebook/NotebookUtil";
|
||||||
import { NotebookWorkspaceManager } from "../NotebookWorkspaceManager/NotebookWorkspaceManager";
|
import { NotebookWorkspaceManager } from "../NotebookWorkspaceManager/NotebookWorkspaceManager";
|
||||||
import * as NotificationConsoleUtils from "../Utils/NotificationConsoleUtils";
|
import * as NotificationConsoleUtils from "../Utils/NotificationConsoleUtils";
|
||||||
import { QueriesClient } from "../Common/QueriesClient";
|
import { QueriesClient } from "../Common/QueriesClient";
|
||||||
|
@ -2,7 +2,7 @@ import * as React from "react";
|
|||||||
|
|
||||||
import { NotebookComponent } from "./NotebookComponent";
|
import { NotebookComponent } from "./NotebookComponent";
|
||||||
import { NotebookClientV2 } from "../NotebookClientV2";
|
import { NotebookClientV2 } from "../NotebookClientV2";
|
||||||
import { NotebookUtil } from "../NotebookUtil";
|
import * as NotebookUtil from "../NotebookUtil";
|
||||||
|
|
||||||
// Vendor modules
|
// Vendor modules
|
||||||
import {
|
import {
|
||||||
|
@ -8,7 +8,7 @@ import * as sinon from "sinon";
|
|||||||
|
|
||||||
import { CdbAppState, makeCdbRecord } from "./types";
|
import { CdbAppState, makeCdbRecord } from "./types";
|
||||||
import { launchWebSocketKernelEpic } from "./epics";
|
import { launchWebSocketKernelEpic } from "./epics";
|
||||||
import { NotebookUtil } from "../NotebookUtil";
|
import * as NotebookUtil from "../NotebookUtil";
|
||||||
|
|
||||||
import { sessions } from "rx-jupyter";
|
import { sessions } from "rx-jupyter";
|
||||||
|
|
||||||
|
@ -43,7 +43,7 @@ import { Action as TelemetryAction, ActionModifiers } from "../../../Shared/Tele
|
|||||||
import { CdbAppState } from "./types";
|
import { CdbAppState } from "./types";
|
||||||
import { decryptJWTToken } from "../../../Utils/AuthorizationUtils";
|
import { decryptJWTToken } from "../../../Utils/AuthorizationUtils";
|
||||||
import * as TextFile from "./contents/file/text-file";
|
import * as TextFile from "./contents/file/text-file";
|
||||||
import { NotebookUtil } from "../NotebookUtil";
|
import * as NotebookUtil from "../NotebookUtil";
|
||||||
import { FileSystemUtil } from "../FileSystemUtil";
|
import { FileSystemUtil } from "../FileSystemUtil";
|
||||||
import * as cdbActions from "../NotebookComponent/actions";
|
import * as cdbActions from "../NotebookComponent/actions";
|
||||||
import { Areas } from "../../../Common/Constants";
|
import { Areas } from "../../../Common/Constants";
|
||||||
|
@ -2,7 +2,7 @@ import * as DataModels from "../../Contracts/DataModels";
|
|||||||
import { NotebookContentItem, NotebookContentItemType } from "./NotebookContentItem";
|
import { NotebookContentItem, NotebookContentItemType } from "./NotebookContentItem";
|
||||||
import { StringUtils } from "../../Utils/StringUtils";
|
import { StringUtils } from "../../Utils/StringUtils";
|
||||||
import { FileSystemUtil } from "./FileSystemUtil";
|
import { FileSystemUtil } from "./FileSystemUtil";
|
||||||
import { NotebookUtil } from "./NotebookUtil";
|
import * as NotebookUtil from "./NotebookUtil";
|
||||||
|
|
||||||
import { ServerConfig, IContent, IContentProvider, FileType, IEmptyContent } from "@nteract/core";
|
import { ServerConfig, IContent, IContentProvider, FileType, IEmptyContent } from "@nteract/core";
|
||||||
import { AjaxResponse } from "rxjs/ajax";
|
import { AjaxResponse } from "rxjs/ajax";
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
import { NotebookUtil } from "./NotebookUtil";
|
import * as NotebookUtil from "./NotebookUtil";
|
||||||
import * as GitHubUtils from "../../Utils/GitHubUtils";
|
import * as GitHubUtils from "../../Utils/GitHubUtils";
|
||||||
import {
|
import {
|
||||||
ImmutableNotebook,
|
ImmutableNotebook,
|
||||||
|
@ -7,157 +7,155 @@ import * as GitHubUtils from "../../Utils/GitHubUtils";
|
|||||||
// Must match rx-jupyter' FileType
|
// Must match rx-jupyter' FileType
|
||||||
export type FileType = "directory" | "file" | "notebook";
|
export type FileType = "directory" | "file" | "notebook";
|
||||||
// Utilities for notebooks
|
// Utilities for notebooks
|
||||||
export class NotebookUtil {
|
/**
|
||||||
/**
|
* It's a notebook file if the filename ends with .ipynb.
|
||||||
* It's a notebook file if the filename ends with .ipynb.
|
*/
|
||||||
*/
|
export function isNotebookFile(notebookPath: string): boolean {
|
||||||
public static isNotebookFile(notebookPath: string): boolean {
|
const fileName = getName(notebookPath);
|
||||||
const fileName = NotebookUtil.getName(notebookPath);
|
return !!fileName && StringUtils.endsWith(fileName, ".ipynb");
|
||||||
return !!fileName && StringUtils.endsWith(fileName, ".ipynb");
|
}
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Note: this does not connect the item to a parent in a tree.
|
* Note: this does not connect the item to a parent in a tree.
|
||||||
* @param name
|
* @param name
|
||||||
* @param path
|
* @param path
|
||||||
*/
|
*/
|
||||||
public static createNotebookContentItem(name: string, path: string, type: FileType): NotebookContentItem {
|
export function createNotebookContentItem(name: string, path: string, type: FileType): NotebookContentItem {
|
||||||
return {
|
return {
|
||||||
name,
|
name,
|
||||||
path,
|
path,
|
||||||
type: NotebookUtil.getType(type),
|
type: getType(type),
|
||||||
timestamp: NotebookUtil.getCurrentTimestamp(),
|
timestamp: getCurrentTimestamp(),
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Convert rx-jupyter type to our type
|
* Convert rx-jupyter type to our type
|
||||||
* @param type
|
* @param type
|
||||||
*/
|
*/
|
||||||
public static getType(type: FileType): NotebookContentItemType {
|
export function getType(type: FileType): NotebookContentItemType {
|
||||||
switch (type) {
|
switch (type) {
|
||||||
case "directory":
|
case "directory":
|
||||||
return NotebookContentItemType.Directory;
|
return NotebookContentItemType.Directory;
|
||||||
case "notebook":
|
case "notebook":
|
||||||
return NotebookContentItemType.Notebook;
|
return NotebookContentItemType.Notebook;
|
||||||
case "file":
|
case "file":
|
||||||
return NotebookContentItemType.File;
|
return NotebookContentItemType.File;
|
||||||
default:
|
default:
|
||||||
throw new Error(`Unknown file type: ${type}`);
|
throw new Error(`Unknown file type: ${type}`);
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public static getCurrentTimestamp(): number {
|
|
||||||
return new Date().getTime();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Override from kernel-lifecycle.ts to improve kernel selection:
|
|
||||||
* Only return the kernel name persisted in the notebook
|
|
||||||
*
|
|
||||||
* @param filepath
|
|
||||||
* @param notebook
|
|
||||||
*/
|
|
||||||
public static extractNewKernel(filepath: string | null, notebook: ImmutableNotebook) {
|
|
||||||
const cwd = (filepath && path.dirname(filepath)) || "/";
|
|
||||||
|
|
||||||
const kernelSpecName =
|
|
||||||
notebook.getIn(["metadata", "kernelspec", "name"]) || notebook.getIn(["metadata", "language_info", "name"]);
|
|
||||||
|
|
||||||
return {
|
|
||||||
cwd,
|
|
||||||
kernelSpecName,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
public static getFilePath(path: string, fileName: string): string {
|
|
||||||
const contentInfo = GitHubUtils.fromContentUri(path);
|
|
||||||
if (contentInfo) {
|
|
||||||
let path = fileName;
|
|
||||||
if (contentInfo.path) {
|
|
||||||
path = `${contentInfo.path}/${path}`;
|
|
||||||
}
|
|
||||||
return GitHubUtils.toContentUri(contentInfo.owner, contentInfo.repo, contentInfo.branch, path);
|
|
||||||
}
|
|
||||||
|
|
||||||
return `${path}/${fileName}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
public static getParentPath(filepath: string): undefined | string {
|
|
||||||
const basename = NotebookUtil.getName(filepath);
|
|
||||||
if (basename) {
|
|
||||||
const contentInfo = GitHubUtils.fromContentUri(filepath);
|
|
||||||
if (contentInfo) {
|
|
||||||
const parentPath = contentInfo.path.split(basename).shift();
|
|
||||||
if (parentPath === undefined) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
return GitHubUtils.toContentUri(
|
|
||||||
contentInfo.owner,
|
|
||||||
contentInfo.repo,
|
|
||||||
contentInfo.branch,
|
|
||||||
parentPath.replace(/\/$/, "") // no trailling slash
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
const parentPath = filepath.split(basename).shift();
|
|
||||||
if (parentPath) {
|
|
||||||
return parentPath.replace(/\/$/, ""); // no trailling slash
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
public static getName(path: string): undefined | string {
|
|
||||||
let relativePath: string = path;
|
|
||||||
const contentInfo = GitHubUtils.fromContentUri(path);
|
|
||||||
if (contentInfo) {
|
|
||||||
relativePath = contentInfo.path;
|
|
||||||
}
|
|
||||||
|
|
||||||
return relativePath.split("/").pop();
|
|
||||||
}
|
|
||||||
|
|
||||||
public static replaceName(path: string, newName: string): string {
|
|
||||||
const contentInfo = GitHubUtils.fromContentUri(path);
|
|
||||||
if (contentInfo) {
|
|
||||||
const contentName = contentInfo.path.split("/").pop();
|
|
||||||
if (!contentName) {
|
|
||||||
throw new Error(`Failed to extract name from github path ${contentInfo.path}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
const basePath = contentInfo.path.split(contentName).shift();
|
|
||||||
return GitHubUtils.toContentUri(contentInfo.owner, contentInfo.repo, contentInfo.branch, `${basePath}${newName}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
const contentName = path.split("/").pop();
|
|
||||||
if (!contentName) {
|
|
||||||
throw new Error(`Failed to extract name from path ${path}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
const basePath = path.split(contentName).shift();
|
|
||||||
return `${basePath}${newName}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
public static findFirstCodeCellWithDisplay(notebookObject: ImmutableNotebook): number {
|
|
||||||
let codeCellIndex = 0;
|
|
||||||
for (let i = 0; i < notebookObject.cellOrder.size; i++) {
|
|
||||||
const cellId = notebookObject.cellOrder.get(i);
|
|
||||||
if (cellId) {
|
|
||||||
const cell = notebookObject.cellMap.get(cellId);
|
|
||||||
if (cell?.cell_type === "code") {
|
|
||||||
const displayOutput = (cell as ImmutableCodeCell)?.outputs?.find(
|
|
||||||
(output) => output.output_type === "display_data" || output.output_type === "execute_result"
|
|
||||||
);
|
|
||||||
if (displayOutput) {
|
|
||||||
return codeCellIndex;
|
|
||||||
}
|
|
||||||
codeCellIndex++;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
throw new Error("Output does not exist for any of the cells.");
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function getCurrentTimestamp(): number {
|
||||||
|
return new Date().getTime();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Override from kernel-lifecycle.ts to improve kernel selection:
|
||||||
|
* Only return the kernel name persisted in the notebook
|
||||||
|
*
|
||||||
|
* @param filepath
|
||||||
|
* @param notebook
|
||||||
|
*/
|
||||||
|
export function extractNewKernel(filepath: string | null, notebook: ImmutableNotebook) {
|
||||||
|
const cwd = (filepath && path.dirname(filepath)) || "/";
|
||||||
|
|
||||||
|
const kernelSpecName =
|
||||||
|
notebook.getIn(["metadata", "kernelspec", "name"]) || notebook.getIn(["metadata", "language_info", "name"]);
|
||||||
|
|
||||||
|
return {
|
||||||
|
cwd,
|
||||||
|
kernelSpecName,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getFilePath(path: string, fileName: string): string {
|
||||||
|
const contentInfo = GitHubUtils.fromContentUri(path);
|
||||||
|
if (contentInfo) {
|
||||||
|
let path = fileName;
|
||||||
|
if (contentInfo.path) {
|
||||||
|
path = `${contentInfo.path}/${path}`;
|
||||||
|
}
|
||||||
|
return GitHubUtils.toContentUri(contentInfo.owner, contentInfo.repo, contentInfo.branch, path);
|
||||||
|
}
|
||||||
|
|
||||||
|
return `${path}/${fileName}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getParentPath(filepath: string): undefined | string {
|
||||||
|
const basename = getName(filepath);
|
||||||
|
if (basename) {
|
||||||
|
const contentInfo = GitHubUtils.fromContentUri(filepath);
|
||||||
|
if (contentInfo) {
|
||||||
|
const parentPath = contentInfo.path.split(basename).shift();
|
||||||
|
if (parentPath === undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
return GitHubUtils.toContentUri(
|
||||||
|
contentInfo.owner,
|
||||||
|
contentInfo.repo,
|
||||||
|
contentInfo.branch,
|
||||||
|
parentPath.replace(/\/$/, "") // no trailling slash
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const parentPath = filepath.split(basename).shift();
|
||||||
|
if (parentPath) {
|
||||||
|
return parentPath.replace(/\/$/, ""); // no trailling slash
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getName(path: string): undefined | string {
|
||||||
|
let relativePath: string = path;
|
||||||
|
const contentInfo = GitHubUtils.fromContentUri(path);
|
||||||
|
if (contentInfo) {
|
||||||
|
relativePath = contentInfo.path;
|
||||||
|
}
|
||||||
|
|
||||||
|
return relativePath.split("/").pop();
|
||||||
|
}
|
||||||
|
|
||||||
|
export function replaceName(path: string, newName: string): string {
|
||||||
|
const contentInfo = GitHubUtils.fromContentUri(path);
|
||||||
|
if (contentInfo) {
|
||||||
|
const contentName = contentInfo.path.split("/").pop();
|
||||||
|
if (!contentName) {
|
||||||
|
throw new Error(`Failed to extract name from github path ${contentInfo.path}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const basePath = contentInfo.path.split(contentName).shift();
|
||||||
|
return GitHubUtils.toContentUri(contentInfo.owner, contentInfo.repo, contentInfo.branch, `${basePath}${newName}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const contentName = path.split("/").pop();
|
||||||
|
if (!contentName) {
|
||||||
|
throw new Error(`Failed to extract name from path ${path}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const basePath = path.split(contentName).shift();
|
||||||
|
return `${basePath}${newName}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function findFirstCodeCellWithDisplay(notebookObject: ImmutableNotebook): number {
|
||||||
|
let codeCellIndex = 0;
|
||||||
|
for (let i = 0; i < notebookObject.cellOrder.size; i++) {
|
||||||
|
const cellId = notebookObject.cellOrder.get(i);
|
||||||
|
if (cellId) {
|
||||||
|
const cell = notebookObject.cellMap.get(cellId);
|
||||||
|
if (cell?.cell_type === "code") {
|
||||||
|
const displayOutput = (cell as ImmutableCodeCell)?.outputs?.find(
|
||||||
|
(output) => output.output_type === "display_data" || output.output_type === "execute_result"
|
||||||
|
);
|
||||||
|
if (displayOutput) {
|
||||||
|
return codeCellIndex;
|
||||||
|
}
|
||||||
|
codeCellIndex++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
throw new Error("Output does not exist for any of the cells.");
|
||||||
|
}
|
||||||
|
@ -5,7 +5,7 @@ import { FileSystemUtil } from "../Notebook/FileSystemUtil";
|
|||||||
import "./PublishNotebookPaneComponent.less";
|
import "./PublishNotebookPaneComponent.less";
|
||||||
import Html2Canvas from "html2canvas";
|
import Html2Canvas from "html2canvas";
|
||||||
import { ImmutableNotebook } from "@nteract/commutable/src";
|
import { ImmutableNotebook } from "@nteract/commutable/src";
|
||||||
import { NotebookUtil } from "../Notebook/NotebookUtil";
|
import * as NotebookUtil from "../Notebook/NotebookUtil";
|
||||||
|
|
||||||
export interface PublishNotebookPaneProps {
|
export interface PublishNotebookPaneProps {
|
||||||
notebookName: string;
|
notebookName: string;
|
||||||
|
@ -17,7 +17,7 @@ import NewNotebookIcon from "../../../images/notebook/Notebook-new.svg";
|
|||||||
import FileIcon from "../../../images/notebook/file-cosmos.svg";
|
import FileIcon from "../../../images/notebook/file-cosmos.svg";
|
||||||
import PublishIcon from "../../../images/notebook/publish_content.svg";
|
import PublishIcon from "../../../images/notebook/publish_content.svg";
|
||||||
import { ArrayHashMap } from "../../Common/ArrayHashMap";
|
import { ArrayHashMap } from "../../Common/ArrayHashMap";
|
||||||
import { NotebookUtil } from "../Notebook/NotebookUtil";
|
import * as NotebookUtil from "../Notebook/NotebookUtil";
|
||||||
import _ from "underscore";
|
import _ from "underscore";
|
||||||
import { IPinnedRepo } from "../../Juno/JunoClient";
|
import { IPinnedRepo } from "../../Juno/JunoClient";
|
||||||
import * as TelemetryProcessor from "../../Shared/Telemetry/TelemetryProcessor";
|
import * as TelemetryProcessor from "../../Shared/Telemetry/TelemetryProcessor";
|
||||||
|
@ -2,7 +2,7 @@ import { Octokit } from "@octokit/rest";
|
|||||||
import { HttpStatusCodes } from "../Common/Constants";
|
import { HttpStatusCodes } from "../Common/Constants";
|
||||||
import * as Logger from "../Common/Logger";
|
import * as Logger from "../Common/Logger";
|
||||||
import UrlUtility from "../Common/UrlUtility";
|
import UrlUtility from "../Common/UrlUtility";
|
||||||
import { NotebookUtil } from "../Explorer/Notebook/NotebookUtil";
|
import * as NotebookUtil from "../Explorer/Notebook/NotebookUtil";
|
||||||
import { getErrorMessage } from "../Common/ErrorHandlingUtils";
|
import { getErrorMessage } from "../Common/ErrorHandlingUtils";
|
||||||
|
|
||||||
export interface IGitHubPageInfo {
|
export interface IGitHubPageInfo {
|
||||||
|
@ -5,7 +5,7 @@ import { AjaxResponse } from "rxjs/ajax";
|
|||||||
import * as Base64Utils from "../Utils/Base64Utils";
|
import * as Base64Utils from "../Utils/Base64Utils";
|
||||||
import { HttpStatusCodes } from "../Common/Constants";
|
import { HttpStatusCodes } from "../Common/Constants";
|
||||||
import * as Logger from "../Common/Logger";
|
import * as Logger from "../Common/Logger";
|
||||||
import { NotebookUtil } from "../Explorer/Notebook/NotebookUtil";
|
import * as NotebookUtil from "../Explorer/Notebook/NotebookUtil";
|
||||||
import { GitHubClient, IGitHubFile, IGitHubResponse } from "./GitHubClient";
|
import { GitHubClient, IGitHubFile, IGitHubResponse } from "./GitHubClient";
|
||||||
import * as GitHubUtils from "../Utils/GitHubUtils";
|
import * as GitHubUtils from "../Utils/GitHubUtils";
|
||||||
import UrlUtility from "../Common/UrlUtility";
|
import UrlUtility from "../Common/UrlUtility";
|
||||||
|
Loading…
x
Reference in New Issue
Block a user