just icon indicating copy to clipboard operation
just copied to clipboard

Lack of end-to-end examples

Open john-cd opened this issue 10 months ago • 6 comments

Just examples on GitHub are scattered.

Ask

Consider adding end-to-end examples for common scenarios, e.g. in https://just.systems/man/en/examples.html

  1. Formatting / linting / building / running Rust code + building mdBook

See for example:

https://github.com/john-cd/rust_howto https://github.com/john-cd/rust_howto/tree/main/scripts https://github.com/john-cd/rust_howto/tree/main/scripts/code

Link to https://github.com/casey/rust-cli-boilerplate/blob/master/justfile ?

  1. Python with poetry / uv - similar to e.g. https://github.com/dovahcrow/patchify.py/blob/master/Justfile
  2. Node
  3. Go
  4. Java
  5. Git commands - similar to e.g. https://github.com/Moldy-Community/moldyup/blob/main/JustFile ...

john-cd avatar Jan 29 '25 17:01 john-cd

Also move

https://just.systems/man/en/python-recipes-with-uv.html

under examples

john-cd avatar Jan 29 '25 17:01 john-cd

There's an examples directory, which has some example justfiles.

We could do things like include a rust.just file, which shows example recipes for a Rust project.

I wouldn't be super opposed to this, but on the other hand, for languages I'm less familiar with, this might turn into a review burden and get out-of-date.

casey avatar Jan 29 '25 21:01 casey

Maybe we need to find a few good examples on Github.

The documentation link to https://github.com/search?q=path%3A**%2Fjustfile&type=code returns a lot of repetitive stuff.

john-cd avatar Jan 31 '25 18:01 john-cd

I think that's a great idea. Linking to justfiles of existing projects would mean we don't need keep examples up to date, and can cover a bunch of different languages and approaches.

casey avatar Jan 31 '25 19:01 casey

I have been trying to locate a good example of justfile on Windows / running cross-platform on Linux and Windows.

Do you know of any?

john-cd avatar Feb 11 '25 21:02 john-cd

I don't, unfortunately. Maybe include windows in the github search?

casey avatar Feb 12 '25 00:02 casey