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

Filter by symbol? #8

Open
jgarte opened this issue Jul 6, 2022 · 6 comments
Open

Filter by symbol? #8

jgarte opened this issue Jul 6, 2022 · 6 comments

Comments

@jgarte
Copy link

jgarte commented Jul 6, 2022

Hi,

How can I filter by variables, for example. Or, only by classes.

@mohkale
Copy link
Owner

mohkale commented Jul 7, 2022

@jgarte

This is configured through consult-eglot-narrow. I believe you're looking for v.

@jgarte
Copy link
Author

jgarte commented Jul 7, 2022

oh cool, thanks for pointing that out. Should I add that notion/reference/feature to the readme as a TLDR/heads up for others who also bypassed reading the source code in their haste to quickly use consult-eglot?

@jgarte
Copy link
Author

jgarte commented Jul 7, 2022

BTW, what language servers have you tested this on? It worked for me with pyright but not pylsp, for example.

That's because pylsp does not support workspace symbols, unfortunately.

@mohkale
Copy link
Owner

mohkale commented Jul 7, 2022

Gopls and clangd are the reference ones I've used it with. Shame more language servers don't support it but ripgrep fills the gap for them well enough in my experience.

Happy to accept a PR to add a section to the README clarifying more customization options. I might be the weird one who always jumps to the code for customization options instead of looking in READMEs :-).

@jgarte
Copy link
Author

jgarte commented Jul 8, 2022

I'm a weirdo to read the src code first also ;) But, I believe it's nice to have some notes of interest that invites new users to read the code and to have enough background context on how things work. Sometimes, a library or package is using other dependencies (even emacs native libraries) that the user is not yet familiar with. Giving this sort of information allows people not as familiar with the emacs ecosystem to get a quick big picture idea that invites and assists them in learning more about the emacs ecosystem. In other words, not everybody has the same level of education to immediately read the source code and make sense of it. Maybe they are almost there. Let's assist those people with better documentation and background on the code. I don't believe that the source code alone is the documentation. It is only one part of the picture that everybody should definitely be reading, of course.

@jgarte
Copy link
Author

jgarte commented Jul 8, 2022

Internally tempel-key uses tempel-insert to trigger the insertion. ...

From https://github.com/minad/tempel#binding-important-templates-to-a-key

I think that prose docs like the above about internals are nice.

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

2 participants