Immediate follow

[Nukesor]

Resolves #592

[github-actions]

Test Results

  3 files   19 suites   3m 25s ⏱️
174 tests 174 ✅ 0 💤 0 ❌
366 runs  366 ✅ 0 💤 0 ❌

Results for commit ccd3cb2.

♻️ This comment has been updated with latest results.

[codecov]

Codecov Report

Attention: Patch coverage is 85.15625% with 19 lines in your changes missing coverage. Please review.

Project coverage is 80.89%. Comparing base (117f2bd) to head (ccd3cb2).
Report is 6 commits behind head on main.

Files with missing lines	Patch %	Lines
pueue/src/client/client.rs	84.11%	17 Missing ⚠️
pueue/src/client/cli.rs	0.00%	1 Missing ⚠️
pueue_lib/src/format.rs	83.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #595      +/-   ##
==========================================
+ Coverage   80.80%   80.89%   +0.09%     
==========================================
  Files          74       75       +1     
  Lines        5912     5942      +30     
==========================================
+ Hits         4777     4807      +30     
  Misses       1135     1135              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[katrinafyi]

Looks good! Thanks for working on this :)

Tested:

• follow works with fast command: ./pueue add -i --follow -- 'ls'
• follow continues command in background on ctrl+c
• follow requires immediate flag to be set

I have a few very small comments. You can think about these if you want or ignore them.

• the error message when using --follow without -i might be unclear. it says "error: the following required arguments were not provided: --immediate", but it's not obvious that --immediate is only required when --follow is given. i don't know if this is easy to change in the argument parsing library
• if you Ctrl+C while following, it might not be obvious that the task continues. for comparison, when pressing Ctrl+Z in a shell, it prints ^Zfish: Job 2, 'sleep 100' has stopped
• i'm not sure if this was deliberate, but the new task ID is not shown. i think it's useful to know the ID for using with other commands. a message like New task added (id 18). (same as using add without follow) could also help address the previous point.

Thanks again!

[Nukesor]

1. That's a limit of the CLI library and I think the error is clear enough.
2. Just to be clear. Pueue does not aim to re-implement or replace the background task logic of the shell. I know that nushell uses it for that and that you're using it as a fancy & but that's not what it has been designed for.
   To be honest, I'm already starting to get a bad feeling about this feature request, because this is exactly the type of user behavior that'll be attracted by this feature, leading to more feature requests of this type.
   I'll reconsider again whether I'll actually merge this.
3. The current behavior exactly matches the --follow behavior, which is to print the exact stdout output to the shell. Prepending any other output would potentially break pipes into other commands. E.g. somebody pipes the command's json output into jq or some follow-up command.

[katrinafyi]

Re (3), I think the output should have the output of add then follow, since it does the tasks of both. I don't know if it makes sense to pipe --follow to another command, as the pipe would be broken if the command is Ctrl+C'ed. Printing the ID still lets you do a pipe by manually using pueue follow ID | ....

Re (2), I understand.

[Nukesor]

3. Hmm. I guess a good alternative to that would be to print all of Pueue's info/error log output to stderr, which would be a good practice anyway.

[Nukesor]

I changed the behavior to print the add output to stderr and the actual log output to stdout so the piping usecase is still viable.

I'll also merge this MR for the time being, but I don't plan to add any further features that aid Pueue mimicking as a shell background task manager. Stuff like that is the job of the shell itself :)