Skip to content

feat: add graph search to check for broken links #145

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

Merged
lervag merged 1 commit into from
Apr 20, 2021
Merged

feat: add graph search to check for broken links #145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions autoload/wiki/buffer.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ endfunction
function! s:init_buffer_commands() abort " {{{1
command! -buffer WikiCodeRun call wiki#u#run_code_snippet()
command! -buffer WikiGraphFindBacklinks call wiki#graph#find_backlinks()
command! -buffer WikiGraphCheckLinks call wiki#graph#check_links()
command! -buffer -count=99 WikiGraphIn call wiki#graph#in(<count>)
command! -buffer -count=99 WikiGraphOut call wiki#graph#out(<count>)
command! -buffer WikiJournalIndex call wiki#journal#make_index()
Expand Down Expand Up @@ -81,6 +82,7 @@ endfunction
function! s:init_buffer_mappings() abort " {{{1
nnoremap <silent><buffer> <plug>(wiki-code-run) :WikiCodeRun<cr>
nnoremap <silent><buffer> <plug>(wiki-graph-find-backlinks) :WikiGraphFindBacklinks<cr>
nnoremap <silent><buffer> <plug>(wiki-graph-check-links) :WikiGraphCheckLinks<cr>
nnoremap <silent><buffer> <plug>(wiki-graph-in) :WikiGraphIn<cr>
nnoremap <silent><buffer> <plug>(wiki-graph-out) :WikiGraphOut<cr>
nnoremap <silent><buffer> <plug>(wiki-journal-index) :WikiJournalIndex<cr>
Expand Down Expand Up @@ -141,6 +143,7 @@ function! s:init_buffer_mappings() abort " {{{1
let l:mappings = {
\ '<plug>(wiki-code-run)' : '<leader>wc',
\ '<plug>(wiki-graph-find-backlinks)' : '<leader>wb',
\ '<plug>(wiki-graph-check-links)' : '<leader>wlc',
\ '<plug>(wiki-graph-in)' : '<leader>wg',
\ '<plug>(wiki-graph-out)' : '<leader>wG',
\ '<plug>(wiki-link-next)' : '<tab>',
Expand Down
34 changes: 34 additions & 0 deletions autoload/wiki/graph.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,40 @@ endfunction

"}}}1

function! wiki#graph#check_links() abort "{{{1
redraw
call wiki#log#info('Scanning wiki for broken links ... ')
sleep 25m

let l:broken_links = []

for l:file in globpath(b:wiki.root, '**/*.' . b:wiki.extension, 0, 1)
for l:link in filter(wiki#link#get_all(l:file),
\ 'get(v:val, ''scheme'', '''') ==# ''wiki''')
if !filereadable(l:link.path)
call add(l:broken_links, {
\ 'filename' : l:file,
\ 'text' : get(l:link, 'full'),
\ 'anchor' : l:link.anchor,
\ 'lnum' : l:link.lnum,
\ 'col' : l:link.c1
\})
endif
endfor
endfor

call wiki#log#info('Done!')

if empty(l:broken_links)
call wiki#log#info('No broken links exist')
else
call setloclist(0, l:broken_links, 'r')
lopen
endif
endfunction

"}}}1

function! wiki#graph#out(...) abort " {{{1
let l:max_level = a:0 > 0 ? a:1 : -1

Expand Down
5 changes: 5 additions & 0 deletions doc/wiki.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -575,6 +575,10 @@ the commands are also available as mappings of the form `<plug>(wiki-[name])`.
*WikiGraphFindBacklinks*
Find backlinks to current page.

*<plug>(wiki-graph-check-links)*
*WikiGraphCheckLinks*
Check for broken links.

*<plug>(wiki-graph-in)*
*<plug>(wiki-graph-out)*
*WikiGraphIn*
Expand Down Expand Up @@ -829,6 +833,7 @@ information about the different modes.
`n` <leader>wx |<plug>(wiki-reload)| [GLOBAL]
`n` <leader>wc |<plug>(wiki-code-run)|
`n` <leader>wb |<plug>(wiki-graph-find-backlinks)|
`n` <leader>wlc |<plug>(wiki-graph-check-links)|
`n` <leader>wg |<plug>(wiki-graph-in)|
`n` <leader>wG |<plug>(wiki-graph-out)|
`n` <leader>wf |<plug>(wiki-link-toggle)|
Expand Down