Skip to content

Latest commit

 

History

History
62 lines (34 loc) · 2.83 KB

README.md

File metadata and controls

62 lines (34 loc) · 2.83 KB
Raw

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.

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 and you should look through the wiki for inspiration.

See the CHANGELOG 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.

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 for details.

CLI Task Runners Supported

Command-line options/flags

  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 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.