Thanks to visit codestin.com
Credit goes to github.com

Skip to content

refactor(scripts): check_urls.vim to Lua + Treesitter #35593

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

refactor(scripts): check_urls.vim to Lua + Treesitter #35593

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bdc8e91
refactor(check_urls): check helpdoc urls in Lua + TS
yochem Sep 1, 2025
73d6524
Remove vim.async and use vim.net.request
yochem Sep 1, 2025
3bbe400
Allow directory as cli arg
yochem Sep 2, 2025
f047a8f
Eliminate dependency on vim.async
yochem Sep 2, 2025
d36f8f3
Add comments and stuff
yochem Sep 4, 2025
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
Prev Previous commit
Add comments and stuff
  • Loading branch information
@yochem
yochem committed Sep 4, 2025
commit d36f8f3bbb4e9f425d4d396347e3fc5e28be5020
39 changes: 24 additions & 15 deletions scripts/check_urls.lua
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
#!/usr/bin/env -S nvim -l

-- Finds unreachable URLs in help files.
--
-- Usage:
-- ./scripts/check_urls.lua [DIR...]
-- $ ./scripts/check_urls.lua [DIR...]
--
-- [DIR...] defaults to all 'doc' directories in the runtimepath.
Copy link
Contributor Author

@yochem yochem Sep 4, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Current behaviour also checks runtime/pack/dist/opt (seems okay) but that also includes netrw (booo). I still think it should be like this: $VIMRUNTIME/doc is easy to supply as script argument, 'all doc directories in the rtp' is not.


local ts = vim.treesitter

local query = ts.query.parse('vimdoc', '(url) @url')

---Read and return full content of given file path.
---@param path string
---@return string
local function read_file(path)
local fd = assert(vim.uv.fs_open(path, 'r', tonumber('644', 8)))
local stat = assert(vim.uv.fs_fstat(fd))
Expand All @@ -16,8 +22,9 @@ local function read_file(path)
return data
end

---@param helpfile string
---@return string[]
---Extract URLs from a vimdoc file using the vimdoc TS parser.
---@param helpfile string Path to help file
---@return string[] # list of URLs found in the document
local function extract_urls(helpfile)
---@type string[]
local urls = {}
Expand Down Expand Up @@ -45,38 +52,40 @@ local function run()
end

---@type string[]
local files = {}
for _, directory in ipairs(dirs) do
local help_files = {}
for _, dir in ipairs(dirs) do
vim.list_extend(
files,
help_files,
vim.fs.find(function(name, _)
return vim.endswith(name, '.txt')
end, { path = directory, type = 'file', limit = math.huge })
end, { path = dir, type = 'file', limit = math.huge })
)
end

---@type table<string, string[]>
local all_urls = {}
local pending = 0
for _, file in ipairs(files) do
local requests = 0
for _, file in ipairs(help_files) do
local urls = extract_urls(file)
pending = pending + #urls
requests = requests + #urls
all_urls[file] = urls
end

for filename, file_urls in pairs(all_urls) do
for file, file_urls in pairs(all_urls) do
for _, url in ipairs(file_urls) do
vim.net.request(url, { retry = 1 }, function(err, _)
vim.net.request(url, { retry = 3 }, function(err, _)
if err then
vim.print(('Unreachable url in %s: %s'):format(filename, url))
vim.print(('Unreachable url %s in %s'):format(url, file))
end
pending = pending - 1
if pending <= 0 then
requests = requests - 1
if requests <= 0 then
vim.uv.stop()
end
end)
end
end

-- wait for all pending async requests to finish (by calling vim.uv.stop())
vim.uv.run()
end

Expand Down
89 changes: 0 additions & 89 deletions scripts/check_urls.vim
View file
Open in desktop

This file was deleted.

Loading