Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lack of end-to-end examples #2605

Open
john-cd opened this issue Jan 29, 2025 · 4 comments
Open

Lack of end-to-end examples #2605

john-cd opened this issue Jan 29, 2025 · 4 comments

Comments

@john-cd
Copy link

john-cd commented Jan 29, 2025

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
Copy link
Author

john-cd commented Jan 29, 2025

Also move

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

under examples

@casey
Copy link
Owner

casey commented Jan 29, 2025

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.

@john-cd
Copy link
Author

john-cd commented Jan 31, 2025

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.

@casey
Copy link
Owner

casey commented Jan 31, 2025

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants