Add bazel.getTargetOutput command #275

jfirebaugh · 2022-08-31T21:23:44Z

This 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.getOutputTarget",
        "args": ["//my/binary:target"],
    }
]

Addresses #273 and could form the basis of #217, #207, and #115.

coeuvre · 2022-09-09T08:56:48Z

src/bazel/bazel_query.ts

-    additionalOptions: string[] = [],
-    sortByRuleName: boolean = false,
+    query: string,
+    {


Please update @param additionalOptions in the method doc to reflect the change of parameter type.

coeuvre · 2022-09-09T08:56:57Z

src/bazel/bazel_query.ts

@@ -88,12 +77,8 @@ export class BazelQuery extends BazelCommand {
   * @returns An sorted array of package paths containing the targets that
   *     match.
   */
-  public async queryPackages(
-    additionalOptions: string[] = [],


coeuvre · 2022-09-09T08:57:08Z

src/bazel/bazel_query.ts

@@ -116,7 +101,10 @@ export class BazelQuery extends BazelCommand {
   * @returns A promise that is resolved with the contents of the process's
   *     standard output, or rejected if the command fails.
   */
-  private run(additionalOptions: string[] = []): Promise<Buffer> {


coeuvre · 2022-09-09T08:58:43Z

src/bazel/bazel_info.ts

+import { BazelCommand } from "./bazel_command";
+
+export class BazelInfo extends BazelCommand {
+  public async run(key: string): Promise<string> {


Please add method-level doc for public method.

coeuvre · 2022-09-09T08:58:51Z

src/bazel/bazel_info.ts

+
+import { BazelCommand } from "./bazel_command";
+
+export class BazelInfo extends BazelCommand {


Please add class-level doc for public class.

coeuvre · 2022-09-09T08:59:00Z

src/bazel/bazel_cquery.ts

+
+import { BazelQuery } from "./bazel_query";
+
+export class BazelCQuery extends BazelQuery {


Please add class-level doc for public class.

coeuvre · 2022-09-09T08:59:10Z

src/bazel/bazel_cquery.ts

+import { BazelQuery } from "./bazel_query";
+
+export class BazelCQuery extends BazelQuery {
+  public async queryOutputs(


Please add method-level doc for public method.

This 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.getOutputTarget", "args": ["//my/binary:target"], } ] Addresses bazelbuild#273 and could form the basis of bazelbuild#217, bazelbuild#207, and bazelbuild#115.

jfirebaugh · 2022-09-09T20:15:06Z

👍🏻 Done!

coeuvre

Thanks!

I missed testing this case with command input variables in #275. IMO it's a VSCode bug that the calling convention is different than with `vscode.commands.executeCommand` (microsoft/vscode#167970), but nevertheless we need to handle it.

I proposed these originally in #273 as an initial idea for what became #275. But I have encountered another use case that makes me think they are generally useful: When [debugging on macOS](bazelbuild/bazel#6327 (comment)), lldb needs to be configured with the command `platform settings -w $execution_root`, where `$execution_root` is what's returned by `bazel info execution_root`. With `bazel.info.*` commands, you can create a launch configuration that contains: ``` "initCommands": [ "platform settings -w ${command:bazel.info.execution_root}", ] ```

The commands `bazel.info.*` and `bazel.getOutputPath` are intended to be used by the command variables within `launch.json` and `task.json`. For additional context, see bazelbuild#273, bazelbuild#275 and bazelbuild#291. Those commands are not intended to be called by users directly. As such, they should not show up in the command picker. This commit removes them from the `commands` contribution point, thereby hiding them from the command picker.

The commands `bazel.info.*` and `bazel.getOutputPath` are intended to be used as command variables within `launch.json` and `task.json`. For additional context, see bazelbuild#273, bazelbuild#275 and bazelbuild#291. Those commands are not intended to be called by users directly. As such, they should not show up in the command palette. Calling them from the command picker has no user-visible effect and leaves the user with the impression that those commands would be broken. This commit removes them from the `commands` contribution point, thereby hiding them from the command picker. To make sure that the extension is loaded as soon as some `task.json`/`launch.json` invokes any of those commands, they now need to be registered as `activationEvents`, since VS Code will no longer discover those events automatically from the `commands` contributions.

The commands `bazel.info.*` and `bazel.getOutputPath` are intended to be used as command variables within `launch.json` and `task.json`. For additional context, see #273, #275 and #291. Those commands are not intended to be called by users directly. As such, they should not show up in the command palette. Calling them from the command picker has no user-visible effect and leaves the user with the impression that those commands would be broken. This commit removes them from the `commands` contribution point, thereby hiding them from the command picker. To make sure that the extension is loaded as soon as some `task.json`/`launch.json` invokes any of those commands, they now need to be registered as `activationEvents`, since VS Code will no longer discover those events automatically from the `commands` contributions.

jfirebaugh requested review from coeuvre and philwo as code owners August 31, 2022 21:23

jfirebaugh mentioned this pull request Aug 31, 2022

Add bazel.info.* commands #273

Closed

jfirebaugh changed the title ~~Add bazel.getTargetOutputs command~~ Add bazel.getTargetOutput command Aug 31, 2022

coeuvre requested changes Sep 9, 2022

View reviewed changes

jfirebaugh and others added 2 commits September 9, 2022 12:47

Add/update docs

b5aec72

jfirebaugh force-pushed the jfirebaugh/getTargetOutputs branch from 4a3cede to b5aec72 Compare September 9, 2022 20:08

Lint

4fdb157

coeuvre approved these changes Sep 12, 2022

View reviewed changes

coeuvre merged commit 8039f64 into bazelbuild:master Sep 12, 2022

jfirebaugh deleted the jfirebaugh/getTargetOutputs branch September 12, 2022 16:43

jfirebaugh mentioned this pull request Dec 2, 2022

Fix and document providing flags to getTargetOutput #287

Merged

jfirebaugh mentioned this pull request Dec 14, 2022

Add bazel.info.* commands #291

Merged

vogelsgesang mentioned this pull request Feb 27, 2024

Hide commands intended as command variables #347

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add bazel.getTargetOutput command #275

Add bazel.getTargetOutput command #275

jfirebaugh commented Aug 31, 2022

coeuvre Sep 9, 2022

coeuvre Sep 9, 2022

coeuvre Sep 9, 2022

coeuvre Sep 9, 2022

coeuvre Sep 9, 2022

coeuvre Sep 9, 2022

coeuvre Sep 9, 2022

jfirebaugh commented Sep 9, 2022

coeuvre left a comment


		import { BazelCommand } from "./bazel_command";

		export class BazelInfo extends BazelCommand {


		import { BazelQuery } from "./bazel_query";

		export class BazelCQuery extends BazelQuery {

Add bazel.getTargetOutput command #275

Add bazel.getTargetOutput command #275

Conversation

jfirebaugh commented Aug 31, 2022

coeuvre Sep 9, 2022

Choose a reason for hiding this comment

coeuvre Sep 9, 2022

Choose a reason for hiding this comment

coeuvre Sep 9, 2022

Choose a reason for hiding this comment

coeuvre Sep 9, 2022

Choose a reason for hiding this comment

coeuvre Sep 9, 2022

Choose a reason for hiding this comment

coeuvre Sep 9, 2022

Choose a reason for hiding this comment

coeuvre Sep 9, 2022

Choose a reason for hiding this comment

jfirebaugh commented Sep 9, 2022

coeuvre left a comment

Choose a reason for hiding this comment