|
| 1 | +{ |
| 2 | + lib, |
| 3 | + config, |
| 4 | + options, |
| 5 | + ... |
| 6 | +}: |
| 7 | +let |
| 8 | + cfg = config.plugins.cmp; |
| 9 | + opt = options.plugins.cmp; |
| 10 | + |
| 11 | + cleanSrc = lib.flip builtins.removeAttrs [ |
| 12 | + "name" |
| 13 | + ]; |
| 14 | + |
| 15 | + isRaw = v: v ? __raw || v._type or null == "lua-inline"; |
| 16 | + |
| 17 | + getSrcDefs = |
| 18 | + sourceName: list: |
| 19 | + if builtins.isList list then |
| 20 | + lib.pipe list [ |
| 21 | + (builtins.filter (src: !isRaw src)) |
| 22 | + (builtins.filter (src: src.name == sourceName)) |
| 23 | + (builtins.map (lib.filterAttrs (_: v: v != null))) |
| 24 | + lib.mergeAttrsList |
| 25 | + ] |
| 26 | + else |
| 27 | + lib.throwIfNot (isRaw list) |
| 28 | + "cmp/deprecated-auto-enable: unexpected cmp sources type: ${builtins.typeOf list}" |
| 29 | + { }; |
| 30 | + |
| 31 | + getNestedSrcDefs = |
| 32 | + sourceName: set: |
| 33 | + lib.pipe set [ |
| 34 | + (builtins.mapAttrs (_: settings: getSrcDefs sourceName settings.sources)) |
| 35 | + (lib.filterAttrs (_: v: v != { })) |
| 36 | + (builtins.mapAttrs (_: cleanSrc)) |
| 37 | + ]; |
| 38 | + |
| 39 | + # Check if the source is listed in `plugins.cmp.settings.sources` without the plugin being enabled |
| 40 | + # This is most likely to happen when a user was relying on the now removed `autoEnableSources` option |
| 41 | + # Produce a warning with detailed migration instructions. |
| 42 | + mkWarningDef = |
| 43 | + name: |
| 44 | + let |
| 45 | + pluginOpt = options.plugins.${name}; |
| 46 | + pluginCfg = config.plugins.${name}; |
| 47 | + pluginLoc = lib.dropEnd 1 pluginOpt.enable.loc; |
| 48 | + cmpLoc = lib.dropEnd 1 options.plugins.cmp.enable.loc; |
| 49 | + |
| 50 | + # Collect defined sources for this plugin |
| 51 | + defaultDef = getSrcDefs pluginCfg.cmp.name cfg.settings.sources; |
| 52 | + sourceDefs = |
| 53 | + lib.optionalAttrs (defaultDef != { }) { |
| 54 | + default = cleanSrc defaultDef; |
| 55 | + } |
| 56 | + // lib.filterAttrs (_: v: v != { }) { |
| 57 | + cmdline = getNestedSrcDefs pluginCfg.cmp.name cfg.cmdline; |
| 58 | + filetypes = getNestedSrcDefs pluginCfg.cmp.name cfg.filetype; |
| 59 | + }; |
| 60 | + |
| 61 | + indent = " "; |
| 62 | + |
| 63 | + showSrcDef = |
| 64 | + loc: new: def: |
| 65 | + let |
| 66 | + defLoc = lib.showOption (cmpLoc ++ loc ++ [ "sources" ]); |
| 67 | + join = if lib.hasInfix "\n" suggestion then "\n" + indent else " "; |
| 68 | + suggestion = "${lib.showOption (pluginLoc ++ [ "cmp" ] ++ new)} = ${ |
| 69 | + if def == { } then "true" else lib.generators.toPretty { inherit indent; } def |
| 70 | + };"; |
| 71 | + in |
| 72 | + [ |
| 73 | + "remove ${builtins.toJSON pluginCfg.cmp.name} from: ${defLoc}" |
| 74 | + "instead define:${join}${suggestion}" |
| 75 | + ]; |
| 76 | + |
| 77 | + lines = lib.flatten ( |
| 78 | + lib.singleton "manually enable `${pluginOpt.enable}`" |
| 79 | + ++ lib.optional (sourceDefs ? default) (showSrcDef [ "settings" ] [ "default" ] sourceDefs.default) |
| 80 | + ++ lib.mapAttrsToList (name: showSrcDef [ "cmdline" name ] [ "cmdline" name ]) ( |
| 81 | + sourceDefs.cmdline or { } |
| 82 | + ) |
| 83 | + ++ lib.mapAttrsToList (name: showSrcDef [ "filetype" name ] [ "filetypes" name ]) ( |
| 84 | + sourceDefs.filetype or { } |
| 85 | + ) |
| 86 | + ); |
| 87 | + |
| 88 | + lineCount = builtins.length lines; |
| 89 | + in |
| 90 | + lib.mkIf |
| 91 | + ( |
| 92 | + cfg.enable |
| 93 | + && !pluginCfg.enable |
| 94 | + && pluginOpt.enable.highestPrio == 1500 |
| 95 | + && pluginCfg.cmp.enable |
| 96 | + && sourceDefs != { } |
| 97 | + ) |
| 98 | + ( |
| 99 | + lib.nixvim.mkWarnings (lib.showOption pluginLoc) '' |
| 100 | + The ${builtins.toJSON pluginCfg.cmp.name} nvim-cmp source has been defined via `${lib.showOption cmpLoc}`, howevew `${pluginOpt.enable}` is not enabled. |
| 101 | + You should${ |
| 102 | + if lineCount == 1 then |
| 103 | + " " + builtins.head lines |
| 104 | + else |
| 105 | + ":" |
| 106 | + + lib.concatImapStrings ( |
| 107 | + i: line: "\n${builtins.toString i}. ${lib.nixvim.utils.upperFirstChar line}" |
| 108 | + ) lines |
| 109 | + } |
| 110 | + You can suppress this warning by explicitly setting `${pluginOpt.enable} = false`. |
| 111 | + '' # TODO: link to PR/docs/guide/faq |
| 112 | + ); |
| 113 | +in |
| 114 | +{ |
| 115 | + imports = [ |
| 116 | + (lib.mkRemovedOptionModule [ |
| 117 | + "cmpSourcePlugins" |
| 118 | + ] "Use `lib.nixvim.modules.mkCmpPluginModule` instead.") |
| 119 | + (lib.mkRemovedOptionModule [ "plugins" "cmp" "autoEnableSources" ] '' |
| 120 | + Instead of defining `${ |
| 121 | + lib.showOption (opt.settings.loc ++ [ "sources" ]) |
| 122 | + }` and using `autoEnableSources` to enable the relevant plugins, |
| 123 | + you should now enable the plugins and they will automatically add themselves to `${ |
| 124 | + lib.showOption (opt.settings.loc ++ [ "sources" ]) |
| 125 | + }`. |
| 126 | + '') # TODO: add a link to PR/docs/faq/guide |
| 127 | + ]; |
| 128 | + |
| 129 | + warnings = lib.pipe options.plugins [ |
| 130 | + (lib.flip builtins.removeAttrs [ |
| 131 | + # lspkind has its own `cmp` options, but isn't a nvim-cmp source |
| 132 | + "lspkind" |
| 133 | + ]) |
| 134 | + # Actual options are probably aliases, not plugins |
| 135 | + (lib.filterAttrs (_: opt: !lib.isOption opt)) |
| 136 | + (lib.filterAttrs (_: opt: opt ? cmp)) |
| 137 | + builtins.attrNames |
| 138 | + (builtins.map mkWarningDef) |
| 139 | + lib.mkMerge |
| 140 | + ]; |
| 141 | +} |
0 commit comments