Merge 3e5c6eb73f into cd81bbb904

docs/manual/release-notes/rl-0.8.md

@@ -622,8 +622,15 @@
 
 - Added gitFiles mapping option to telescope
 
-[Ring-A-Ding-Ding-Baby](https://github.com/Ring-A-Ding-Ding-Baby)
+[Ring-A-Ding-Ding-Baby](https://github.com/Ring-A-Ding-Ding-Baby):
 
 - Aligned `codelldb` adapter setup with [rustaceanvim]’s built-in logic.
 - Added `languages.rust.dap.backend` option to choose between `codelldb` and
   `lldb-dap` adapters.
+
+[jfeo](https://github.com/jfeo):
+
+[ccc.nvim]: https://github.com/uga-rosa/ccc.nvim
+
+- Added [ccc.nvim] option {option}`vim.utility.ccc.setupOpts` with the existing
+  hard-coded options as default values.

modules/plugins/utility/ccc/ccc.nix

@@ -1,10 +1,154 @@
 {lib, ...}: let
-  inherit (lib.options) mkEnableOption;
+  inherit (lib.options) mkOption mkEnableOption;
+  inherit (lib.types) listOf enum;
   inherit (lib.nvim.binds) mkMappingOption;
+  inherit (lib.nvim.types) mkPluginSetupOption luaInline;
+  inherit (lib.generators) mkLuaInline;
 in {
   options.vim.utility.ccc = {
     enable = mkEnableOption "ccc color picker for neovim";
 
+    setupOpts = mkPluginSetupOption "ccc.nvim" {
+      highlighter = mkOption {
+        type = luaInline;
+        default = mkLuaInline ''
+          {
+            auto_enable = true,
+            max_byte = 2 * 1024 * 1024, -- 2mb
+            lsp = true,
+            filetypes = colorPickerFts,
+          }
+        '';
+        description = "Settings for the highlighter";
+      };
+
+      pickers = mkOption {
+        type = luaInline;
+        default = mkLuaInline ''
+          {
+            ccc.picker.hex,
+            ccc.picker.css_rgb,
+            ccc.picker.css_hsl,
+            ccc.picker.ansi_escape {
+              meaning1 = "bright", -- whether the 1 means bright or yellow
+            },
+          }
+        '';
+        description = ''
+          List of formats that can be detected by |:CccPick| to be activated.
+        '';
+      };
+
+      alpha_show = mkOption {
+        type = enum [
+          "show"
+          "hide"
+          "auto"
+        ];
+        default = "hide";
+        description = ''
+          This option determines whether the alpha slider is displayed when the
+          UI is opened. "show" and "hide" mean as they are. "auto" makes the
+          slider appear only when the alpha value can be picked up.
+        '';
+      };
+
+      recognize = mkOption {
+        type = luaInline;
+        default = mkLuaInline ''
+          { output = true }
+        '';
+        description = "Settings for recognizing the color format.";
+      };
+
+      inputs = mkOption {
+        type = listOf (enum [
+          "rgb"
+          "hsl"
+          "hwb"
+          "lab"
+          "lch"
+          "oklab"
+          "oklch"
+          "cmyk"
+          "hsluv"
+          "okhsl"
+          "hsv"
+          "okhsv"
+          "xyz"
+        ]);
+        default = [
+          "hsl"
+        ];
+        description = ''
+          List of color systems to be activated.
+
+          The toggle input mode action toggles in this order. The first one is
+          the default used at the first startup. Once activated, it will keep the
+          previous input mode.
+        '';
+      };
+
+      outputs = mkOption {
+        type = listOf (enum [
+          "hex"
+          "hex_short"
+          "css_hsl"
+          "css_rgb"
+          "css_rgba"
+          "css_hwb"
+          "css_lab"
+          "css_lch"
+          "css_oklab"
+          "css_oklch"
+          "float"
+        ]);
+        default = [
+          "css_hsl"
+          "css_rgb"
+          "hex"
+        ];
+        description = ''
+          List of output formats to be activated.
+
+          The toggle output mode action toggles in this order. The first one is
+          the default used at the first startup. Once activated, it will keep the
+          previous output mode.
+        '';
+      };
+
+      convert = mkOption {
+        type = luaInline;
+        default = mkLuaInline ''
+          {
+            { ccc.picker.hex, ccc.output.css_hsl },
+            { ccc.picker.css_rgb, ccc.output.css_hsl },
+            { ccc.picker.css_hsl, ccc.output.hex },
+          }
+        '';
+        description = ''
+          Specify the correspondence between picker and output.
+        '';
+      };
+
+      mappings = mkOption {
+        type = luaInline;
+        default = mkLuaInline ''
+          {
+            ["q"] = ccc.mapping.quit,
+            ["L"] = ccc.mapping.increase10,
+            ["H"] = ccc.mapping.decrease10,
+          }
+        '';
+        description = ''
+          The mappings are set in the UI of ccc. The table where lhs is key and
+          rhs is value. To disable all default mappings, use
+          disable_default_mappings. To disable only some of the default
+          mappings, set ccc.mapping.none.
+        '';
+      };
+    };
+
     mappings = {
       quit = mkMappingOption "Cancel and close the UI without replace or insert" "<Esc>";
       increase10 = mkMappingOption "Increase the value times delta of the slider" "<L>";

modules/plugins/utility/ccc/config.nix

@@ -5,48 +5,23 @@
 }: let
   inherit (lib.modules) mkIf;
   inherit (lib.nvim.dag) entryAnywhere;
-
+  inherit (lib.nvim.lua) toLuaObject;
+  inherit (lib.generators) mkLuaInline;
   cfg = config.vim.utility.ccc;
+  mkLuaIdentifier = prefix: identifier: mkLuaInline "${prefix}${identifier}";
+  mapSetupOptions = setupOpts:
+    setupOpts
+    // {
+      inputs = map (mkLuaIdentifier "ccc.input.") setupOpts.inputs;
+      outputs = map (mkLuaIdentifier "ccc.output.") setupOpts.outputs;
+    };
 in {
   config = mkIf cfg.enable {
     vim.startPlugins = ["ccc-nvim"];
 
     vim.pluginRC.ccc = entryAnywhere ''
       local ccc = require("ccc")
-      ccc.setup {
+      ccc.setup(${toLuaObject (mapSetupOptions cfg.setupOpts)})
-      	highlighter = {
-      		auto_enable = true,
-      		max_byte = 2 * 1024 * 1024, -- 2mb
-      		lsp = true,
-      		filetypes = colorPickerFts,
-      	},
-      	pickers = {
-      		ccc.picker.hex,
-      		ccc.picker.css_rgb,
-      		ccc.picker.css_hsl,
-      		ccc.picker.ansi_escape {
-      			meaning1 = "bright", -- whether the 1 means bright or yellow
-      		},
-      	},
-      	alpha_show = "hide", -- needed when highlighter.lsp is set to true
-      	recognize = { output = true }, -- automatically recognize color format under cursor
-      	inputs = { ccc.input.hsl },
-      	outputs = {
-      		ccc.output.css_hsl,
-      		ccc.output.css_rgb,
-      		ccc.output.hex,
-      	},
-      	convert = {
-      		{ ccc.picker.hex, ccc.output.css_hsl },
-      		{ ccc.picker.css_rgb, ccc.output.css_hsl },
-      		{ ccc.picker.css_hsl, ccc.output.hex },
-      	},
-      	mappings = {
-      		["q"] = ccc.mapping.quit,
-      		["L"] = ccc.mapping.increase10,
-      		["H"] = ccc.mapping.decrease10,
-      	},
-      }
     '';
   };
 }