From a9eca07f0e461ca3a7863508579e458afed20075 Mon Sep 17 00:00:00 2001 From: Marwan Zaarab Date: Wed, 3 Apr 2024 17:33:13 -0500 Subject: [PATCH] Run Format/lint scripts --- src/commands/pipelines/registry.ts | 13 ++++-- src/commands/stack/registry.ts | 5 ++- src/common/python.ts | 22 +++++----- src/services/ZenExtension.ts | 4 +- src/types/PipelineTypes.ts | 1 - src/types/StackTypes.ts | 2 +- src/views/activityBar/common/ErrorTreeItem.ts | 10 ++--- .../activityBar/common/PaginationTreeItems.ts | 8 ++-- .../EnvironmentDataProvider.ts | 12 ++++-- .../environmentView/viewHelpers.ts | 13 +++--- .../pipelineView/PipelineDataProvider.ts | 41 ++++++++++++++----- .../serverView/ServerDataProvider.ts | 5 ++- .../activityBar/serverView/ServerTreeItems.ts | 14 +++++-- .../stackView/StackDataProvider.ts | 39 ++++++++++++------ src/views/statusBar/index.ts | 14 +++---- 15 files changed, 131 insertions(+), 72 deletions(-) diff --git a/src/commands/pipelines/registry.ts b/src/commands/pipelines/registry.ts index 88b18159..fbbfb80d 100644 --- a/src/commands/pipelines/registry.ts +++ b/src/commands/pipelines/registry.ts @@ -34,9 +34,16 @@ export const registerPipelineCommands = (context: ExtensionContext) => { 'zenml.deletePipelineRun', async (node: PipelineTreeItem) => await pipelineCommands.deletePipelineRun(node) ), - registerCommand('zenml.nextPipelineRunsPage', async () => pipelineDataProvider.goToNextPage()), - registerCommand('zenml.previousPipelineRunsPage', async () => pipelineDataProvider.goToPreviousPage()), - registerCommand("zenml.setPipelineRunsPerPage", async () => await pipelineDataProvider.updateItemsPerPage()), + registerCommand('zenml.nextPipelineRunsPage', async () => + pipelineDataProvider.goToNextPage() + ), + registerCommand('zenml.previousPipelineRunsPage', async () => + pipelineDataProvider.goToPreviousPage() + ), + registerCommand( + 'zenml.setPipelineRunsPerPage', + async () => await pipelineDataProvider.updateItemsPerPage() + ), ]; registeredCommands.forEach(cmd => { diff --git a/src/commands/stack/registry.ts b/src/commands/stack/registry.ts index eba47594..b7626a64 100644 --- a/src/commands/stack/registry.ts +++ b/src/commands/stack/registry.ts @@ -25,7 +25,10 @@ export const registerStackCommands = (context: ExtensionContext) => { const stackDataProvider = StackDataProvider.getInstance(); try { const registeredCommands = [ - registerCommand("zenml.setStackItemsPerPage", async () => await stackDataProvider.updateItemsPerPage()), + registerCommand( + 'zenml.setStackItemsPerPage', + async () => await stackDataProvider.updateItemsPerPage() + ), registerCommand('zenml.refreshStackView', async () => await stackCommands.refreshStackView()), registerCommand( 'zenml.refreshActiveStack', diff --git a/src/common/python.ts b/src/common/python.ts index a171834b..a873f984 100644 --- a/src/common/python.ts +++ b/src/common/python.ts @@ -35,7 +35,7 @@ async function getPythonExtensionAPI(): Promise { /** * Initialize the python extension. - * + * * @param disposables - List of disposables to be disposed when the extension is deactivated. */ export async function initializePython(disposables: Disposable[]): Promise { @@ -57,12 +57,12 @@ export async function initializePython(disposables: Disposable[]): Promise } } -/** +/** * Resolve the python interpreter. - * + * * @param interpreter - The interpreter to resolve. * @returns The resolved environment. -*/ + */ export async function resolveInterpreter( interpreter: string[] ): Promise { @@ -72,7 +72,7 @@ export async function resolveInterpreter( /** * Get the interpreter details. - * + * * @param resource - The resource to get the interpreter details from. * @returns The interpreter details. */ @@ -89,7 +89,7 @@ export async function getInterpreterDetails(resource?: Uri): Promise { @@ -99,7 +99,7 @@ export async function getDebuggerPath(): Promise { /** * Run a python extension command. - * + * * @param command - The command to run. * @param rest - The rest of the arguments. * @returns The result of the command. @@ -111,7 +111,7 @@ export async function runPythonExtensionCommand(command: string, ...rest: any[]) /** * Check if the python version is supported. - * + * * @param resolved - The resolved environment. * @returns True if the version is supported, false otherwise. */ @@ -127,12 +127,12 @@ export function checkVersion(resolved: ResolvedEnvironment | undefined): boolean return false; } -/** +/** * Check if the python version is supported. - * + * * @param resolvedEnv - The resolved environment. * @returns An object with the result and an optional message. -*/ + */ export function isPythonVersionSupported(resolvedEnv: ResolvedEnvironment | undefined): { isSupported: boolean; message?: string; diff --git a/src/services/ZenExtension.ts b/src/services/ZenExtension.ts index 7d1f1f48..69f6cc73 100644 --- a/src/services/ZenExtension.ts +++ b/src/services/ZenExtension.ts @@ -22,7 +22,7 @@ import { registerLogger, traceLog, traceVerbose } from '../common/log/logging'; import { IInterpreterDetails, initializePython, - isPythonVersonSupported, + isPythonVersionSupported, onDidChangePythonInterpreter, resolveInterpreter, } from '../common/python'; @@ -132,7 +132,7 @@ export class ZenExtension { this.interpreterCheckInProgress = true; if (interpreterDetails.path) { const resolvedEnv = await resolveInterpreter(interpreterDetails.path); - const { isSupported, message } = isPythonVersonSupported(resolvedEnv); + const { isSupported, message } = isPythonVersionSupported(resolvedEnv); if (!isSupported) { vscode.window.showErrorMessage(`Interpreter not supported: ${message}`); this.interpreterCheckInProgress = false; diff --git a/src/types/PipelineTypes.ts b/src/types/PipelineTypes.ts index 96ca4930..17f1a7fb 100644 --- a/src/types/PipelineTypes.ts +++ b/src/types/PipelineTypes.ts @@ -13,7 +13,6 @@ import { ErrorMessageResponse, VersionMismatchError } from './LSClientResponseTypes'; - interface PipelineRunsData { runs: PipelineRun[]; total: number; diff --git a/src/types/StackTypes.ts b/src/types/StackTypes.ts index ca487dd5..5ada4087 100644 --- a/src/types/StackTypes.ts +++ b/src/types/StackTypes.ts @@ -42,6 +42,6 @@ interface StackComponent { type: string; } -export type StacksReponse = StacksData | ErrorMessageResponse | VersionMismatchError; +export type StacksResponse = StacksData | ErrorMessageResponse | VersionMismatchError; export { Stack, Components, StackComponent, StacksData }; diff --git a/src/views/activityBar/common/ErrorTreeItem.ts b/src/views/activityBar/common/ErrorTreeItem.ts index fa64b422..86bf4c14 100644 --- a/src/views/activityBar/common/ErrorTreeItem.ts +++ b/src/views/activityBar/common/ErrorTreeItem.ts @@ -48,16 +48,16 @@ export const createErrorItem = (error: any): TreeItem[] => { /** * Creates an error item for authentication errors. - * + * * @param errorMessage The error message to parse. * @returns The error tree item(s), */ export const createAuthErrorItem = (errorMessage: string): ErrorTreeItem[] => { const parts = errorMessage.split(':').map(part => part.trim()); - let generalError = ""; - let detailedError = ""; - let actionSuggestion = ""; + let generalError = ''; + let detailedError = ''; + let actionSuggestion = ''; if (parts.length > 2) { generalError = parts[0]; // "Failed to retrieve pipeline runs" @@ -76,4 +76,4 @@ export const createAuthErrorItem = (errorMessage: string): ErrorTreeItem[] => { } return errorItems; -} \ No newline at end of file +}; diff --git a/src/views/activityBar/common/PaginationTreeItems.ts b/src/views/activityBar/common/PaginationTreeItems.ts index fd337ab0..59ce4c20 100644 --- a/src/views/activityBar/common/PaginationTreeItems.ts +++ b/src/views/activityBar/common/PaginationTreeItems.ts @@ -36,11 +36,11 @@ export class CommandTreeItem extends TreeItem { export class SetItemsPerPageTreeItem extends TreeItem { constructor() { - super("Set items per page", TreeItemCollapsibleState.None); - this.tooltip = "Click to set the number of items shown per page"; + super('Set items per page', TreeItemCollapsibleState.None); + this.tooltip = 'Click to set the number of items shown per page'; this.command = { - command: "zenml.setStacksPerPage", - title: "Set Stack Items Per Page", + command: 'zenml.setStacksPerPage', + title: 'Set Stack Items Per Page', arguments: [], }; } diff --git a/src/views/activityBar/environmentView/EnvironmentDataProvider.ts b/src/views/activityBar/environmentView/EnvironmentDataProvider.ts index 213e682d..215773a5 100644 --- a/src/views/activityBar/environmentView/EnvironmentDataProvider.ts +++ b/src/views/activityBar/environmentView/EnvironmentDataProvider.ts @@ -13,7 +13,12 @@ import { EventEmitter, TreeDataProvider, TreeItem } from 'vscode'; import { State } from 'vscode-languageclient'; import { EventBus } from '../../../services/EventBus'; -import { LSCLIENT_STATE_CHANGED, LSP_IS_ZENML_INSTALLED, REFRESH_ENVIRONMENT_VIEW, LSP_ZENML_CLIENT_INITIALIZED } from '../../../utils/constants'; +import { + LSCLIENT_STATE_CHANGED, + LSP_IS_ZENML_INSTALLED, + REFRESH_ENVIRONMENT_VIEW, + LSP_ZENML_CLIENT_INITIALIZED, +} from '../../../utils/constants'; import { EnvironmentItem } from './EnvironmentItem'; import { createInterpreterDetails, @@ -46,7 +51,6 @@ export class EnvironmentDataProvider implements TreeDataProvider { this.eventBus.on(REFRESH_ENVIRONMENT_VIEW, this.refresh.bind(this)); } - /** * Retrieves the singleton instance of ServerDataProvider. * @@ -60,8 +64,8 @@ export class EnvironmentDataProvider implements TreeDataProvider { } /** - * Explicitly trigger loading state for ZenML installation check and ZenML client initialization. - */ + * Explicitly trigger loading state for ZenML installation check and ZenML client initialization. + */ private triggerLoadingStateForZenMLChecks() { this.zenmlClientReady = false; this.zenmlInstallationStatus = null; diff --git a/src/views/activityBar/environmentView/viewHelpers.ts b/src/views/activityBar/environmentView/viewHelpers.ts index a90bad3c..ef3f0e28 100644 --- a/src/views/activityBar/environmentView/viewHelpers.ts +++ b/src/views/activityBar/environmentView/viewHelpers.ts @@ -32,7 +32,6 @@ export function createLSClientItem(lsClientStatus: State): EnvironmentItem { [State.Stopped]: { description: 'Stopped', icon: 'close' }, }; - const { description, icon } = statusMappings[lsClientStatus]; return new EnvironmentItem( @@ -52,7 +51,6 @@ export function createLSClientItem(lsClientStatus: State): EnvironmentItem { export function createZenMLClientStatusItem(zenmlClientReady: boolean): EnvironmentItem { const localZenML = LSClient.getInstance().localZenML; - const zenMLClientStatusItem = new EnvironmentItem( 'ZenML Client', !localZenML.is_installed ? '' : zenmlClientReady ? 'Initialized' : 'Awaiting Initialization', @@ -65,11 +63,13 @@ export function createZenMLClientStatusItem(zenmlClientReady: boolean): Environm /** * Creates the ZenML installation item for the environment view. - * + * * @param installationStatus The installation status of ZenML. * @returns {EnvironmentItem} The ZenML installation item. */ -export function createZenMLInstallationItem(installationStatus: LSNotificationIsZenMLInstalled | null): EnvironmentItem { +export function createZenMLInstallationItem( + installationStatus: LSNotificationIsZenMLInstalled | null +): EnvironmentItem { if (!installationStatus) { return new EnvironmentItem( 'ZenML Local Installation', @@ -79,7 +79,9 @@ export function createZenMLInstallationItem(installationStatus: LSNotificationIs ); } - const description = installationStatus.is_installed ? `Installed (v${installationStatus.version})` : 'Not Installed'; + const description = installationStatus.is_installed + ? `Installed (v${installationStatus.version})` + : 'Not Installed'; const icon = installationStatus.is_installed ? 'check' : 'warning'; return new EnvironmentItem( @@ -90,7 +92,6 @@ export function createZenMLInstallationItem(installationStatus: LSNotificationIs ); } - /** * Creates the workspace settings items for the environment view. * diff --git a/src/views/activityBar/pipelineView/PipelineDataProvider.ts b/src/views/activityBar/pipelineView/PipelineDataProvider.ts index da4d6608..f726fe16 100644 --- a/src/views/activityBar/pipelineView/PipelineDataProvider.ts +++ b/src/views/activityBar/pipelineView/PipelineDataProvider.ts @@ -45,7 +45,6 @@ export class PipelineDataProvider implements TreeDataProvider { totalPages: 0, }; - constructor() { this.subscribeToEvents(); } @@ -133,12 +132,29 @@ export class PipelineDataProvider implements TreeDataProvider { return this.pipelineRuns; } - const runs = await this.fetchPipelineRuns(this.pagination.currentPage, this.pagination.itemsPerPage); + const runs = await this.fetchPipelineRuns( + this.pagination.currentPage, + this.pagination.itemsPerPage + ); if (this.pagination.currentPage < this.pagination.totalPages) { - runs.push(new CommandTreeItem("Next Page", 'zenml.nextPipelineRunsPage', undefined, 'arrow-circle-right')); + runs.push( + new CommandTreeItem( + 'Next Page', + 'zenml.nextPipelineRunsPage', + undefined, + 'arrow-circle-right' + ) + ); } if (this.pagination.currentPage > 1) { - runs.unshift(new CommandTreeItem("Previous Page", 'zenml.previousPipelineRunsPage', undefined, 'arrow-circle-left')); + runs.unshift( + new CommandTreeItem( + 'Previous Page', + 'zenml.previousPipelineRunsPage', + undefined, + 'arrow-circle-left' + ) + ); } return runs; } else if (element instanceof PipelineTreeItem) { @@ -157,10 +173,10 @@ export class PipelineDataProvider implements TreeDataProvider { } try { const lsClient = LSClient.getInstance(); - const result = await lsClient.sendLsClientRequest( - 'getPipelineRuns', - [page, itemsPerPage] - ); + const result = await lsClient.sendLsClientRequest('getPipelineRuns', [ + page, + itemsPerPage, + ]); if (Array.isArray(result) && result.length === 1 && 'error' in result[0]) { const errorMessage = result[0].error; @@ -209,7 +225,12 @@ export class PipelineDataProvider implements TreeDataProvider { } } catch (error: any) { console.error(`Failed to fetch stacks: ${error}`); - return [new ErrorTreeItem("Error", `Failed to fetch pipeline runs: ${error.message || error.toString()}`)]; + return [ + new ErrorTreeItem( + 'Error', + `Failed to fetch pipeline runs: ${error.message || error.toString()}` + ), + ]; } } @@ -229,7 +250,7 @@ export class PipelineDataProvider implements TreeDataProvider { public async updateItemsPerPage() { const selected = await window.showQuickPick(ITEMS_PER_PAGE_OPTIONS, { - placeHolder: "Choose the max number of pipeline runs to display per page", + placeHolder: 'Choose the max number of pipeline runs to display per page', }); if (selected) { this.pagination.itemsPerPage = parseInt(selected, 10); diff --git a/src/views/activityBar/serverView/ServerDataProvider.ts b/src/views/activityBar/serverView/ServerDataProvider.ts index f0154e75..0b99d6ea 100644 --- a/src/views/activityBar/serverView/ServerDataProvider.ts +++ b/src/views/activityBar/serverView/ServerDataProvider.ts @@ -134,7 +134,10 @@ export class ServerDataProvider implements TreeDataProvider { getTreeItem(element: TreeItem): TreeItem { if (element instanceof ServerTreeItem) { if (element.serverStatus.isConnected) { - element.iconPath = new ThemeIcon('vm-active', new ThemeColor('gitDecoration.addedResourceForeground')); + element.iconPath = new ThemeIcon( + 'vm-active', + new ThemeColor('gitDecoration.addedResourceForeground') + ); } else { element.iconPath = new ThemeIcon('vm-connect'); } diff --git a/src/views/activityBar/serverView/ServerTreeItems.ts b/src/views/activityBar/serverView/ServerTreeItems.ts index 879e2f0e..a39d29a2 100644 --- a/src/views/activityBar/serverView/ServerTreeItems.ts +++ b/src/views/activityBar/serverView/ServerTreeItems.ts @@ -82,10 +82,14 @@ export class ServerTreeItem extends TreeItem { children.push(new ServerDetailTreeItem('Username', this.serverStatus.username, 'account')); } if (this.serverStatus.debug !== undefined) { - children.push(new ServerDetailTreeItem('Debug', this.serverStatus.debug ? 'true' : 'false', 'bug')); + children.push( + new ServerDetailTreeItem('Debug', this.serverStatus.debug ? 'true' : 'false', 'bug') + ); } if (this.serverStatus.auth_scheme) { - children.push(new ServerDetailTreeItem('Auth Scheme', this.serverStatus.auth_scheme, 'shield')); + children.push( + new ServerDetailTreeItem('Auth Scheme', this.serverStatus.auth_scheme, 'shield') + ); } // Specific to SQL Server Status if (this.serverStatus.database) { @@ -97,11 +101,13 @@ export class ServerTreeItem extends TreeItem { ); } if (this.serverStatus.backup_strategy) { - children.push(new ServerDetailTreeItem('Backup Strategy', this.serverStatus.backup_strategy, 'shield')); + children.push( + new ServerDetailTreeItem('Backup Strategy', this.serverStatus.backup_strategy, 'shield') + ); } return children; } contextValue = 'server'; -} \ No newline at end of file +} diff --git a/src/views/activityBar/stackView/StackDataProvider.ts b/src/views/activityBar/stackView/StackDataProvider.ts index bfe84841..782f3dbe 100644 --- a/src/views/activityBar/stackView/StackDataProvider.ts +++ b/src/views/activityBar/stackView/StackDataProvider.ts @@ -43,7 +43,6 @@ export class StackDataProvider implements TreeDataProvider { totalPages: 0, }; - constructor() { this.subscribeToEvents(); } @@ -124,17 +123,20 @@ export class StackDataProvider implements TreeDataProvider { * * @returns {Promise} A promise that resolves with an array of `StackTreeItem` objects. */ - async fetchStacksWithComponents(page: number = 1, itemsPerPage: number = 20): Promise { + async fetchStacksWithComponents( + page: number = 1, + itemsPerPage: number = 20 + ): Promise { if (!this.zenmlClientReady) { return [LOADING_TREE_ITEMS.get('zenmlClient')!]; } try { const lsClient = LSClient.getInstance(); - const result = await lsClient.sendLsClientRequest( - 'fetchStacks', - [page, itemsPerPage] - ); + const result = await lsClient.sendLsClientRequest('fetchStacks', [ + page, + itemsPerPage, + ]); if (Array.isArray(result) && result.length === 1 && 'error' in result[0]) { const errorMessage = result[0].error; @@ -171,8 +173,9 @@ export class StackDataProvider implements TreeDataProvider { } } catch (error: any) { console.error(`Failed to fetch stacks: ${error}`); - return [new ErrorTreeItem("Error", `Failed to fetch stacks: ${error.message || error.toString()}`)]; - + return [ + new ErrorTreeItem('Error', `Failed to fetch stacks: ${error.message || error.toString()}`), + ]; } } @@ -192,7 +195,7 @@ export class StackDataProvider implements TreeDataProvider { public async updateItemsPerPage() { const selected = await window.showQuickPick(ITEMS_PER_PAGE_OPTIONS, { - placeHolder: "Choose the max number of stacks to display per page", + placeHolder: 'Choose the max number of stacks to display per page', }); if (selected) { this.pagination.itemsPerPage = parseInt(selected, 10); @@ -213,12 +216,24 @@ export class StackDataProvider implements TreeDataProvider { return this.stacks; } - const stacks = await this.fetchStacksWithComponents(this.pagination.currentPage, this.pagination.itemsPerPage); + const stacks = await this.fetchStacksWithComponents( + this.pagination.currentPage, + this.pagination.itemsPerPage + ); if (this.pagination.currentPage < this.pagination.totalPages) { - stacks.push(new CommandTreeItem("Next Page", 'zenml.nextStackPage', undefined, 'arrow-circle-right')); + stacks.push( + new CommandTreeItem('Next Page', 'zenml.nextStackPage', undefined, 'arrow-circle-right') + ); } if (this.pagination.currentPage > 1) { - stacks.unshift(new CommandTreeItem("Previous Page", 'zenml.previousStackPage', undefined, 'arrow-circle-left')); + stacks.unshift( + new CommandTreeItem( + 'Previous Page', + 'zenml.previousStackPage', + undefined, + 'arrow-circle-left' + ) + ); } return stacks; } else if (element instanceof StackTreeItem) { diff --git a/src/views/statusBar/index.ts b/src/views/statusBar/index.ts index 2ffb122e..62c88514 100644 --- a/src/views/statusBar/index.ts +++ b/src/views/statusBar/index.ts @@ -22,7 +22,7 @@ import { LSP_ZENML_STACK_CHANGED, SERVER_STATUS_UPDATED } from '../../utils/cons export default class ZenMLStatusBar { private static instance: ZenMLStatusBar; private statusBarItem: StatusBarItem; - private currentStatus = { isConnected: false, serverUrl: '' } + private currentStatus = { isConnected: false, serverUrl: '' }; private activeStack: string = 'Loading...'; private eventBus = EventBus.getInstance(); @@ -84,11 +84,11 @@ export default class ZenMLStatusBar { } /** - * Updates the status bar item with the server status and active stack information. - * - * @param {boolean} isConnected Whether the server is currently connected. - * @param {string} serverUrl The url of the server, used in the tooltip. - */ + * Updates the status bar item with the server status and active stack information. + * + * @param {boolean} isConnected Whether the server is currently connected. + * @param {string} serverUrl The url of the server, used in the tooltip. + */ private updateStatusBarItem(isConnected: boolean, serverUrl: string) { this.statusBarItem.text = `⛩ ${this.activeStack}`; this.statusBarItem.tooltip = isConnected @@ -96,4 +96,4 @@ export default class ZenMLStatusBar { : 'ZenML server not running. Click to refresh status.'; this.statusBarItem.show(); } -} \ No newline at end of file +}