mirror of
https://github.com/neovim/neovim.git
synced 2025-09-29 14:38:32 +00:00
docs: enforce "treesitter" spelling #27110
It's the "tree-sitter" project, but "treesitter" in our code and docs.
This commit is contained in:
@@ -687,7 +687,7 @@ To disable this behavior, set the following variable in your vimrc: >
|
|||||||
QUERY *ft-query-plugin*
|
QUERY *ft-query-plugin*
|
||||||
|
|
||||||
|
|
||||||
Linting of tree-sitter queries for installed parsers using
|
Linting of treesitter queries for installed parsers using
|
||||||
|vim.treesitter.query.lint()| is enabled by default on `BufEnter` and
|
|vim.treesitter.query.lint()| is enabled by default on `BufEnter` and
|
||||||
`BufWrite`. To change the events that trigger linting, use >lua
|
`BufWrite`. To change the events that trigger linting, use >lua
|
||||||
|
|
||||||
|
@@ -619,7 +619,7 @@ vim.highlight.on_yank({opts}) *vim.highlight.on_yank()*
|
|||||||
vim.highlight.priorities *vim.highlight.priorities*
|
vim.highlight.priorities *vim.highlight.priorities*
|
||||||
Table with default priorities used for highlighting:
|
Table with default priorities used for highlighting:
|
||||||
• `syntax`: `50`, used for standard syntax highlighting
|
• `syntax`: `50`, used for standard syntax highlighting
|
||||||
• `treesitter`: `100`, used for tree-sitter-based highlighting
|
• `treesitter`: `100`, used for treesitter-based highlighting
|
||||||
• `semantic_tokens`: `125`, used for LSP semantic token highlighting
|
• `semantic_tokens`: `125`, used for LSP semantic token highlighting
|
||||||
• `diagnostics`: `150`, used for code analysis such as diagnostics
|
• `diagnostics`: `150`, used for code analysis such as diagnostics
|
||||||
• `user`: `200`, used for user-triggered highlights such as LSP document
|
• `user`: `200`, used for user-triggered highlights such as LSP document
|
||||||
|
@@ -17,7 +17,7 @@ changes. This documentation may also not fully reflect the latest changes.
|
|||||||
==============================================================================
|
==============================================================================
|
||||||
PARSER FILES *treesitter-parsers*
|
PARSER FILES *treesitter-parsers*
|
||||||
|
|
||||||
Parsers are the heart of tree-sitter. They are libraries that tree-sitter will
|
Parsers are the heart of treesitter. They are libraries that treesitter will
|
||||||
search for in the `parser` runtime directory. By default, Nvim bundles parsers
|
search for in the `parser` runtime directory. By default, Nvim bundles parsers
|
||||||
for C, Lua, Vimscript, Vimdoc and Treesitter query files, but parsers can be
|
for C, Lua, Vimscript, Vimdoc and Treesitter query files, but parsers can be
|
||||||
installed via a plugin like https://github.com/nvim-treesitter/nvim-treesitter
|
installed via a plugin like https://github.com/nvim-treesitter/nvim-treesitter
|
||||||
@@ -43,7 +43,7 @@ TREESITTER TREES *treesitter-tree*
|
|||||||
|
|
||||||
A "treesitter tree" represents the parsed contents of a buffer, which can be
|
A "treesitter tree" represents the parsed contents of a buffer, which can be
|
||||||
used to perform further analysis. It is a |userdata| reference to an object
|
used to perform further analysis. It is a |userdata| reference to an object
|
||||||
held by the tree-sitter library.
|
held by the treesitter library.
|
||||||
|
|
||||||
An instance `TSTree` of a treesitter tree supports the following methods.
|
An instance `TSTree` of a treesitter tree supports the following methods.
|
||||||
|
|
||||||
@@ -59,7 +59,7 @@ TREESITTER NODES *treesitter-node*
|
|||||||
|
|
||||||
A "treesitter node" represents one specific element of the parsed contents of
|
A "treesitter node" represents one specific element of the parsed contents of
|
||||||
a buffer, which can be captured by a |Query| for, e.g., highlighting. It is
|
a buffer, which can be captured by a |Query| for, e.g., highlighting. It is
|
||||||
a |userdata| reference to an object held by the tree-sitter library.
|
a |userdata| reference to an object held by the treesitter library.
|
||||||
|
|
||||||
An instance `TSNode` of a treesitter node supports the following methods.
|
An instance `TSNode` of a treesitter node supports the following methods.
|
||||||
|
|
||||||
@@ -563,7 +563,7 @@ Conceals specified in this way respect 'conceallevel'.
|
|||||||
*treesitter-highlight-priority*
|
*treesitter-highlight-priority*
|
||||||
Treesitter uses |nvim_buf_set_extmark()| to set highlights with a default
|
Treesitter uses |nvim_buf_set_extmark()| to set highlights with a default
|
||||||
priority of 100. This enables plugins to set a highlighting priority lower or
|
priority of 100. This enables plugins to set a highlighting priority lower or
|
||||||
higher than tree-sitter. It is also possible to change the priority of an
|
higher than treesitter. It is also possible to change the priority of an
|
||||||
individual query pattern manually by setting its `"priority"` metadata
|
individual query pattern manually by setting its `"priority"` metadata
|
||||||
attribute: >query
|
attribute: >query
|
||||||
|
|
||||||
@@ -624,17 +624,17 @@ associated with patterns:
|
|||||||
VIM.TREESITTER *lua-treesitter*
|
VIM.TREESITTER *lua-treesitter*
|
||||||
|
|
||||||
The remainder of this document is a reference manual for the `vim.treesitter`
|
The remainder of this document is a reference manual for the `vim.treesitter`
|
||||||
Lua module, which is the main interface for Nvim's tree-sitter integration.
|
Lua module, which is the main interface for Nvim's treesitter integration.
|
||||||
Most of the following content is automatically generated from the function
|
Most of the following content is automatically generated from the function
|
||||||
documentation.
|
documentation.
|
||||||
|
|
||||||
|
|
||||||
*vim.treesitter.language_version*
|
*vim.treesitter.language_version*
|
||||||
The latest parser ABI version that is supported by the bundled tree-sitter
|
The latest parser ABI version that is supported by the bundled treesitter
|
||||||
library.
|
library.
|
||||||
|
|
||||||
*vim.treesitter.minimum_language_version*
|
*vim.treesitter.minimum_language_version*
|
||||||
The earliest parser ABI version that is supported by the bundled tree-sitter
|
The earliest parser ABI version that is supported by the bundled treesitter
|
||||||
library.
|
library.
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
-- Neovim filetype plugin file
|
-- Neovim filetype plugin file
|
||||||
-- Language: Tree-sitter query
|
-- Language: Treesitter query
|
||||||
-- Last Change: 2023 Aug 23
|
-- Last Change: 2023 Aug 23
|
||||||
|
|
||||||
if vim.b.did_ftplugin == 1 then
|
if vim.b.did_ftplugin == 1 then
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
-- Neovim indent file
|
-- Neovim indent file
|
||||||
-- Language: Tree-sitter query
|
-- Language: Treesitter query
|
||||||
-- Last Change: 2022 Mar 29
|
-- Last Change: 2022 Mar 29
|
||||||
|
|
||||||
-- it's a lisp!
|
-- it's a lisp!
|
||||||
|
@@ -1909,7 +1909,7 @@ local pattern = {
|
|||||||
['.*baseq[2-3]/.*%.cfg'] = 'quake',
|
['.*baseq[2-3]/.*%.cfg'] = 'quake',
|
||||||
['.*quake[1-3]/.*%.cfg'] = 'quake',
|
['.*quake[1-3]/.*%.cfg'] = 'quake',
|
||||||
['.*id1/.*%.cfg'] = 'quake',
|
['.*id1/.*%.cfg'] = 'quake',
|
||||||
['.*/queries/.*%.scm'] = 'query', -- tree-sitter queries (Neovim only)
|
['.*/queries/.*%.scm'] = 'query', -- treesitter queries (Neovim only)
|
||||||
['.*,v'] = 'rcs',
|
['.*,v'] = 'rcs',
|
||||||
['%.reminders.*'] = starsetf('remind'),
|
['%.reminders.*'] = starsetf('remind'),
|
||||||
['[rR]akefile.*'] = starsetf('ruby'),
|
['[rR]akefile.*'] = starsetf('ruby'),
|
||||||
|
@@ -26,7 +26,7 @@ local M = {}
|
|||||||
|
|
||||||
--- Table with default priorities used for highlighting:
|
--- Table with default priorities used for highlighting:
|
||||||
--- - `syntax`: `50`, used for standard syntax highlighting
|
--- - `syntax`: `50`, used for standard syntax highlighting
|
||||||
--- - `treesitter`: `100`, used for tree-sitter-based highlighting
|
--- - `treesitter`: `100`, used for treesitter-based highlighting
|
||||||
--- - `semantic_tokens`: `125`, used for LSP semantic token highlighting
|
--- - `semantic_tokens`: `125`, used for LSP semantic token highlighting
|
||||||
--- - `diagnostics`: `150`, used for code analysis such as diagnostics
|
--- - `diagnostics`: `150`, used for code analysis such as diagnostics
|
||||||
--- - `user`: `200`, used for user-triggered highlights such as LSP document
|
--- - `user`: `200`, used for user-triggered highlights such as LSP document
|
||||||
|
@@ -14,7 +14,7 @@ local M = {}
|
|||||||
local TSTreeView = {}
|
local TSTreeView = {}
|
||||||
|
|
||||||
---@class TSP.Node
|
---@class TSP.Node
|
||||||
---@field node TSNode Tree-sitter node
|
---@field node TSNode Treesitter node
|
||||||
---@field field string? Node field
|
---@field field string? Node field
|
||||||
---@field depth integer Depth of this node in the tree
|
---@field depth integer Depth of this node in the tree
|
||||||
---@field text string? Text displayed in the inspector for this node. Not computed until the
|
---@field text string? Text displayed in the inspector for this node. Not computed until the
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
-- Neovim syntax file
|
-- Neovim syntax file
|
||||||
-- Language: Tree-sitter query
|
-- Language: Treesitter query
|
||||||
-- Last Change: 2022 Apr 13
|
-- Last Change: 2022 Apr 13
|
||||||
|
|
||||||
-- it's a lisp!
|
-- it's a lisp!
|
||||||
|
@@ -42,9 +42,14 @@ local spell_dict = {
|
|||||||
VimL = 'Vimscript',
|
VimL = 'Vimscript',
|
||||||
vimL = 'Vimscript',
|
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 = {
|
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
|
local language = nil
|
||||||
|
|
||||||
@@ -398,10 +403,16 @@ local function visit_validate(root, level, lang_tree, opt, stats)
|
|||||||
then
|
then
|
||||||
local text_nopunct = vim.fn.trim(text, '.,', 0) -- Ignore some punctuation.
|
local text_nopunct = vim.fn.trim(text, '.,', 0) -- Ignore some punctuation.
|
||||||
local fname_basename = assert(vim.fs.basename(opt.fname))
|
local fname_basename = assert(vim.fs.basename(opt.fname))
|
||||||
if spell_dict[text_nopunct] and not spell_ignore_files[fname_basename] then
|
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] = invalid_spelling[text_nopunct] or {}
|
||||||
invalid_spelling[text_nopunct][fname_basename] = node_text(root:parent())
|
invalid_spelling[text_nopunct][fname_basename] = node_text(root:parent())
|
||||||
end
|
end
|
||||||
|
end
|
||||||
elseif node_name == 'url' then
|
elseif node_name == 'url' then
|
||||||
local fixed_url, _ = fix_url(trim(text))
|
local fixed_url, _ = fix_url(trim(text))
|
||||||
validate_url(fixed_url, opt.fname)
|
validate_url(fixed_url, opt.fname)
|
||||||
|
@@ -713,7 +713,7 @@ struct file_buffer {
|
|||||||
|
|
||||||
// Measurements of the deleted or replaced region since the last update
|
// Measurements of the deleted or replaced region since the last update
|
||||||
// event. Some consumers of buffer changes need to know the byte size (like
|
// event. Some consumers of buffer changes need to know the byte size (like
|
||||||
// tree-sitter) or the corresponding UTF-32/UTF-16 size (like LSP) of the
|
// treesitter) or the corresponding UTF-32/UTF-16 size (like LSP) of the
|
||||||
// deleted text.
|
// deleted text.
|
||||||
size_t deleted_bytes;
|
size_t deleted_bytes;
|
||||||
size_t deleted_bytes2;
|
size_t deleted_bytes2;
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
// lua bindings for tree-sitter.
|
// lua bindings for treesitter.
|
||||||
// NB: this file mostly contains a generic lua interface for tree-sitter
|
// NB: this file mostly contains a generic lua interface for treesitter
|
||||||
// trees and nodes, and could be broken out as a reusable lua package
|
// trees and nodes, and could be broken out as a reusable lua package
|
||||||
|
|
||||||
#include <assert.h>
|
#include <assert.h>
|
||||||
|
Reference in New Issue
Block a user