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.

Sign up for GitHub

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

Allow GH user to exist without having TODO before it #63

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Allow GH user to exist without having TODO before it #63

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbb47ed
Drop the `TODO` as requirement to get GH user info
ahmedelgabri May 21, 2024
222b579
Add comment to describe the pattern matching
ahmedelgabri May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion lua/hover/providers/gh_user.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ local async = require('hover.async')
---@return string
local function get_user()
local WORD = fn.expand('<cWORD>')
local user = WORD:match('TODO%(@?(.*)%):')
-- The regex is not perfect, but it should match @user and user
-- The %f[%w_] and %f[^%w_] is because of the lack of \b in Lua. https://stackoverflow.com/a/32854326/213124
local user = WORD:match '%f[%w_]@?(.*)%f[^%w_]'
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this expected to match in practice? Some comments would help.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think the regex is perfect, but it matches @user and user, the %f[%w_] and %f[^%w_] is because of the lack of \b in Lua. https://stackoverflow.com/a/32854326/213124

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will cause a lot of false-positives as most words exist as a gihutb user.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hello @world @some @user

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The plugin depends on an explicit action (moving the cursor on a word and then triggering the hover) so the false-positives would be minimal. But we can make the @ mandatory too, so it matches only @user

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The plugin depends on an explicit action (moving the cursor on a word and then triggering the hover) so the false-positives would be minimal.

Maybe that reflects how you use the plugin, but I use this with the dictionary provider and I don't want to be viewing github users as the first result when I want the definition for a word.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Making @ mandatory instead of optional might be a good middle ground then?

return user
end

Expand Down