Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Task: Display client/plugin name on API explorer #4801

Merged
merged 8 commits into from
Jun 13, 2024
Merged

Task: Display client/plugin name on API explorer #4801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9058009
display client or plugin name
ElinorW Jun 10, 2024
41f0957
enable node selection
ElinorW Jun 10, 2024
78923d1
fix indentation
ElinorW Jun 11, 2024
afd4833
add client/plugin name after generation
ElinorW Jun 12, 2024
b98b705
update interface
ElinorW Jun 13, 2024
276fdef
declare lockfile constant
ElinorW Jun 13, 2024
ec83365
Merge branch 'elinor/add-kiota-workspace' into elinor/display-client-…
ElinorW Jun 13, 2024
2e08478
make property required
ElinorW Jun 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions vscode/microsoft-kiota/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,22 +271,22 @@
},
{
"command": "kiota.openApiExplorer.addToSelectedEndpoints",
"when": "view == kiota.openApiExplorer && viewItem != apiTitle",
"when": "view == kiota.openApiExplorer && viewItem != apiTitle && viewItem != clientNameOrPluginName",
"group": "inline@2"
},
{
"command": "kiota.openApiExplorer.addAllToSelectedEndpoints",
"when": "view == kiota.openApiExplorer",
"when": "view == kiota.openApiExplorer && viewItem != clientNameOrPluginName",
"group": "inline@4"
},
{
"command": "kiota.openApiExplorer.removeFromSelectedEndpoints",
"when": "view == kiota.openApiExplorer && viewItem != apiTitle",
"when": "view == kiota.openApiExplorer && viewItem != apiTitle && viewItem != clientNameOrPluginName",
"group": "inline@3"
},
{
"command": "kiota.openApiExplorer.removeAllFromSelectedEndpoints",
"when": "view == kiota.openApiExplorer",
"when": "view == kiota.openApiExplorer && viewItem != clientNameOrPluginName",
"group": "inline@5"
}
],
Expand Down
19 changes: 13 additions & 6 deletions vscode/microsoft-kiota/src/extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ export async function activate(
kiotaOutputChannel = vscode.window.createOutputChannel("Kiota", {
log: true,
});
const workspaceJsonPath = path.join(vscode.workspace.workspaceFolders?.map(folder => folder.uri.fsPath).join('') || '', KIOTA_DIRECTORY, KIOTA_WORKSPACE_FILE);
const openApiTreeProvider = new OpenApiTreeProvider(context, () => getExtensionSettings(extensionId));
const dependenciesInfoProvider = new DependenciesViewProvider(
context.extensionUri
Expand Down Expand Up @@ -225,7 +226,7 @@ export async function activate(
clientOrPluginKey = clientKey;
clientOrPluginObject = clientObject;
workspaceGenerationType = generationType;
await loadEditPaths(clientObject, openApiTreeProvider);
await loadEditPaths(clientOrPluginKey, clientObject, openApiTreeProvider);
ElinorW marked this conversation as resolved.
Show resolved Hide resolved
await vscode.commands.executeCommand('setContext',`${treeViewId}.showIcons`, false);
await vscode.commands.executeCommand('setContext', `${treeViewId}.showRegenerateIcon`, true);
}),
Expand Down Expand Up @@ -300,6 +301,8 @@ export async function activate(
if (result)
{
await checkForSuccess(result);
openApiTreeProvider.refreshView();
await loadLockFile({fsPath: workspaceJsonPath}, openApiTreeProvider, config.pluginName);
await exportLogsAndShowErrors(result);
}
}
Expand Down Expand Up @@ -339,6 +342,8 @@ export async function activate(
if (result)
{
await checkForSuccess(result);
openApiTreeProvider.refreshView();
await loadLockFile({fsPath: workspaceJsonPath}, openApiTreeProvider, config.pluginName);
await exportLogsAndShowErrors(result);
}
}
Expand Down Expand Up @@ -402,11 +407,13 @@ export async function activate(
result && getLogEntriesForLevel(result, LogLevel.critical, LogLevel.error).length === 0) {
const WORKSPACE_FOLDER = vscode.workspace.workspaceFolders[0].uri.fsPath;
const KIOTA_WORKSPACE_PATH = path.join(WORKSPACE_FOLDER, KIOTA_DIRECTORY, KIOTA_WORKSPACE_FILE);
await openApiTreeProvider.loadLockFile(KIOTA_WORKSPACE_PATH);
await openApiTreeProvider.loadLockFile(KIOTA_WORKSPACE_PATH, config.clientClassName);
}
if (result)
{
await checkForSuccess(result);
openApiTreeProvider.refreshView();
await loadLockFile({fsPath: workspaceJsonPath}, openApiTreeProvider, config.clientClassName);
await exportLogsAndShowErrors(result);
}
}
Expand Down Expand Up @@ -574,13 +581,13 @@ async function showUpgradeWarningMessage(clientPath: string, context: vscode.Ext
}
}

