plugins/alpha: migrate to mkNeovimPlugin #3040
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,86 +1,74 @@ | ||
| { lib, ... }: | ||
| let | ||
| inherit (lib) mkOption types; | ||
| inherit (lib.nixvim) | ||
| defaultNullOpts | ||
| mkAssertions | ||
| mkRaw | ||
| nestedLiteralLua | ||
| toLuaObject | ||
| ; | ||
| in | ||
| lib.nixvim.plugins.mkNeovimPlugin { | ||
| name = "alpha"; | ||
| packPathName = "alpha-nvim"; | ||
| package = "alpha-nvim"; | ||
|
|
||
| maintainers = [ lib.maintainers.HeitorAugustoLN ]; | ||
|
|
||
| callSetup = false; | ||
|
|
||
| settingsOptions = { | ||
| layout = | ||
| let | ||
| sectionType = types.submodule { | ||
| freeformType = with types; attrsOf anything; | ||
| options = { | ||
| type = mkOption { | ||
| type = types.enum [ | ||
| "button" | ||
| "group" | ||
| "padding" | ||
| "text" | ||
| "terminal" | ||
| ]; | ||
| example = "button"; | ||
| description = '' | ||
| The type of the section. | ||
| ''; | ||
| }; | ||
|
|
||
| val = defaultNullOpts.mkNullableWithRaw' { | ||
| type = | ||
| with types; | ||
| oneOf [ | ||
| # button || text | ||
| (maybeRaw str) | ||
| # padding | ||
| int | ||
| (listOf ( | ||
| either str # text (list of strings) | ||
| (attrsOf anything) # group | ||
| )) | ||
| ]; | ||
| example = "Some text"; | ||
| description = '' | ||
| The value for the section. | ||
| ''; | ||
| }; | ||
|
|
||
HeitorAugustoLN marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| opts = mkOption { | ||
| type = with types; attrsOf anything; | ||
| default = { }; | ||
| description = '' | ||
| Additional options for the section. | ||
| ''; | ||
| }; | ||
| }; | ||
| }; | ||
| in | ||
| defaultNullOpts.mkNullableWithRaw' { | ||
| type = with types; either str (listOf sectionType); | ||
| example = [ | ||
| { | ||
| type = "padding"; | ||
|
|
@@ -135,77 +123,118 @@ in | |
| }; | ||
| } | ||
| ]; | ||
| description = '' | ||
| List of sections to layout for the dashboard | ||
| ''; | ||
| }; | ||
|
|
||
| opts = defaultNullOpts.mkAttrsOf' { | ||
| type = types.anything; | ||
| description = '' | ||
| Optional global options. | ||
| ''; | ||
| }; | ||
| }; | ||
|
|
||
| settingsExample = { | ||
| layout = [ | ||
| { | ||
| type = "padding"; | ||
| val = 2; | ||
| } | ||
| { | ||
| type = "text"; | ||
| val = [ | ||
| "███╗ ██╗██╗██╗ ██╗██╗ ██╗██╗███╗ ███╗" | ||
| "████╗ ██║██║╚██╗██╔╝██║ ██║██║████╗ ████║" | ||
| "██╔██╗ ██║██║ ╚███╔╝ ██║ ██║██║██╔████╔██║" | ||
| "██║╚██╗██║██║ ██╔██╗ ╚██╗ ██╔╝██║██║╚██╔╝██║" | ||
| "██║ ╚████║██║██╔╝ ██╗ ╚████╔╝ ██║██║ ╚═╝ ██║" | ||
| "╚═╝ ╚═══╝╚═╝╚═╝ ╚═╝ ╚═══╝ ╚═╝╚═╝ ╚═╝" | ||
| ]; | ||
| opts = { | ||
| position = "center"; | ||
| hl = "Type"; | ||
| }; | ||
| } | ||
| { | ||
| type = "padding"; | ||
| val = 2; | ||
| } | ||
| { | ||
| type = "group"; | ||
| val = [ | ||
| { | ||
| type = "button"; | ||
| val = " New file"; | ||
| on_press = nestedLiteralLua "function() vim.cmd[[ene]] end"; | ||
| opts.shortcut = "n"; | ||
| } | ||
| { | ||
| type = "button"; | ||
| val = " Quit Neovim"; | ||
| on_press = nestedLiteralLua "function() vim.cmd[[qa]] end"; | ||
| opts.shortcut = "q"; | ||
| } | ||
| ]; | ||
| } | ||
| { | ||
| type = "padding"; | ||
| val = 2; | ||
| } | ||
| { | ||
| type = "text"; | ||
| val = "Inspiring quote here."; | ||
| opts = { | ||
| position = "center"; | ||
| hl = "Keyword"; | ||
| }; | ||
| } | ||
| ]; | ||
| }; | ||
|
|
||
| extraOptions = { | ||
| theme = defaultNullOpts.mkStr' { | ||
| description = '' | ||
| The theme to use for the dashboard. | ||
| ''; | ||
| example = "dashboard"; | ||
| apply = | ||
| value: if builtins.isString value then mkRaw ''require("alpha.themes.${value}").config'' else value; | ||
| }; | ||
| }; | ||
|
|
||
| optionsRenamedToSettings = [ | ||
|
There was a problem hiding this comment. This should have a comment saying when it was added. Also, we need to update the test cases. See CI failures: https://buildbot.nix-community.org/#/builders/2885/builds/3656/steps/1/logs/stdio |
||
| "opts" | ||
| "layout" | ||
| ]; | ||
|
|
||
| extraConfig = | ||
| cfg: | ||
| let | ||
| layoutDefined = cfg.settings.layout != null; | ||
| themeDefined = cfg.theme != null; | ||
| in | ||
| { | ||
| assertions = mkAssertions "plugins.alpha" [ | ||
| { | ||
| assertion = layoutDefined || themeDefined; | ||
| message = '' | ||
| You have to either set a `theme` or define some sections in `layout`. | ||
| ''; | ||
| } | ||
| { | ||
| assertion = !(themeDefined && toLuaObject cfg.settings != "{}"); | ||
| message = '' | ||
| You can't define both a `theme` and custom options. | ||
| Set `plugins.alpha.theme = null` if you want to configure alpha manually using the `layout` option. | ||
| ''; | ||
| } | ||
| ]; | ||
|
|
||
| plugins.alpha.luaConfig.content = '' | ||
| require('alpha').setup(${toLuaObject (if themeDefined then cfg.theme else cfg.settings)}); | ||
HeitorAugustoLN marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. This feels like it could be confusing to users. I wonder if we should have it so that we do this in the module system? settings = mkDerivedConfig opts.theme (
value:
if builtins.isString value then mkRaw ''require("alpha.themes.${value}").config'' else value
);However, that'd require refactoring As a minimum, the weird behaviour of discarding all configured settings if a theme is defined should be documented somewhere. |
||
| require('alpha.term') | ||
| ''; | ||
| }; | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typically we have an explanatory comment.