Merge pull request #582 from Nukesor/edit-tasks

change(edit): New way to edit tasks

CHANGELOG.md

@@ -21,6 +21,27 @@ The new state design resolves this issue by allowing Pueue to manipulate subproc
 
 TLDR: Commands that start/stop/kill/pause tasks now only return when the task is actually started/stopped/killed/paused.
 
+### New editing
+
+Task editing was a bit tedious until recently.
+One could only edit a single task at a time and you had to specify which properties you wanted to add.
+Each property was then opened in a new `$EDITOR` session, which meant that users had to open and close editors up to four times to edit a single task.
+
+After a lot of consideration, a new way of editing tasks has been designed that allows simple and convenient editing of multiple tasks at once.
+For this, a temporary directory is created for every task to edit and a new file for every property, resulting in the following structure:
+
+```
+   📁 0/
+   │ * command
+   │ * label
+   │ * path
+   └ * priority
+```
+
+You can then just navigate the resulting file structure and edit the properties you want in the editor of your choice.
+
+I'm aware that this might not be for everyone, so feedback is very much encouraged over [here](https://github.com/Nukesor/pueue/issues/553).
+
 ### Runtime invariants
 
 Previously, various task-state related invariants were enforced during runtime. For example, a `Queued` task should not have a `start` or `enqueued_at` time set.
@@ -46,6 +67,7 @@ TLDR: The new task state representation is more verbose but significantly cleane
 - Send log output to `stderr` instead of `stdout` [#562](https://github.com/Nukesor/pueue/issues/562).
 - Change default log level from error to warning [#562](https://github.com/Nukesor/pueue/issues/562).
 - Bumped MSRV to 1.70.
+- **Breaking**: Redesigned task editing process [#553](https://github.com/Nukesor/pueue/issues/553).
 
 ### Add
 

pueue/src/bin/pueued.rs

@@ -138,6 +138,7 @@ fn fork_daemon(opt: &CliArguments) -> Result<()> {
         command.creation_flags(CREATE_NO_WINDOW);
     }
 
+    #[allow(clippy::zombie_processes)]
     command
         .args(&arguments)
         .spawn()

pueue/src/client/cli.rs

@@ -214,21 +214,9 @@ pub enum SubCommand {
         #[arg(long)]
         not_in_place: bool,
 
-        /// Edit the tasks' commands before restarting.
+        /// Edit the task before restarting.
         #[arg(short, long)]
         edit: bool,
-
-        /// Edit the tasks' paths before restarting.
-        #[arg(short = 'p', long)]
-        edit_path: bool,
-
-        /// Edit the tasks' labels before restarting.
-        #[arg(short = 'l', long)]
-        edit_label: bool,
-
-        /// Edit the tasks' priorities before restarting.
-        #[arg(short = 'o', long)]
-        edit_priority: bool,
     },
 
     #[command(about = "Either pause running tasks or specific groups of tasks.\n\
@@ -282,30 +270,12 @@ pub enum SubCommand {
         input: String,
     },
 
-    #[command(
-        about = "Edit the command, path, label, or priority of a stashed or queued task.\n\
-        By default only the command is edited.\n\
-        Multiple properties can be added in one go."
-    )]
+    #[command(about = "Adjust editable properties of a task.\n\
+        A temporary folder folder will be opened by your $EDITOR, which contains \n\
+        a file for each editable property.")]
     Edit {
-        /// The task's id.
-        task_id: usize,
-
-        /// Edit the task's command.
-        #[arg(short, long)]
-        command: bool,
-
-        /// Edit the task's path.
-        #[arg(short, long)]
-        path: bool,
-
-        /// Edit the task's label.
-        #[arg(short, long)]
-        label: bool,
-
-        /// Edit the task's priority.
-        #[arg(short = 'o', long)]
-        priority: bool,
+        /// The ids of all tasks that should be edited.
+        task_ids: Vec<usize>,
     },
 
     #[command(about = "Use this to add or remove groups.\n\

pueue/src/client/client.rs

@@ -203,23 +203,8 @@ impl Client {
                 Ok(false)
             }
 
-            SubCommand::Edit {
-                task_id,
-                command,
-                path,
-                label,
-                priority,
-            } => {
-                let message = edit(
-                    &mut self.stream,
-                    &self.settings,
-                    *task_id,
-                    *command,
-                    *path,
-                    *label,
-                    *priority,
-                )
-                .await?;
+            SubCommand::Edit { task_ids } => {
+                let message = edit(&mut self.stream, &self.settings, task_ids).await?;
                 self.handle_response(message)?;
                 Ok(true)
             }
@@ -243,9 +228,6 @@ impl Client {
                 in_place,
                 not_in_place,
                 edit,
-                edit_path,
-                edit_label,
-                edit_priority,
             } => {
                 // `not_in_place` superseeds both other configs
                 let in_place =
@@ -260,9 +242,6 @@ impl Client {
                     *stashed,
                     in_place,
                     *edit,
-                    *edit_path,
-                    *edit_label,
-                    *edit_priority,
                 )
                 .await?;
                 Ok(true)