Adding feature to parse cheatsheets for syntax errors

[TunnelThruTime]

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

I'm using navi and I've found that some of the cheat code that I write isn't available to me.
I have my code in a repo so I can tell between one commit and the next there is a stoppage
in the availability of the code.

[welcome]

Thanks for opening your first issue here! In case you're facing a bug, please update navi to the latest version first. Maybe the bug is already solved! :)

[alexis-opolka]

Hi @TunnelThruTime, I would need more information about you're requesting exactly.

I understand from the title of the issue you opened you'd like to have available something equivalent to a parser for the cheats in order to validate them, am I correct? If not, please explain in greater details what you would like.

[TunnelThruTime]

Yes, it is a validator that would be beneficial. It is just that when using other languages (zsh, bash), when there is a problem you get a message that at the very least gives you a readout of where to look. I think that this exists with navi, since it was written in one of the popular languages, so I would ask that that readout be extended to the users. I realize that this would take time, and effort. And that is way I opend the issue as a new feature.

I might have opened it as a bug, because to me it looked that way. Let me explain. I was working on some cheats when I entered a typo. Unaware of the split I opened the navi menu with whatever the shortcut is (ctrl-g?) and but found that a number of the cheats that I had written were missing.

I then went back into my vim buffer and start undoing changes until and see that all the cheats are available. But if I had closed the buffer it wouldn't have been as easy to fix. Furthermore if people keep large files full of cheats then maintaining them could be difficult. I think that maybe navi should have a subcommand to give users the lines where syntax wasn't good enough.

Also it seemed that from the line where there was a typo to the EOF none of the cheats went into the navi cache. That could be a give away to anyone debugging but it also means that it was in part done by design. If that is the case then making a debugger to tell users what is up would be easy enough to do.

[alexis-opolka]

Hi @TunnelThruTime ,

I haven't dabbled much into this part of the codebase but if Navi does indeed have a validation of the cheatsheet format that we can somehow reuse as another command it is indeed a good idea.

When I have time to look into it, I will let you know if it's possible to do it and how we will implement it.

A better error handling of syntax errors would also be interesting to have. 🤔

Edit: it won't be for the next release since the next release will have a focus on debugging and bugs fixing.