GitHub/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim synced 2025-07-16 09:11:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: enforce "treesitter" spelling #27110

Browse Source 
It's the "tree-sitter" project, but "treesitter" in our code and docs.
This commit is contained in:
Jongwook Choi
2024-01-28 20:53:14 -05:00
committed by GitHub
parent b0e85010fe
commit 5b1b765610
12 changed files with 33 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
scripts/gen_help_html.lua
View File

@ -42,9 +42,14 @@ local spell_dict = {
VimL = 'Vimscript',
vimL = 'Vimscript',
viml = 'Vimscript',
['tree-sitter'] = 'treesitter',
['Tree-sitter'] = 'Treesitter',
}
--- specify the list of keywords to ignore (i.e. allow), or true to disable spell check completely.
--- @type table<string, true|string[]>
local spell_ignore_files = {
['backers.txt'] = 'true',
['backers.txt'] = true,
['news.txt'] = { 'tree-sitter' }, -- in news, may refer to the upstream "tree-sitter" library
}
local language = nil
@ -398,9 +403,15 @@ local function visit_validate(root, level, lang_tree, opt, stats)
then
local text_nopunct = vim.fn.trim(text, '.,', 0) -- Ignore some punctuation.
local fname_basename = assert(vim.fs.basename(opt.fname))
if spell_dict[text_nopunct] and not spell_ignore_files[fname_basename] then
invalid_spelling[text_nopunct] = invalid_spelling[text_nopunct] or {}
invalid_spelling[text_nopunct][fname_basename] = node_text(root:parent())
if spell_dict[text_nopunct] then
local should_ignore = (
spell_ignore_files[fname_basename] == true
or vim.tbl_contains(spell_ignore_files[fname_basename] --[[ @as string[] ]], text_nopunct)
)
if not should_ignore then
invalid_spelling[text_nopunct] = invalid_spelling[text_nopunct] or {}
invalid_spelling[text_nopunct][fname_basename] = node_text(root:parent())
end
end
elseif node_name == 'url' then
local fixed_url, _ = fix_url(trim(text))