Skip to content

This commit adds support for R with roxygen2 annotations #217

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 3 commits into
base: main
Choose a base branch
from
Open

This commit adds support for R with roxygen2 annotations #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7528bea
This commit adds support for R with roxygen2 annotations
RufusVijayaratnam Apr 18, 2025
fe16521
Added to title field of roxygen2 template for cursor default location.
RufusVijayaratnam May 4, 2025
f02721b
changed case of file r.lua
RufusVijayaratnam May 6, 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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,7 @@ There is a list of supported languages and fields, with their annotation style
| typescript | [JSDoc](https://jsdoc.app) (`"jsdoc"`) <br> [TSDoc](https://tsdoc.org) (`"tsdoc"`) | `func`, `class`, `type`, `file` |
| typescriptreact | [JSDoc](https://jsdoc.app) (`"jsdoc"`) <br> [TSDoc](https://tsdoc.org) (`"tsdoc"`) | `func`, `class`, `type`, `file` |
| vue | [JSDoc](https://jsdoc.app) (`"jsdoc"`) | `func`, `class`, `type`, `file` |
| R | [roxygen2](https://roxygen2.r-lib.org) (`"roxygen2"`) | `func` |

## Adding Languages

Expand Down
63 changes: 63 additions & 0 deletions lua/neogen/configurations/R.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
local template = require("neogen.template")
local extractors = require("neogen.utilities.extractors")
local nodes_utils = require("neogen.utilities.nodes")
local i = require("neogen.types.template").item

return {
parent = {
func = { "binary_operator" },
},
data = {
func = {
["binary_operator"] = {
["0"] = {
extract = function(node)
local function_name_node = node:child(0)
local function_name = vim.treesitter.get_node_text(function_name_node, 0)
local res = {}
res["function_name"] = { function_name }

local parameters_tree = {
{
retrieve = "first",
node_type = "function_definition",
subtree = {
{
retrieve = "first",
node_type = "parameters",
subtree = {
{
retrieve = "all",
node_type = "parameter",
subtree = {
{
retrieve = "first",
node_type = "identifier|dots",
extract = true,
as = i.Parameter,
},
},
},
},
},
},
},
}

local parameters_nodes = nodes_utils:matching_nodes_from(node, parameters_tree)
local params_res = extractors:extract_from_matched(parameters_nodes)

for k, v in pairs(params_res) do
if k == "parameters" then
res[k] = v
end
end

return res
end,
},
},
},
},
template = template:add_default_annotation("roxygen2"),
}
63 changes: 63 additions & 0 deletions lua/neogen/configurations/r.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
local template = require("neogen.template")
local extractors = require("neogen.utilities.extractors")
local nodes_utils = require("neogen.utilities.nodes")
local i = require("neogen.types.template").item

return {
parent = {
func = { "binary_operator" },
},
data = {
func = {
["binary_operator"] = {
["0"] = {
extract = function(node)
local function_name_node = node:child(0)
local function_name = vim.treesitter.get_node_text(function_name_node, 0)
local res = {}
res["function_name"] = { function_name }

local parameters_tree = {
{
retrieve = "first",
node_type = "function_definition",
subtree = {
{
retrieve = "first",
node_type = "parameters",
subtree = {
{
retrieve = "all",
node_type = "parameter",
subtree = {
{
retrieve = "first",
node_type = "identifier|dots",
extract = true,
as = i.Parameter,
},
},
},
},
},
},
},
}

local parameters_nodes = nodes_utils:matching_nodes_from(node, parameters_tree)
local params_res = extractors:extract_from_matched(parameters_nodes)

for k, v in pairs(params_res) do
if k == "parameters" then
res[k] = v
end
end

return res
end,
},
},
},
},
template = template:add_default_annotation("roxygen2"),
}
9 changes: 9 additions & 0 deletions lua/neogen/templates/roxygen2.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
local i = require("neogen.types.template").item

return {
{ nil, "#' @title $1", { no_results = false, type = { "func" } } },
{ nil, "#' @description", { no_results = false, type = { "func" } } },
{ i.Parameter, "#' @param %s" },
{ nil, "#' @return", { type = { "func" }, no_results = false } },
{ nil, "#' @export", { type = { "func" }, no_results = false } }
}