https://github.com/oyvindberg/bleep
A bleeping fast scala build tool!
https://github.com/oyvindberg/bleep
Last synced: 11 months ago
JSON representation
A bleeping fast scala build tool!
- Host: GitHub
- URL: https://github.com/oyvindberg/bleep
- Owner: oyvindberg
- License: mit
- Created: 2021-10-15T20:56:47.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-06T07:24:15.000Z (over 1 year ago)
- Last Synced: 2024-10-11T15:45:16.762Z (over 1 year ago)
- Language: Scala
- Homepage:
- Size: 25.7 MB
- Stars: 149
- Watchers: 13
- Forks: 21
- Open Issues: 59
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-java - Bleep
README
# A bleeping fast scala build tool!
[](https://discord.gg/scala) Chat in the [#tooling channel](https://discord.com/channels/632150470000902164/635669047588945930) of the Scala Discord
See documentation at [https://bleep.build](https://bleep.build/docs/)
### Contributing
#### Check out bleep source code
```
$ git clone --recurse-submodules https://github.com/oyvindberg/bleep.git
```
#### Install bleep
See https://bleep.build/docs/installing/
#### Use bleep to build bleep
```bash
# compile all projects using scala 2.13
$ bleep compile jvm213
```
#### Setup in IDE
```
$ bleep setup-ide jvm213
```
And then open in using metals or intellij.
See [setting-up-build-in-ide](https://bleep.build/docs/usage/selecting-projects/#setting-up-build-in-ide) for a bit more info.
#### Run bleep
You have several options:
- run with bleep `bleep run bleep-cli@jvm213`
- run `bleep.Main` from your IDE
- generate a native image (`bleep native-image`) and run that (the path will be printed).
This is slow, but a few things can only be tested this way.
- generate a shell wrapper script:
```sh
# generate script in build directory
$ bleep setup-dev-script bleep-cli@jvm213
# with this approach you need to compile manually
$ bleep compile bleep-cli@jvm213
$ ./bleep-cli@jvm213.sh
# .\bleep-cli@jvm213.bat on Windows
```
#### Submitting code
- All changes go through PRs
- Code should be formatted correctly (`bleep fmt`) and tests should pass (`bleep test`).