Skip to content
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

Jump to bottom

refactor(codebase)!: make the neorg object local to a core module #1001

Merged
merged 7 commits into from
Jul 31, 2023
Merged

refactor(codebase)!: make the neorg object local to a core module #1001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1f7c64b
Refactor: Moved neorg and callbacks to core module
Groctel Jul 30, 2023
78f40a9
Refactor: Moved lib and utils from helpers to core
Groctel Jul 30, 2023
201201a
Refactor: Moved config to core
Groctel Jul 30, 2023
b7a3d7b
Refactor: Renamed neorg.configuration to config
Groctel Jul 30, 2023
97bc4f3
Refactor: Moved log to core
Groctel Jul 30, 2023
1bc87fa
Refactor: Moved modules to core
Groctel Jul 30, 2023
7791686
Fix: Prevented symbol shadowing
Groctel Jul 30, 2023
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: 1 addition & 2 deletions .luarc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
"Lua.diagnostics.globals": [
"_neorgcmd_generate_completions",
"_neorg_module_autocommand_triggered",
"neorg",
"vim",
"vim"
]
}
58 changes: 29 additions & 29 deletions docgen/docgen.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
local neorg = require("neorg.core")
local lib, modules, utils = neorg.lib, neorg.modules, neorg.utils

local docgen = {}

