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

refactor!: make Neovim 0.10 a requirement for Neorg #1508

Merged
merged 2 commits into from
Jul 8, 2024
Merged

refactor!: make Neovim 0.10 a requirement for Neorg #1508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c352563
refactor!: make Neovim 0.10 a requirement for Neorg
vhyrro Jul 8, 2024
d06f91d
chore: check for neovim version on startup
vhyrro Jul 8, 2024
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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# Neorg - An Organized Future

<a href="https://neovim.io"> ![Neovim](https://img.shields.io/badge/Neovim%200.8+-brightgreen?style=for-the-badge) </a>
<a href="https://neovim.io"> ![Neovim](https://img.shields.io/badge/Neovim%200.10+-brightgreen?style=for-the-badge) </a>
<a href="https://discord.gg/T6EgTAX7ht"> ![Discord](https://img.shields.io/badge/discord-join-7289da?style=for-the-badge&logo=discord) </a>
<a href="/LICENSE"> ![License](https://img.shields.io/badge/license-GPL%20v3-brightgreen?style=for-the-badge)</a>
<a href="https://dotfyle.com/plugins/nvim-neorg/neorg"> ![Usage](https://dotfyle.com/plugins/nvim-neorg/neorg/shield?style=for-the-badge) </a>
Expand Down Expand Up @@ -70,7 +70,9 @@ A video tutorial may be found on Youtube:

Neorg's setup process is slightly more complex than average, so we encourage you to be patient :)

**After you're done with the installation process, run `:checkhealth neorg` to see if everything's correct!**
**Neorg requires Neovim 0.10 or above to function. After you're done with the
installation process, run `:checkhealth neorg` to see if everything's
correct!**

### `rocks.nvim`

Expand Down
13 changes: 4 additions & 9 deletions lua/neorg/init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
--- @brief ]]

local neorg = require("neorg.core")
local config, log, modules = neorg.config, neorg.log, neorg.modules
local config, log, modules, utils = neorg.config, neorg.log, neorg.modules, neorg.utils

--- @module "neorg.core.config"

Expand All @@ -12,6 +12,9 @@ local config, log, modules = neorg.config, neorg.log, neorg.modules
--- @see config.user_config
--- @see neorg.configuration.user
function neorg.setup(cfg)
-- Ensure that we are running Neovim 0.10+
assert(utils.is_minimum_version(0, 10, 0), "Neorg requires at least Neovim version 0.10 to operate!")

-- If the user supplied no configuration then generate a default one (assume the user wants the defaults)
cfg = cfg or {
load = {
Expand All @@ -36,14 +39,6 @@ function neorg.setup(cfg)
-- Create a new global instance of the neorg logger.
log.new(config.user_config.logger or log.get_default_config(), true)

-- TODO(vhyrro): Remove this after Neovim 0.10, where `norg` files will be
-- detected automatically.
vim.filetype.add({
extension = {
norg = "norg",
},
})

-- If the file we have entered has a `.norg` extension:
if vim.fn.expand("%:e") == "norg" or not config.user_config.lazy_loading then
-- Then boot up the environment.
Expand Down
Loading