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

Consider using a command runner to wrap the commonly used commands #2271

Open
SteveLauC opened this issue Dec 17, 2023 · 3 comments
Open

Consider using a command runner to wrap the commonly used commands #2271

SteveLauC opened this issue Dec 17, 2023 · 3 comments

Comments

@SteveLauC
Copy link
Member

SteveLauC commented Dec 17, 2023

Since most commands Nix uses are not standard cargo commands, I suggest we use a command runner like just or make to wrap them to avoid typing them over and over again.

"are not standard cargo commands"

By this, I mean they need some extra arguments

Currently and personally, the most helpful use case would be to check if an item is gated with the correct feature, to do this, you have to open a Nix doc with the following command:

$ RUSTDOCFLAGS='--cfg docsrs' cargo +nightly doc --all-features --open

It would be really nice if we could do it with:

$ just doc --open

Other use cases can be:

# run tests
$ just test    # cargo test --all-features

# run checkds
$ just check   # run the commands that our CI involves to check the code
@YJDoc2
Copy link

YJDoc2 commented Jan 17, 2024

Hey, do you have any specific requirements for this? I'd like to work on this if it fine.
Also a suggestion : from personal experience, just is more easy-to-use and maintain compared to makefile ; with the slight drawback of users need to install it separately.

@SteveLauC
Copy link
Member Author

I'd like to work on this if it fine.

Thanks for your interest!

This is just a proposal, I would like to hear @asomers's thought before adding it to Nix:)

@asomers
Copy link
Member

asomers commented Jan 17, 2024

I've never gotten into the habit of using any of those. But I'd be willing to give it a try for Nix.

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

3 participants