leigh/neogen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add utilities

Browse Source 
After a refactoring of utilities, I added a function to get the first
child node that matches the node name.

Documentation is provided in neogen.utilities.nodes
This commit is contained in:
Daniel Mathiot
2021-08-23 16:00:43 +02:00
parent 6b08b2297c
commit 52128c1bd5
7 changed files with 46 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -114,8 +114,8 @@ data = {
-- Extractor function that returns a set of TSname = values with values being of type string[] -- Extractor function that returns a set of TSname = values with values being of type string[]
extract = function(node) extract = function(node)
local regular_params = neogen.utility:extract_children("identifier")(node) local regular_params = neogen.utilities.extractors:extract_children_text("identifier")(node)
local varargs = neogen.utility:extract_children("spread")(node) local varargs = neogen.utilities.extractors:extract_children_text("spread")(node)
return { return {
parameters = regular_params, parameters = regular_params,
@@ -201,8 +201,8 @@ data = {
-- Extractor function that returns a set of TSname = values with values being of type string[] -- Extractor function that returns a set of TSname = values with values being of type string[]
extract = function(node) extract = function(node)
local regular_params = neogen.utility:extract_children("identifier")(node) local regular_params = neogen.utilities.extractors:extract_children_text("identifier")(node)
local varargs = neogen.utility:extract_children("spread")(node) local varargs = neogen.utilities.extractors:extract_children_text("spread")(node)
return { return {
parameters = regular_params, parameters = regular_params,
@@ -217,7 +217,7 @@ data = {
Notes: Notes:
- If you create your own granulator, you can add any kind of parameters in the `data` field from configuration file as long as the function signature is the same provided. - If you create your own granulator, you can add any kind of parameters in the `data` field from configuration file as long as the function signature is the same provided.
- Utilities are provided in order to extract content from subnodes. You can check out their documentation in `lua/utility.lua`. - Utilities are provided. You can check out their documentation in `lua/utilities/`.
### Generators ### Generators

6
lua/neogen.lua
View File

@@ -3,7 +3,11 @@ assert(ok, "neogen requires nvim-treesitter to operate :(")
neogen = {} neogen = {}
require("neogen.utility")
-- Require utilities
neogen.utilities = {}
require("neogen.utilities.extractors")
require("neogen.utilities.nodes")
-- Require defaults -- Require defaults
require("neogen.locators.default") require("neogen.locators.default")

10
lua/neogen/configurations/lua.lua
View File

@@ -13,8 +13,8 @@ return {
match = "parameters", match = "parameters",
extract = function(node) extract = function(node)
local regular_params = neogen.utility:extract_children("identifier")(node) local regular_params = neogen.utilities.extractors:extract_children_text("identifier")(node)
local varargs = neogen.utility:extract_children("spread")(node) local varargs = neogen.utilities.extractors:extract_children_text("spread")(node)
return { return {
parameters = regular_params, parameters = regular_params,
@@ -28,15 +28,15 @@ return {
match = "function_definition", match = "function_definition",
extract = function(node) extract = function(node)
local regular_params = neogen.utility:extract_children_from({ local regular_params = neogen.utilities.extractors:extract_children_from({
[1] = "extract", [1] = "extract",
}, "identifier")(node) }, "identifier")(node)
local varargs = neogen.utility:extract_children_from({ local varargs = neogen.utilities.extractors:extract_children_from({
[1] = "extract", [1] = "extract",
}, "spread")(node) }, "spread")(node)
local return_statement = neogen.utility:extract_children("return_statement")(node) local return_statement = neogen.utilities.extractors:extract_children_text("return_statement")(node)
return { return {
parameters = regular_params, parameters = regular_params,

13
lua/neogen/configurations/python.lua
View File

@@ -11,7 +11,7 @@ return {
match = "parameters", match = "parameters",
extract = function(node) extract = function(node)
local regular_params = neogen.utility:extract_children("identifier")(node) local regular_params = neogen.utilities.extractors:extract_children_text("identifier")(node)
return { return {
parameters = regular_params, parameters = regular_params,
@@ -19,6 +19,15 @@ return {
end, end,
}, },
}, },
["class_definition"] = {
["2"] = {
match = "block",
extract = function(node)
return {}
end,
},
},
}, },
-- Use default granulator and generator -- Use default granulator and generator
@@ -29,7 +38,7 @@ return {
template = { template = {
annotation_convention = "google_docstrings", -- required: Which annotation convention to use (default_generator) annotation_convention = "google_docstrings", -- required: Which annotation convention to use (default_generator)
append = { position = "after", child_name = "block" }, -- optional: where to append the text (default_generator) append = { position = "after", child_name = "block" }, -- optional: where to append the text (default_generator)
use_default_comment = false, -- If you want to prefix the template with the default comment for the language (default_generator) use_default_comment = false, -- If you want to prefix the template with the default comment for the language, e.g for python: # (default_generator)
google_docstrings = { google_docstrings = {
{ nil, '"""' }, { nil, '"""' },
{ "parameters", "\t%s: ", { before_first_item = "Args: " } }, { "parameters", "\t%s: ", { before_first_item = "Args: " } },

9
lua/neogen/generators/default.lua
View File

@@ -18,13 +18,10 @@ neogen.default_generator = function(parent, data, template)
local append = template.append or {} local append = template.append or {}
if append.position == "after" then if append.position == "after" then
for child in parent:iter_children() do local child_node = neogen.utilities.nodes:first_child_node(parent, append.child_name)
if child:type() == append.child_name then if child_node ~= nil then
row_to_place, col_to_place, _ , _ = child:range() row_to_place, col_to_place, _ , _ = child_node:range()
break
end
end end
end end
if not template or not template.annotation_convention then if not template or not template.annotation_convention then

6
lua/neogen/utility.lua → lua/neogen/utilities/extractors.lua
View File

@@ -1,11 +1,11 @@
local ts_utils = require("nvim-treesitter.ts_utils") local ts_utils = require("nvim-treesitter.ts_utils")
neogen.utility = { neogen.utilities.extractors = {
--- Return a function to extract content of required children from a node --- Return a function to extract content of required children from a node
--- @param _ any self --- @param _ any self
--- @param name string the children we want to extract (if multiple childrens, separate each one with "|") --- @param name string the children we want to extract (if multiple childrens, separate each one with "|")
--- @return function cb function taking a node and getting the content of each children we want from name --- @return function cb function taking a node and getting the content of each children we want from name
extract_children = function(_, name) extract_children_text = function(_, name)
return function(node) return function(node)
local result = {} local result = {}
local split = vim.split(name, "|", true) local split = vim.split(name, "|", true)
@@ -39,7 +39,7 @@ neogen.utility = {
local child_node = node:named_child(tonumber(i) - 1) local child_node = node:named_child(tonumber(i) - 1)
if subtree == "extract" then if subtree == "extract" then
return self:extract_children(name)(child_node) return self:extract_children_text(name)(child_node)
else else
return self:extract_children_from(subtree, name)(child_node) return self:extract_children_from(subtree, name)(child_node)
end end

14
lua/neogen/utilities/nodes.lua Normal file
View File

@@ -0,0 +1,14 @@
neogen.utilities.nodes = {
--- Get first child node that match the provided node name
--- @param _ any
--- @param parent userdata the parent's node
--- @param node_name string the node type to search for
--- @return userdata node the first encountered child node
first_child_node = function (_, parent, node_name)
for child in parent:iter_children() do
if child:type() == node_name then
return child
end
end
end
}