Initial cheat repo support #258
Conversation
denisidoro
changed the title
| let content = match shell { | ||
| "zsh" => include_str!("../../shell/navi.plugin.zsh"), | ||
| "fish" => include_str!("../../shell/navi.plugin.fish"), | ||
| _ => include_str!("../../shell/navi.plugin.bash"), |
There was a problem hiding this comment.
Isn't there a way to create a filesystem path that's platform specific?
Windows would prefer \ rather than / (even though both work).
There was a problem hiding this comment.
This is at compile time. It's the same as if I copy pasted the contents of file to the source code. I think rust handles the / vs \ thing
There was a problem hiding this comment.
Ohhh, didn't know that include_str macro actually reads the file in compile time!
So, now that we're passed that, why was this done?
I'm assuming that's because you didn't want to add these files as external resources so it'll be easier to bundle with additional packaging methods?
If that's the case, then you can write that file to a similar place like the cheats and then print the path to that file.
But, it's a super simple change from the users perspective so I wouldn't bother going to all that trouble.
Plus, it's easier to change the bound key if you want to - instead of reading the output of the command and then regexing & replacing the key, you just need to regex & replace the key.
| @@ -91,13 +91,13 @@ You can use **navi** as a widget to your shell. This way, your history is correc | |||
| In order to use it, add this line to your `.bashrc`-like file: | |||
| ```sh | |||
| # bash | |||
| source "$(navi widget bash)" | |||
| source <(navi widget bash) | |||
There was a problem hiding this comment.
I'm not super versed in bash/zsh/fish/rust, but I couldn't find the reason in the code that required this change.
AFAIK source needs a path to, well, source in the current shell.
This, if I understand it correctly, reads from the given file and passes it as the stdin for source, which might work but I think is unnecessary.
There was a problem hiding this comment.
Previously the command returned a path to a shell script. Now it prints the content of the shell script.
This PR makes navi stop bundling
.cheatfiles and makes it able to download from repos on GitHub, using a standardized config directory.This PR ended up being much bigger than I would like so if you could review only this description it would be already very nice!
When navi is started for the first time, a welcome cheatsheet is shown:
If the user selects the first option, the user is prompted to download
.cheats from https://github.com/denisidoro/cheats:The config folder is populated:
When run again, cheats are available:
Breaking changes
In order to make navi stop bundling shell widgets as well, a breaking change has been introduced:
source $(navi widget bash)won't work anymore. It should besource <(navi widget bash)now. Any ideas on how to make this transition more graceful?