Skip to content

Latest commit

 

History

History
258 lines (148 loc) · 5.52 KB

README.md

File metadata and controls

258 lines (148 loc) · 5.52 KB
Raw

Project View

The project view file (*.bazelproject) is used to import a subset of bazel targets into the IDE, configure a project, and specify how the bsp server will be started.

This is our adaptation of the project view mechanism known from Bazel Plugin for Intellij

The project view file uses a python-like format with 2 spaces indentation and # comments. You can share the *.bazelproject file between projects, use your own copy, or both.

In general, you can start with just directories and targets and add more sections as you want to further tweak your IDE workspace.

Usage

Note: We will be changing this mechanism in future releases.

$ cs launch org.jetbrains.bsp:bazel-bsp:<version> -M org.jetbrains.bsp.bazel.install.Install -- -p <path/to/projectview_file>. For more details, see --help.

Available sections

import

Imports another project view.

You may use multiple imports in any project view. Any list type sections (e.g. targets) compose. Single-value sections (e.g. bazel_binary) override and use the last one encountered, depth-first parse order (i.e. imports are evaluated as they are encountered).

example:
import path/to/another/projectview.bazelproject

targets

A list of bazel target expressions, they support /... notation.

Targets are built during the server lifetime, so the more targets you have, the slower your IDE experience might be. You can use negative targets to have server ignore certain targets ( e.g. -//executioncontext/projectview/src/main/kotlin/org/jetbrains/bsp/bazel/projectview/parser/...).

example:
targets:
  //install/src/main/kotlin/org/jetbrains/bsp/bazel/install
  //executioncontext/projectview/...
  -//executioncontext/projectview/src/main/kotlin/org/jetbrains/bsp/bazel/projectview/parser/...
default:

No target is included:

targets:

bazel_binary

Path to bazel which will be used to invoke bazel from the server (e.g. to build a project, or query bazel).

example:
bazel_binary: /usr/local/bin/bazel
default:

The server will deduct bazel path from $PATH

directories

A list of directories to be mapped into bazel targets.

You can use negative directories to have server ignore certain directories ( e.g. -executioncontext/projectview/src/main/kotlin/org/jetbrains/bsp/bazel/projectview/parser/...).

example:
directories:
  install/src/main/kotlin/org/jetbrains/bsp/bazel/install
  executioncontext/projectview/
  -executioncontext/projectview/src/main/kotlin/org/jetbrains/bsp/bazel/projectview/parser
default:

No directories included.

derive_targets_from_directories

A flag specifying if targets should be derived from list of directories in directories section.

Flag is boolean value, so it can take either true or false. In the first case targets will be derived from directories, in the second they won't.

example:
derive_targets_from_directories: true
default:

Targets will not be derived from directories.

import_depth

A numerical value that specifies how many levels of bazel targets dependencies should be imported as modules. Only the targets that are present in workspace are imported.

You can use negative value to import all transitive dependencies.

example:
import_depth: 1
default:

The default value is 0, meaning that only root targets are imported

workspace_type

We are working on it, you can expect support for this section in future releases.

additional_languages

We are working on it, you can expect support for this section in future releases.

java_language_level

We are working on it, you can expect support for this section in future releases.

test_sources

We are working on it, you can expect support for this section in future releases.

shard_sync

We are working on it, you can expect support for this section in future releases.

target_shard_size

We are working on it, you can expect support for this section in future releases.

exclude_library

We are working on it, you can expect support for this section in future releases.

build_flags

A set of bazel flags added to all bazel command invocations.

example:
build_flags:
  --define=ij_product=intellij-latest
default:

No flags.

sync_flags

We are working on it, you can expect support for this section in future releases.

test_flags

We are working on it, you can expect support for this section in future releases.

import_run_configurations

We are working on it, you can expect support for this section in future releases.

android_sdk_platform

We are working on it, you can expect support for this section in future releases.

android_min_sdk

We are working on it, you can expect support for this section in future releases.

generated_android_resource_directories

We are working on it, you can expect support for this section in future releases.

ts_config_rules

We are working on it, you can expect support for this section in future releases.

build_manual_targets

A flag specifying if targets with manual tag should be built. Flag is boolean value, so it can take either true or false. In the first case targets with manual tag will be build, otherwise they will not.

example:

build_manual_targets: true

default:

build_manual_targets: false