plugins/dap: move to by-name

2025-07-30 15:44:41 +02:00 · 2024-09-04 17:34:55 +01:00 · 2024-09-04 17:34:55 +01:00 · 672b9e1ceb
commit 672b9e1ceb
parent 52f125679f
12 changed files with 0 additions and 2 deletions
--- a/plugins/by-name/dap/dapHelpers.nix
+++ b/plugins/by-name/dap/dapHelpers.nix
@ -0,0 +1,140 @@
+{ lib, helpers }:
+with lib;
+rec {
+  mkAdapterType =
+    attrs:
+    types.submodule {
+      options = {
+        id = helpers.mkNullOrOption types.str ''
+          Identifier of the adapter. This is used for the
+          `adapterId` property of the initialize request.
+          For most debug adapters setting this is not necessary.
+        '';
+
+        enrichConfig = helpers.mkNullOrLuaFn ''
+          A lua function (`func(config, on_config)`) which allows an adapter to enrich a
+          configuration with additional information. It receives a configuration as first
+          argument, and a callback that must be called with the final configuration as second argument.
+        '';
+
+        options = {
+          initializeTimeoutSec = helpers.defaultNullOpts.mkInt 4 ''
+            How many seconds the client waits for a response on a initialize request before emitting a warning.
+          '';
+
+          disconnectTimeoutSec = helpers.defaultNullOpts.mkInt 3 ''
+            How many seconds the client waits for a disconnect response from the debug
+            adapter before emitting a warning and closing the connection.
+          '';
+
+          sourceFiletype = helpers.mkNullOrOption types.str ''
+            The filetype to use for content retrieved via a source request.
+          '';
+        };
+      } // attrs;
+    };
+
+  executableAdapterOption = mkAdapterType {
+    command = helpers.mkNullOrOption types.str "The command to invoke.";
+
+    args = helpers.mkNullOrOption (types.listOf types.str) "Arguments for the command.";
+
+    options = {
+      env = helpers.mkNullOrOption types.attrs "Set the environment variables for the command.";
+
+      cwd = helpers.mkNullOrOption types.str "Set the working directory for the command.";
+
+      detached = helpers.defaultNullOpts.mkBool true "Start the debug adapter in a detached state.";
+    };
+  };
+
+  serverAdapterOption = mkAdapterType {
+    host = helpers.defaultNullOpts.mkStr "127.0.0.1" "Host to connect to.";
+
+    port = helpers.mkNullOrOption (types.either types.int (types.enum [ "$\{port}" ])) ''
+      Port to connect to.
+      If "$\{port}" dap resolves a free port.
+      This is intended to be used with `executable.args`.
+    '';
+
+    executable = {
+      command = helpers.mkNullOrOption types.str "Command that spawns the adapter.";
+
+      args = helpers.mkNullOrOption (types.listOf types.str) "Command arguments.";
+
+      detached = helpers.defaultNullOpts.mkBool true "Spawn the debug adapter in detached state.";
+
+      cwd = helpers.mkNullOrOption types.str "Working directory.";
+    };
+
+    options.maxRetries = helpers.defaultNullOpts.mkInt 14 ''
+      Amount of times the client should attempt to connect before erroring out.
+      There is a 250ms delay between each retry.
+    '';
+  };
+
+  mkAdapterOption =
+    name: type:
+    helpers.mkNullOrOption (with types; attrsOf (either str type)) ''
+      Debug adapters of `${name}` type.
+      The adapters can also be set to a function which takes three arguments:
+
+      - A `on_config` callback. This must be called with the actual adapter table.
+      - The |dap-configuration| which the user wants to use.
+      - An optional parent session. This is only available if the debug-adapter
+        wants to start a child-session via a `startDebugging` request.
+
+      This can be used to defer the resolving of the values to when a configuration
+      is used. A use-case for this is starting an adapter asynchronous.
+    '';
+
+  configurationOption = types.submodule {
+    freeformType = types.attrs;
+
+    options = {
+      type = mkOption {
+        description = "Which debug adapter to use.";
+        type = types.str;
+      };
+
+      request = mkOption {
+        type = types.enum [
+          "attach"
+          "launch"
+        ];
+        description = ''
+          Indicates whether the debug adapter should launch a debuggee or attach to one that is already running.
+        '';
+      };
+
+      name = mkOption {
+        type = types.str;
+        description = "A user readable name for the configuration.";
+      };
+    };
+  };
+
+  mkSignOption = default: desc: {
+    text = helpers.defaultNullOpts.mkStr default desc;
+    texthl = helpers.mkNullOrOption types.str "`texthl` for sign.";
+    linehl = helpers.mkNullOrOption types.str "`linehl` for sign.";
+    numhl = helpers.mkNullOrOption types.str "`numhl` for sign.";
+  };
+
+  processAdapters =
+    type: adapters:
+    with builtins;
+    mapAttrs (
+      _: adapter:
+      if isString adapter then
+        helpers.mkRaw adapter
+      else
+        filterAttrs (n: _: n != "enrichConfig") (
+          adapter
+          // {
+            inherit type;
+            enrich_config = adapter.enrichConfig;
+          }
+        )
+    ) adapters;
+}