search

Canop / broot

A new way to see and navigate directory trees : https://dystroy.org/broot
MIT License
10.62k stars 234 forks source link

website: amend `install-br.md` with a note for nushell #880

Closed Schweber closed 4 months ago

Schweber commented 4 months ago

https://github.com/Canop/broot/issues/827

Canop commented 4 months ago

@FrancescElies @LudoPinelli @texastoland Your opinion on this would be welcome.

texastoland commented 4 months ago

I'm traveling this week and haven't read the other thread completely. I agree the difference between alias and def here is surprising and worth documenting. Worth mentioning in the Nushell Discord server too in case it can be made more predictable. Tag me if you do 👍🏼

Schweber commented 4 months ago

Worth mentioning in the Nushell Discord server too in case it can be made more predictable.

What do you mean by that exactly?

texastoland commented 4 months ago

I mean you you identified an issue with Nushell not broot. Even though it works by design it was confusing regardless. If lazygit added a lg wrapper command should they document this behavior too?

The XY problem is it wasn't intuitive that br works by changing the environment thus necessitating wrapping with def --env. Possible solutions include adding a warning to the compiler, making it more obvious in the LSP (with an inlay hint for example), or just clarifying the Nushell docs.

FrancescElies commented 4 months ago

I also got bit by this in the passt. While I agree it is confusing when comming from other shells, nushell actually dedicates an entire section to this topic inside getting started. What else could have done the nushell mantainers to avoid us being bit by this?

I am fine with the description, maybe you can add the link above to the broot docs? The obvious disadvantage is that if nushell restructure their docs or moves them elsewhere the link needs to be updated. Either way if you decide to add it or not I am fine with it.

Canop commented 4 months ago

You guys know nushell better than me. I wait for an explicit approval before merging.

FrancescElies commented 4 months ago

From my side all good, you can merge