https://github.com/madbomber/justprep
A pre-process for the just command line utility
https://github.com/madbomber/justprep
crystal just ruby
Last synced: about 1 month ago
JSON representation
A pre-process for the just command line utility
- Host: GitHub
- URL: https://github.com/madbomber/justprep
- Owner: MadBomber
- License: mit
- Created: 2021-07-07T23:56:59.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-28T15:46:48.000Z (over 1 year ago)
- Last Synced: 2025-05-07T05:46:17.983Z (about 1 month ago)
- Topics: crystal, just, ruby
- Language: Ruby
- Homepage:
- Size: 130 KB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# just v1.19+ has Includes and Modules!
**import**: `just` allows for recursive imports whereas `justprep` does not.
**mod**: feature in `just` may be a little unstable but still worth checking out.
I am looking forward to when I can declare `justprep` a dead project because its features have been fully implemented in the main `just` application.
Just a quick notice that the `brew` workflow and formula for `justprep` are not working. Ypu can [download the latest crystal binary release.](https://github.com/MadBomber/justprep/releases/)
# `justprep`
Just a CLI pre-processor tool for task runners like "just" my current favorite.
`justprep` is implemented as a Ruby gem and as a Crystal binary. A large part of the code base is shared between Ruby and Crystal. These common files have the file extension \*.crb to indicate that they are both Crystal and Ruby.
There is no specific speed benchmark between the two implementations. I can't perceive any specific speed of processing differences between the two implementations with the small sets of task files that I use. Its really a matter of your project workflow. If your projects are primarily Ruby, then install the Ruby gem version. If you do not primarily use Ruby (why not? Its a GREAT language!) then install the Crystal version.
TL;DR [Examples](https://github.com/MadBomber/justprep/tree/main/examples) and you should look through the [wiki](https://github.com/MadBomber/justprep/wiki) for inspiration.
See [the CHANGELOG](https://github.com/MadBomber/justprep/blob/main/CHANGELOG.md) for recent changes.
### Installation for the Ruby version
gem install justprep
### Installation for the Crystal version
brew tap madbomber/justprep
brew install --build-from-source justprep
Ypu can also [download a binary release.](https://github.com/MadBomber/justprep/releases/)
### Documentation
Since this capability is implemented in both Ruby and Crystal there is only one set of documentation. Both implementations act the same way. See the [repository's Wiki](https://github.com/MadBomber/justprep/wiki) for details.
#### CLI Task Runners Supported
* [just](https://github.com/casey/just)
#### Command-line options/flags
```text
FLAGS:
--version Shows the current version
-h, --help Displays this usage message
--no-brag Do not add header/footer around included content
```
See [the wiki](https://github.com/MadBomber/justprep/wiki/No-brag%2C-just-fact.) for details on what the `--no-brag` option does.
### Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/MadBomber/justprep.
If you have a different CLI task runner than what justprep currently supports, let me know so we can add it to the support list.
## License
justprep is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).