-- Create the directory if it does not exist
Expand Down Expand Up @@ -32,11 +35,8 @@ require("neorg").setup({
-- Start neorg
neorg.org_file_entered(false)

-- Pull in the `neorg.lib` table
require("neorg.external.helpers")

-- Extract treesitter utility functions provided by Neorg and nvim-treesitter.ts_utils
local ts = neorg.modules.get_module("core.integrations.treesitter")
local ts = modules.get_module("core.integrations.treesitter")
assert(ts, "treesitter not available")

--- Aggregates all the available modules.
Expand Down Expand Up @@ -155,7 +155,7 @@ end
---@param root userdata #The root node
---@return userdata? #The `module.config.public` node
docgen.get_module_config_node = function(buffer, root)
local query = neorg.utils.ts_parse_query(
local query = utils.ts_parse_query(
"lua",
[[
(assignment_statement
Expand Down Expand Up @@ -238,7 +238,7 @@ end
docgen.evaluate_functions = function(tbl)
local new = {}

neorg.lib.map(tbl, function(_, value)
lib.map(tbl, function(_, value)
if type(value) == "function" then
vim.list_extend(new, value())
else
Expand All @@ -254,12 +254,12 @@ end

--- Returns a function which itself returns a table of links to modules
-- in a markdown-like unordered list.
---@param modules Modules #A table of modules to enumerate
---@param mods Modules #A table of modules to enumerate
---@param predicate fun(Module):boolean #A predicate that determines whether or not to render this object.
--- If the predicate returns false, then the object is dismissed.
---@return fun():string[] #An array of markdown strings with the enumerated modules
local function list_modules_with_predicate(modules, predicate)
local sorted = neorg.lib.unroll(modules)
local function list_modules_with_predicate(mods, predicate)
local sorted = lib.unroll(mods)

table.sort(sorted, function(x, y)
return x[1] < y[1]
Expand Down Expand Up @@ -301,9 +301,9 @@ end

docgen.generators = {
--- Generates the Home.md file
---@param modules Modules #A table of modules
homepage = function(modules)
local core_defaults = modules["core.defaults"]
---@param mods Modules #A table of modules
homepage = function(mods)
local core_defaults = mods["core.defaults"]
assert(core_defaults, "core.defaults module not loaded!")

local structure = {
Expand Down Expand Up @@ -350,7 +350,7 @@ docgen.generators = {
}
end,
"",
list_modules_with_predicate(modules, function(data)
list_modules_with_predicate(mods, function(data)
return vim.tbl_contains(core_defaults.parsed.config.public.enable, data.parsed.name)
and not data.top_comment_data.internal
end),
Expand All @@ -360,7 +360,7 @@ docgen.generators = {
"Some modules are not included by default as they require some manual configuration or are merely extra bells and whistles",
"and are not critical to editing `.norg` files. Below is a list of all modules that are not required by default:",
"",
list_modules_with_predicate(modules, function(data)
list_modules_with_predicate(mods, function(data)
return not data.parsed.extension
and not vim.tbl_contains(core_defaults.parsed.config.public.enable, data.parsed.name)
and not data.top_comment_data.internal
Expand All @@ -370,7 +370,7 @@ docgen.generators = {
"",
"These are modules that are only meant for developers. They are generally required in other modules:",
"",
list_modules_with_predicate(modules, function(data)
list_modules_with_predicate(mods, function(data)
return not data.parsed.extension and data.top_comment_data.internal
end),
}
Expand All @@ -379,8 +379,8 @@ docgen.generators = {
end,

--- Generates the _Sidebar.md file
---@param modules Modules #A table of modules
sidebar = function(modules)
---@param mods Modules #A table of modules
sidebar = function(mods)
local structure = {
"<div align='center'>",
"",
Expand All @@ -395,7 +395,7 @@ docgen.generators = {
local res = {}
local names = {}

for n, data in pairs(modules) do
for n, data in pairs(mods) do
if data.parsed.extension ~= true then
table.insert(names, n)
end
Expand All @@ -404,7 +404,7 @@ docgen.generators = {
table.sort(names)

for _, name in ipairs(names) do
local data = modules[name]
local data = mods[name]
if not data.parsed.internal then
local insert = ""
if data.top_comment_data.file then
Expand Down Expand Up @@ -432,11 +432,11 @@ docgen.generators = {
end,

--- Generates the page for any Neorg module
---@param modules Modules #The list of currently loaded modules
---@param mods Modules #The list of currently loaded modules
---@param module Module #The module we want to generate the page for
---@param configuration string[] #An array of markdown strings detailing the configuration options for the module
---@return string[] #A table of markdown strings representing the page
module = function(modules, module, configuration)
module = function(mods, module, configuration)
local structure = {
'<div align="center">',
"",
Expand Down Expand Up @@ -483,7 +483,7 @@ docgen.generators = {
local module_list = {}

for _, module_name in ipairs(required_modules) do
module_list[module_name] = modules[module_name]
module_list[module_name] = mods[module_name]
end

return docgen.evaluate_functions({
Expand All @@ -498,7 +498,7 @@ docgen.generators = {
function()
local required_by = {}

for mod, data in pairs(modules) do
for mod, data in pairs(mods) do
local required_modules = data.parsed.setup().requires or {}

if vim.tbl_contains(required_modules, module.parsed.name) then
Expand Down Expand Up @@ -538,18 +538,18 @@ docgen.check_comment_integrity = function(comment)
end

--- Replaces all instances of a module reference (e.g. `@core.concealer`) with a link in the wiki
---@param modules Modules #The list of loaded modules
---@param mods Modules #The list of loaded modules
---@param str string #The string to perform the lookup in
---@return string #The original `str` parameter with all `@` references replaced with links
docgen.lookup_modules = function(modules, str)
docgen.lookup_modules = function(mods, str)
return (
str:gsub("@([%-%.%w]+)", function(target_module_name)
if not modules[target_module_name] then
if not mods[target_module_name] then
return table.concat({ "@", target_module_name })
else
return table.concat({
"https://github.com/nvim-neorg/neorg/wiki/",
modules[target_module_name].top_comment_data.file,
mods[target_module_name].top_comment_data.file,
})
end
end)
Expand Down Expand Up @@ -647,14 +647,14 @@ docgen.htmlify = function(configuration_option)
local result = {}
local code_block = true

neorg.lib.match(self.data.value:type())({
lib.match(self.data.value:type())({
string = function()
table.insert(result, table.concat({ '"', self.object, '"' }))
end,
table_constructor = function()
table.insert(result, "")

local unrolled = neorg.lib.unroll(self.object)
local unrolled = lib.unroll(self.object)

table.sort(unrolled, function(x, y)
return tostring(x[1]) < tostring(y[1])
Expand Down
27 changes: 15 additions & 12 deletions docgen/init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
local neorg = require("neorg.core")
local lib, modules = neorg.lib, neorg.modules

local docgen = require("docgen")
local fileio = require("fileio")

Expand All @@ -10,7 +13,7 @@ local config = {
}

---@type Modules
local modules = {
local doc_modules = {
--[[
[name] = {
top_comment_data...
Expand All @@ -26,7 +29,7 @@ local modules = {
local function concat_configuration_options(configuration_options)
local result = {}

local unrolled = neorg.lib.unroll(configuration_options)
local unrolled = lib.unroll(configuration_options)

table.sort(unrolled, function(x, y)
return x[1] < y[1]
Expand Down Expand Up @@ -68,12 +71,12 @@ for _, file in ipairs(docgen.aggregate_module_files()) do
end

-- Make Neorg load the module, which also evaluates dependencies
neorg.modules.load_module(parsed_module.name)
modules.load_module(parsed_module.name)

-- Retrieve the module from the `loaded_modules` table.
parsed_module = neorg.modules.loaded_modules[parsed_module.name]
parsed_module = modules.loaded_modules[parsed_module.name]

modules[parsed_module.name] = {
doc_modules[parsed_module.name] = {
top_comment_data = top_comment_data,
buffer = buffer,
parsed = parsed_module,
Expand All @@ -83,11 +86,11 @@ for _, file in ipairs(docgen.aggregate_module_files()) do
end

-- Non-module pages have their own dedicated generators
fileio.write_to_wiki("Home", docgen.generators.homepage(modules))
fileio.write_to_wiki("_Sidebar", docgen.generators.sidebar(modules))
fileio.write_to_wiki("Home", docgen.generators.homepage(doc_modules))
fileio.write_to_wiki("_Sidebar", docgen.generators.sidebar(doc_modules))

-- Loop through all modules and generate their respective wiki files
for module_name, module in pairs(modules) do
for module_name, module in pairs(doc_modules) do
local buffer = module.buffer

-- Query the root node and try to find a `module.config.public` table
Expand All @@ -101,7 +104,7 @@ for module_name, module in pairs(modules) do
if config_node then
docgen.map_config(buffer, config_node, function(data, comments)
for i, comment in ipairs(comments) do
comments[i] = docgen.lookup_modules(modules, comment:gsub("^%s*%-%-+%s*", ""))
comments[i] = docgen.lookup_modules(doc_modules, comment:gsub("^%s*%-%-+%s*", ""))
end

do
Expand Down Expand Up @@ -130,7 +133,7 @@ for module_name, module in pairs(modules) do
local object = docgen.to_lua_object(module.parsed, buffer, data.value, module_name)

do
neorg.lib.ensure_nested(configuration_options, unpack(data.parents))
lib.ensure_nested(configuration_options, unpack(data.parents))
local ref = vim.tbl_get(configuration_options, unpack(data.parents)) or configuration_options
if data.name then
ref[data.name] = {
Expand Down Expand Up @@ -159,11 +162,11 @@ for module_name, module in pairs(modules) do
-- This cannot be done earlier because then there would be no guarantee
-- that all the modules have been properly indexed and parsed.
for i, line in ipairs(module.top_comment_data.markdown) do
module.top_comment_data.markdown[i] = docgen.lookup_modules(modules, line)
module.top_comment_data.markdown[i] = docgen.lookup_modules(doc_modules, line)
end

fileio.write_to_wiki(
module.top_comment_data.file,
docgen.generators.module(modules, module, concat_configuration_options(configuration_options))
docgen.generators.module(doc_modules, module, concat_configuration_options(configuration_options))
)
end
Loading