forked from bazel-contrib/vscode-bazel
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactoring: Move commands into a
command_variables.ts (bazel-contr…
…ib#348) * Refactoring: Move commands into a `command_variables.ts` This commit moves all the commands intended to be used as "comand variables" from the `extension.ts` into a new `command_variables.ts` file. This is a precursory refactoring before introducing additional command variables. * Correct copyright year
- Loading branch information
1 parent
6d3e988
commit 2180a4c
Showing
2 changed files
with
146 additions
and
118 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| // Copyright 2024 The Bazel Authors. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| import * as path from "path"; | ||
| import * as vscode from "vscode"; | ||
| import { getDefaultBazelExecutablePath } from "./configuration"; | ||
| import { BazelWorkspaceInfo } from "../bazel"; | ||
| import { BazelCQuery } from "../bazel/bazel_cquery"; | ||
| import { BazelInfo } from "../bazel/bazel_info"; | ||
|
|
||
| /** | ||
| * Get the output of the given target. | ||
| * | ||
| * If there are multiple outputs, a quick-pick window will be opened asking the | ||
| * user to choose one. | ||
| * | ||
| * The `bazel.getTargetOutput` command can be used in launch configurations to | ||
| * obtain the path to an executable built by Bazel. For example, you can set the | ||
| * "program" attribute of a launch configuration to an input variable: | ||
| * | ||
| * ``` | ||
| * "program": "${input:binaryOutputLocation}" | ||
| * ``` | ||
| * | ||
| * Then define a command input variable: | ||
| * | ||
| * ``` | ||
| * "inputs": [ | ||
| * { | ||
| * "id": "binaryOutputLocation", | ||
| * "type": "command", | ||
| * "command": "bazel.getTargetOutput", | ||
| * "args": ["//my/binary:target"], | ||
| * } | ||
| * ] | ||
| * ``` | ||
| * | ||
| * Additional Bazel flags can be provided: | ||
| * | ||
| * ``` | ||
| * "inputs": [ | ||
| * { | ||
| * "id": "debugOutputLocation", | ||
| * "type": "command", | ||
| * "command": "bazel.getTargetOutput", | ||
| * "args": ["//my/binary:target", ["--compilation_mode", "dbg"]], | ||
| * } | ||
| * ] | ||
| * ``` | ||
| */ | ||
| async function bazelGetTargetOutput( | ||
| target: string, | ||
| options: string[] = [], | ||
| ): Promise<string> { | ||
| // Workaround for https://github.com/microsoft/vscode/issues/167970 | ||
| if (Array.isArray(target)) { | ||
| options = (target[1] || []) as string[]; | ||
| target = target[0] as string; | ||
| } | ||
| const workspaceInfo = await BazelWorkspaceInfo.fromWorkspaceFolders(); | ||
| if (!workspaceInfo) { | ||
| // eslint-disable-next-line @typescript-eslint/no-floating-promises | ||
| vscode.window.showInformationMessage( | ||
| "Please open a Bazel workspace folder to use this command.", | ||
| ); | ||
|
|
||
| return; | ||
| } | ||
| const outputPath = await new BazelInfo( | ||
| getDefaultBazelExecutablePath(), | ||
| workspaceInfo.bazelWorkspacePath, | ||
| ).run("output_path"); | ||
| const outputs = await new BazelCQuery( | ||
| getDefaultBazelExecutablePath(), | ||
| workspaceInfo.bazelWorkspacePath, | ||
| ).queryOutputs(target, options); | ||
| switch (outputs.length) { | ||
| case 0: | ||
| throw new Error(`Target ${target} has no outputs.`); | ||
| case 1: | ||
| return path.join(outputPath, "..", outputs[0]); | ||
| default: | ||
| return await vscode.window.showQuickPick(outputs, { | ||
| placeHolder: `Pick an output of ${target}`, | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get the output of `bazel info` for the given key. | ||
| * | ||
| * If there are multiple outputs, a quick-pick window will be opened asking the | ||
| * user to choose one. | ||
| */ | ||
| async function bazelInfo(key: string): Promise<string> { | ||
| const workspaceInfo = await BazelWorkspaceInfo.fromWorkspaceFolders(); | ||
| if (!workspaceInfo) { | ||
| // eslint-disable-next-line @typescript-eslint/no-floating-promises | ||
| vscode.window.showInformationMessage( | ||
| "Please open a Bazel workspace folder to use this command.", | ||
| ); | ||
| return; | ||
| } | ||
| return new BazelInfo( | ||
| getDefaultBazelExecutablePath(), | ||
| workspaceInfo.bazelWorkspacePath, | ||
| ).run(key); | ||
| } | ||
|
|
||
| /** | ||
| * Activate all "command variables" | ||
| */ | ||
| export function activateCommandVariables(): vscode.Disposable[] { | ||
| return [ | ||
| vscode.commands.registerCommand( | ||
| "bazel.getTargetOutput", | ||
| bazelGetTargetOutput, | ||
| ), | ||
| ...[ | ||
| "bazel-bin", | ||
| "bazel-genfiles", | ||
| "bazel-testlogs", | ||
| "execution_root", | ||
| "output_base", | ||
| "output_path", | ||
| ].map((key) => | ||
| vscode.commands.registerCommand(`bazel.info.${key}`, () => | ||
| bazelInfo(key), | ||
| ), | ||
| ), | ||
| ]; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters