nix/2.home-manager
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

zed-editor: options to generate debug.json

Browse source 
Add `mutableUserDebug` and `userDebug` options to generate `debug.json` file.
The options are heavily inspired by `mutableUserTasks` and `userTasks` options implementation.

Closes #8091
This commit is contained in:
Pierre-Yves Landuré 2025-10-31 12:01:41 +01:00 • committed by Austin Horstman
parent 95d65dddae
commit 1f34c2c855
5 changed files with 285 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

83
tests/modules/programs/zed-editor/debug-empty.nix Normal file
View file

@ -0,0 +1,83 @@
{
config,
lib,
pkgs,
...
}:
{
programs.zed-editor = {
enable = true;
package = config.lib.test.mkStubPackage { };
userDebug = [
{
label = "PHP: Listen to Xdebug";
adapter = "Xdebug";
request = "launch";
port = 9003;
}
{
label = "PHP: Debug this test";
adapter = "Xdebug";
request = "launch";
program = "vendor/bin/phpunit";
args = [
"--filter"
"$ZED_SYMBOL"
];
}
];
};
home.homeDirectory = lib.mkForce "/@TMPDIR@/hm-user";
nmt.script =
let
preexistingDebug = builtins.toFile "preexisting.json" "";
expectedContent = builtins.toFile "expected.json" ''
[
{
"adapter": "Xdebug",
"args": [
"--filter",
"$ZED_SYMBOL"
],
"label": "PHP: Debug this test",
"program": "vendor/bin/phpunit",
"request": "launch"
},
{
"adapter": "Xdebug",
"label": "PHP: Listen to Xdebug",
"port": 9003,
"request": "launch"
}
]
'';
debugPath = ".config/zed/debug.json";
activationScript = pkgs.writeScript "activation" config.home.activation.zedDebugActivation.data;
in
''
export HOME=$TMPDIR/hm-user
# Simulate preexisting debug
mkdir -p $HOME/.config/zed
cat ${preexistingDebug} > $HOME/${debugPath}
# Run the activation script
substitute ${activationScript} $TMPDIR/activate --subst-var TMPDIR
chmod +x $TMPDIR/activate
$TMPDIR/activate
# Validate the merged debug
assertFileExists "$HOME/${debugPath}"
assertFileContent "$HOME/${debugPath}" "${expectedContent}"
# Test idempotency
$TMPDIR/activate
assertFileExists "$HOME/${debugPath}"
assertFileContent "$HOME/${debugPath}" "${expectedContent}"
'';
}

58
tests/modules/programs/zed-editor/debug-immutable.nix Normal file
View file

@ -0,0 +1,58 @@
# Test custom keymap functionality
{ config, ... }:
{
programs.zed-editor = {
enable = true;
package = config.lib.test.mkStubPackage { };
mutableUserDebug = false;
userDebug = [
{
label = "PHP: Listen to Xdebug";
adapter = "Xdebug";
request = "launch";
port = 9003;
}
{
label = "PHP: Debug this test";
adapter = "Xdebug";
request = "launch";
program = "vendor/bin/phpunit";
args = [
"--filter"
"$ZED_SYMBOL"
];
}
];
};
nmt.script =
let
expectedContent = builtins.toFile "expected.json" ''
[
{
"adapter": "Xdebug",
"label": "PHP: Listen to Xdebug",
"port": 9003,
"request": "launch"
},
{
"adapter": "Xdebug",
"args": [
"--filter",
"$ZED_SYMBOL"
],
"label": "PHP: Debug this test",
"program": "vendor/bin/phpunit",
"request": "launch"
}
]
'';
settingsPath = ".config/zed/debug.json";
in
''
assertFileExists "home-files/${settingsPath}"
assertFileContent "home-files/${settingsPath}" "${expectedContent}"
'';
}

100
tests/modules/programs/zed-editor/debug.nix Normal file
View file

@ -0,0 +1,100 @@
{
config,
lib,
pkgs,
...
}:
{
programs.zed-editor = {
enable = true;
package = config.lib.test.mkStubPackage { };
userDebug = [
{
label = "PHP: Listen to Xdebug";
adapter = "Xdebug";
request = "launch";
port = 9003;
}
{
label = "PHP: Debug this test";
adapter = "Xdebug";
request = "launch";
program = "vendor/bin/phpunit";
args = [
"--filter"
"$ZED_SYMBOL"
];
}
];
};
home.homeDirectory = lib.mkForce "/@TMPDIR@/hm-user";
nmt.script =
let
preexistingDebug = builtins.toFile "preexisting.json" ''
[
{
"label": "Debug active Python file",
"adapter": "Debugpy",
"program": "$ZED_FILE",
"request": "launch",
"cwd": "$ZED_WORKTREE_ROOT"
}
]
'';
expectedContent = builtins.toFile "expected.json" ''
[
{
"label": "Debug active Python file",
"adapter": "Debugpy",
"program": "$ZED_FILE",
"request": "launch",
"cwd": "$ZED_WORKTREE_ROOT"
},
{
"adapter": "Xdebug",
"args": [
"--filter",
"$ZED_SYMBOL"
],
"label": "PHP: Debug this test",
"program": "vendor/bin/phpunit",
"request": "launch"
},
{
"adapter": "Xdebug",
"label": "PHP: Listen to Xdebug",
"port": 9003,
"request": "launch"
}
]
'';
debugPath = ".config/zed/debug.json";
activationScript = pkgs.writeScript "activation" config.home.activation.zedDebugActivation.data;
in
''
export HOME=$TMPDIR/hm-user
# Simulate preexisting debug
mkdir -p $HOME/.config/zed
cat ${preexistingDebug} > $HOME/${debugPath}
# Run the activation script
substitute ${activationScript} $TMPDIR/activate --subst-var TMPDIR
chmod +x $TMPDIR/activate
$TMPDIR/activate
# Validate the merged debug
assertFileExists "$HOME/${debugPath}"
assertFileContent "$HOME/${debugPath}" "${expectedContent}"
# Test idempotency
$TMPDIR/activate
assertFileExists "$HOME/${debugPath}"
assertFileContent "$HOME/${debugPath}" "${expectedContent}"
'';
}

3
tests/modules/programs/zed-editor/default.nix
View file

@ -11,5 +11,8 @@
zed-tasks = ./tasks.nix;
zed-tasks-immutable = ./tasks-immutable.nix;
zed-tasks-empty = ./tasks-empty.nix;
zed-debug = ./debug.nix;
zed-debug-immutable = ./debug-immutable.nix;
zed-debug-empty = ./debug-empty.nix;
zed-themes = ./themes;
}