https://github.com/thanetz/bazel-for-human-beings

Bazel lightweight plugin for PyCharm
https://github.com/thanetz/bazel-for-human-beings

Last synced: about 1 month ago
JSON representation

Bazel lightweight plugin for PyCharm

• Host: GitHub
• URL: https://github.com/thanetz/bazel-for-human-beings
• Owner: thanetz
• Created: 2018-09-22T11:45:38.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-02-15T10:19:06.000Z (almost 6 years ago)
• Last Synced: 2024-07-31T07:15:52.029Z (4 months ago)
• Language: Java
• Homepage:
• Size: 583 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-bazel - PyCharm

README

        
# Bazel For Human Beings

Bazel lightweight plugin for PyCharm

![Bazel4HumanBeingsLogo](examples/BazelForHumanBeings_128x128.png)

## Usage

### TL;DR

Configure the bazel path in ```Preferences -> Bazel For Human Beings Configuration```

Add new Bazel For Human Beings run configuration with the bazel rule or 

simply right click on a code file and Bazel For Human Beings will find the correct bazel rule for you

That's it now you can run bazel tasks from inside PyCharm!

### In Depth

#### Bazel Executable path

Configure the bazel executable path in ```Preferences -> Bazel For Human Beings Configuration```

![Bazel4HumanBeingsLogo](examples/preferences-configure-bazel-path.png)

As you can see above, there are two text boxes, one for the bazel query, and one for the bazel run.

Bazel for Human Beings is using bazel query command in order to get metadata on your run - 

for example derive the bazel rule type automatically, or suggest bazel rule based on the python file.

In this screen you can specify different bazel executable for the query commands and different one for the run, build and test commands.

The main purpose of this separation is to enable the usage of third party bazel run wrappers like [Dazel](https://github.com/nadirizr/dazel);

#### Bazel for Human Beings Run Configuration

After you install the plugin, you will receive new run configuration option: Bazel For Human Beings.

![Create New Run Configuration](examples/create-new-run-configuration.png)

Select it to create new Bazel For Human Beings run configuration.

![New Run Configuration](examples/new-run-configuration.png)

In the bazel execution path text box, enter the path to your rule.

 

The next text box is optional, and let you pass comma separated list of parameters to the bazel run command.

Save the run configuration, and you are good to go!

#### Create Run Configuration from context menu

We are human beings, and we don't remember the bazel rule path for each and every task.

Not to worry, Bazel for Human Beings creates new run configuration for you!

Simply right click on your code file, and select "Create Bazel ..." and the run configuration will be created for you!

![Create New Run Configuration From Context Menu](examples/create-run-configuration-context-menu.png)

You can also user the "Run 'Bazel: ..." in order to create new run configuration and execute it.

#### Execute your Bazel For Human Beings Configuration

After you create new run configuration, now its the time to execute it - select your configuration and click run.

You probably noticed that you haven't selected the bazel action, 

That's because Bazel For Human Beings automatically derive the bazel action required for this python bazel rule.

So just run the configuration and Bazel For Human Beings will show you the test browser, if this is test action, 

or simple console window for build, and run.

![Test Results Example](examples/example-test-results.png)

## Build

Using gradle jar task

## Version Support

PyCharm 2018.3