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.

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: Configuration moved to lua #23

Merged
merged 3 commits into from
Aug 24, 2021
Merged

refactor: Configuration moved to lua #23

merged 3 commits into from
Aug 24, 2021

Conversation

EdenEast
Copy link
Owner

⚠️BREAKING CHANGE⚠️

This pr outlines changes made to move configuration from global variables to lua setup and load functions. This change deprecates the old global variables in favor of the lua setup function. Nightfox prints a warning to the user about the depreciation.
An issue will be pinned about the deprecation.

New configuration looks like this:

local nightfox = require('nightfox')

nightfox.setup({
  fox = "nordfox"
})

nightfox.load()

Fixes #19

This changes the way that nightfox is configured. When create the
example of overriding highlight groups there was an ordering of
configuration steps that was highlighted.

This change converts the global variables that used to configure
nightfox into a lua setup function. The loading of this configuration
and applying the colorscheme is in a seperate load function.

This change also documents this in the readme.

The old global variable configuration is checked for and deprication
warning are shown.

BREAKING CHANGE
@EdenEast EdenEast added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 24, 2021
@EdenEast EdenEast merged commit 9746176 into main Aug 24, 2021
@EdenEast EdenEast deleted the refactor/lua-config branch August 24, 2021 02:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor configuration to use lua tables
1 participant