Troubleshooting

pw_ide: Code editor and IDE support for Pigweed projects

This doc provides troubleshooting advice specific to the Pigweed Visual Studio Code extension.

Can’t determine project type

The Pigweed extension wasn’t able to infer whether your Pigweed project is a Bazel project or a bootstrap project. This may happen if you have an unusual project structure.

You can resolve it by explicitly setting the project type in your settings.

Can’t find project root

The Pigweed extension wasn’t able to infer the path to your Pigweed project root. This may happen if you have an unusual project structure.

You can resolve it by explicitly setting the project root in your settings.

Failed to refresh code intelligence data

The Pigweed extension failed to refresh the compilation databases or other data used to provide code intelligences. Some troubleshooting steps:

• Check the output panel (Pigweed: Open Output Panel) to find more specific information about what went wrong.

• Verify that the Bazel refresh_compile_commands target is configured properly in the top-level //BUILD.bazel file. There will be relevant content in the output panel if this is not configured correctly.

Couldn’t find any targets (Bazel)

The Pigweed extension couldn’t find any Bazel targets or target groups to use for code intelligence. Here are some troubleshooting steps to follow:

Check the output panel for errors that may have occurred

Run Pigweed: Open Output Panel from the command palette. You should see the output from the most recent attempt to generate compile commands. If you don’t see that output, you can manually start the process by running Pigweed: Refresh Compile Commands.

The most common failure here is actually an upstream failure in the Bazel build, like missing dependencies or invalid Starlark files. Resolve those problems, and the refresh process should restart automatically.

Confirm that the refresh_compile_commands target is correctly defined

The top-level BUILD.bazel file contains a call to refresh_compile_commands that defines the refresh process target. Any syntax or configuration errors in that call will prevent the refresh process from running successfully.

Most importantly, ensure that the targets or target_groups attributes are defined. Defining both is valid too, but at least one must be present.