Nilirad / bevy_prototype_lyon

Draw 2D shapes in Bevy
Apache License 2.0
702 stars 87 forks source link

Add rust-toolchain.toml #168

Closed rparrett closed 2 years ago

rparrett commented 2 years ago

It seems like the project is being developed with rust nightly, as rustfmt.toml contains nightly-only stuff.

I think that adding a rust-toolchain.toml is the right thing to do? At the very least, it seems to make vscode's "format on save" work in my environment where nightly isn't the default toolchain.

Nilirad commented 2 years ago

Yes, I'm cool with that. I just have to remove it in the release branches though... I'll add the task to my release checklist!

EDIT: Hmm... Actually I don't think it's the best thing to do. Nightly is not required to build the crate itself. What I think you should do instead is to locally add a workspace setting for your formatter (essentially a .vscode/settings.json file). You then have to .gitignore the .vscode folder, not by touching this repo, but either by editing your global .gitignore (if that's not a problem for you) or by creating a .gitignore in a superfolder where your bevy_prototype_lyon checkout lives.

Sorry if it's a bit convoluted but it's to not force people who depend on master branch instead of release to use nightly. 😓

EDIT 2: You can also use a rustup directory override instead: rustup override set nightly from your working tree.

rparrett commented 2 years ago

Thanks. Didn't realize that rust-toolchain would poison projects depending on this one.

Looks like the rustup override is what I want.