async function loadLockFile(node: { fsPath: string }, openApiTreeProvider: OpenApiTreeProvider): Promise<void> {
await openTreeViewWithProgress(() => openApiTreeProvider.loadLockFile(node.fsPath));
async function loadLockFile(node: { fsPath: string }, openApiTreeProvider: OpenApiTreeProvider, clientOrPluginName?: string): Promise<void> {
await openTreeViewWithProgress(() => openApiTreeProvider.loadLockFile(node.fsPath, clientOrPluginName));
await vscode.commands.executeCommand('setContext',`${treeViewId}.showIcons`, true);
}

async function loadEditPaths(clientObject: any, openApiTreeProvider: OpenApiTreeProvider): Promise<void> {
await openTreeViewWithProgress(() => openApiTreeProvider.loadEditPaths(clientObject));
async function loadEditPaths(clientOrPluginKey: string, clientObject: any, openApiTreeProvider: OpenApiTreeProvider): Promise<void> {
await openTreeViewWithProgress(() => openApiTreeProvider.loadEditPaths(clientOrPluginKey, clientObject));
}

async function exportLogsAndShowErrors(result: KiotaLogEntry[]) : Promise<void> {
Expand Down
26 changes: 7 additions & 19 deletions vscode/microsoft-kiota/src/kiotaInterop.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export interface KiotaOpenApiNode {
selected?: boolean,
isOperation?: boolean;
documentationUrl?: string;
clientNameOrPluginName?: string;
}
interface CacheClearableConfiguration {
clearCache: boolean;
Expand Down Expand Up @@ -253,23 +254,10 @@ export function maturityLevelToString(level: MaturityLevel): string {
throw new Error("unknown level");
}
}
export interface LockFile {
clientClassName: string;
clientNamespaceName: string;
descriptionHash: string;
descriptionLocation: string;
deserializers: string[];
disabledValidationRules: string[];
excludeBackwardCompatible: boolean;
excludePatterns: string[];
includeAdditionalData: boolean;
includePatterns: string[];
kiotaVersion: string;
language: string;
lockFileVersion: string;
serializers: string[];
structuredMimeTypes: string[];
usesBackingStore: boolean;
export interface ConfigurationFile {
version: string;
clients: Record<string, ClientObjectProperties>;
plugins: Record<string, PluginObjectProperties>;
}

export interface GenerationConfiguration {
Expand Down Expand Up @@ -300,7 +288,7 @@ interface WorkspaceObjectProperties {
outputPath: string;
}

interface ClientObjectProperties extends WorkspaceObjectProperties {
export interface ClientObjectProperties extends WorkspaceObjectProperties {
language: string;
structuredMimeTypes: string[];
clientNamespaceName: string;
Expand All @@ -310,7 +298,7 @@ interface ClientObjectProperties extends WorkspaceObjectProperties {
disabledValidationRules: string[];
}

interface PluginObjectProperties extends WorkspaceObjectProperties {
export interface PluginObjectProperties extends WorkspaceObjectProperties {
types: string[];
}

Expand Down
Loading
Loading