Add silent flag to allow raw output #2420

rafaelrinaldi · 2017-01-10T02:48:52Z

Summary

This PR implements a --silent flag (-s for short) to Yarn's CLI in order to allow raw script output. This feature is available on npm and is very useful for when you want to pipe the output of a script as an input of another script.

Test plan

Add a foo script to your package.json that prints a simple message:

{
  "scripts": {
    "foo": "echo 'it works'"
  }
}

The default behavior will give you the script output followed by a header and a footer added by Yarn:

$ yarn run foo
yarn run v0.20.0-0
$ echo 'it works' 
it works
✨  Done in 0.14s.

However, if you want only the raw script output you can append the --silent flag:

$ yarn run foo --silent # or simply `-s`
it works

This is my first PR to Yarn so please let me know if I need to change anything in order to make it acceptable for review. Thanks!

bestander

This makes sense and can be useful.
I think a unit test won't be necessary.
Can you add to your test plan how it behaves with other commands:
--version
install

bestander · 2017-01-12T19:28:11Z

src/reporters/console/console-reporter.js

@@ -142,6 +143,7 @@ export default class ConsoleReporter extends BaseReporter {
  }

  _log(msg: string) {
+    if (this.isSilent) { return; }


style nit: afaik we don't inline if blocks, could you expand it to 3 lines?

Sure thing. Here you go: 001aee0

rafaelrinaldi · 2017-01-13T04:51:25Z

@bestander Since the goal of this feature is to enable interoperability between scripts and CLI tools, it should only be used together with the run command. Shouldn't affect the output of any other commands.

bestander · 2017-01-14T18:54:50Z

@rafaelrinaldi, the change touches the generic src/cli/index.js and base-reporter.js, would not it affect all the commands then?

rafaelrinaldi · 2017-01-17T16:18:05Z

@bestander It would only affect the run command, other commands will simply ignore it. I could not find a different way to implement this feature, let me know if you have any suggestions.

bestander · 2017-01-18T16:07:23Z

The change touches ConsoleReporter which is injected into config and then used in many places.
How come it is only used in run command and not others?

rafaelrinaldi · 2017-01-18T16:27:46Z

@bestander As my PR says, this is a feature available on npm already and this is intended to be a implementation of the exact same feature. On npm it's a flag for the run command, it won't affect any other commands at all.

Let me know if either intent or implementation are not clear.

bestander · 2017-01-18T16:45:33Z

src/reporters/console/console-reporter.js

    this.format = (chalk: any);
+    this.isSilent = !!opts.isSilent;


The intent is great, thanks for starting the PR.
The implementation confuses me because ConsoleReporter is used in other commands, not only in run.
In the 3 changed files I don't see this setting being used for only run command.

As a matter fact, I think silent could be as useful for other commands, too.
We just need to be aware of the effects.

@bestander Got it. What do you think I should do? The only file that made sense to me during implementation was console-reporter.js.

I think your solution makes total sense even for install and check commands.
Just add it to your test plan and check what happens if you run other commands with this flag.

@bestander Alright, I will give it a shot as soon as I can. Thanks for the feedback 👍

@rafaelrinaldi – I'd love to see this merged, can I help in any way?

jonathanrdelgado · 2017-02-02T20:00:07Z

This is a much needed feature (as demonstrated by #788)

@rafaelrinaldi let me know if you want any help on this.

rafaelrinaldi · 2017-02-02T20:01:50Z

@jonathandelgado Thanks for volunteering. My plan is to submit my updates this weekend so @bestander can review.

mhipszki · 2017-02-03T13:05:34Z

👍 although does it also remove the measured time of the task running? that might be a feature still useful in "silent" mode

rafaelrinaldi · 2017-02-03T15:02:48Z

@mhipszki My idea is to reproduce exactly what npm offers. If we decide to change, we can do it separately.

mhipszki · 2017-02-04T10:05:16Z

@rafaelrinaldi makes sense!

bestander · 2017-02-05T02:09:26Z

So I tested this on install command, as expected, all the regular logs of install were hidden but progress bar and warnings were shown.

Actually I need this exact feature for a tool where Yarn's verbose install log is unnecessary, so I think we should get this feature in in some way..

However the flag should not be --silent, this feature mutes one of the reporters, console reporter, it does not run any Yarn operation silently.

@rafaelrinaldi, how about --no-console-logs?
We have another flag --no-progress that hides progress bars logs, I think it is sort of related.
Open to other suggestions.

rafaelrinaldi · 2017-02-05T19:59:02Z

@bestander Okay, I'm good with switching the names. Will update my PR.

bestander · 2017-02-21T13:01:29Z

@rafaelrinaldi ping, it would be great to get this in, do you have a chance to update the PR?

rafaelrinaldi · 2017-02-21T13:42:49Z

@bestander Sorry, been working like crazy lately and didn't had a chance to update. Wait until Saturday if possible, I will have some free time and can work on this 👍

bestander · 2017-02-21T14:11:05Z

Thanks :)

…

On Tue, 21 Feb 2017 at 13:42, Rafael Rinaldi ***@***.***> wrote: @bestander <https://github.com/bestander> Sorry, been working like crazy lately and didn't had a chance to update. Wait until Saturday if possible, I will have some free time and can work on this 👍 — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2420 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ACBdWCykqZAp73htLwPgsKY8GxI9v2mXks5reunhgaJpZM4Le-TG> .

rafaelrinaldi · 2017-02-27T21:32:29Z

@bestander I did most changes yesterday. I will submit a PR as soon as I get to my computer (probably tonight).

adamyonk · 2017-03-08T15:12:18Z

Thanks for tackling this, @rafaelrinaldi! I run into this quite often!

bestander · 2017-03-22T23:26:01Z

ping

rafaelrinaldi · 2017-04-04T00:10:17Z

@bestander Sorry for taking a long time to tackle this, been very busy. I'm gonna have some free time at the end of the week and will be able to update this properly.

bestander · 2017-04-05T17:02:42Z

src/cli/index.js

@@ -75,6 +75,10 @@ commander.option(
  '--no-emoji',
  'disable emoji in output',
 );
+commander.option(
+  '-s, --silent',
+  'raw script output',


nit: silence Yarn console logs would be closer to correct.
Technically it is not doing anything to raw output.

Nevermind, I just changed the message quickly.
Thanks for rebasing!

ghost · 2018-01-17T16:50:53Z

And is it possible to make every yarn $SCRIPT_NAME inokation silent without extra flag passing?

rafaelrinaldi · 2018-03-23T00:52:32Z

@le93us It is definitely possible but I don't believe this is the expected behavior. You could perhaps solve that with a local alias.

Add silent flag to allow raw output

a6f83d4

bestander reviewed Jan 12, 2017

View reviewed changes

Break down if block instead of inlining it.

001aee0

bestander reviewed Jan 18, 2017

View reviewed changes

arxpoetica mentioned this pull request Feb 9, 2017

Add --silent flag to CLI run command #788

Closed

bitjson mentioned this pull request Feb 28, 2017

browser build and tests bitjson/typescript-starter#13

Merged

bestander reviewed Apr 5, 2017

View reviewed changes

bestander merged commit 15faf3a into yarnpkg:master Apr 5, 2017

csvan mentioned this pull request Jun 16, 2017

how to hide the unuseful info #3649

Closed

supersam654 mentioned this pull request Jun 24, 2021

Add clear message when rails new finishes rails/rails#42546

Closed

sio4 mentioned this pull request Feb 25, 2022

Buffalo new does not support Yarn 2+ (berry) gobuffalo/cli#95

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add silent flag to allow raw output #2420

Add silent flag to allow raw output #2420

rafaelrinaldi commented Jan 10, 2017 •

edited

bestander left a comment

bestander Jan 12, 2017

rafaelrinaldi Jan 13, 2017

rafaelrinaldi commented Jan 13, 2017

bestander commented Jan 14, 2017

rafaelrinaldi commented Jan 17, 2017

bestander commented Jan 18, 2017

rafaelrinaldi commented Jan 18, 2017

bestander Jan 18, 2017

rafaelrinaldi Jan 18, 2017

bestander Jan 18, 2017

rafaelrinaldi Jan 18, 2017

bitjson Feb 27, 2017

jonathanrdelgado commented Feb 2, 2017

rafaelrinaldi commented Feb 2, 2017

mhipszki commented Feb 3, 2017

rafaelrinaldi commented Feb 3, 2017

mhipszki commented Feb 4, 2017

bestander commented Feb 5, 2017 •

edited

rafaelrinaldi commented Feb 5, 2017

bestander commented Feb 21, 2017

rafaelrinaldi commented Feb 21, 2017

bestander commented Feb 21, 2017 via email

rafaelrinaldi commented Feb 27, 2017

adamyonk commented Mar 8, 2017

bestander commented Mar 22, 2017

rafaelrinaldi commented Apr 4, 2017

bestander Apr 5, 2017

bestander Apr 5, 2017

ghost commented Jan 17, 2018

rafaelrinaldi commented Mar 23, 2018 •

edited

Add silent flag to allow raw output #2420

Add silent flag to allow raw output #2420

Conversation

rafaelrinaldi commented Jan 10, 2017 • edited

bestander left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rafaelrinaldi commented Jan 13, 2017

bestander commented Jan 14, 2017

rafaelrinaldi commented Jan 17, 2017

bestander commented Jan 18, 2017

rafaelrinaldi commented Jan 18, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonathanrdelgado commented Feb 2, 2017

rafaelrinaldi commented Feb 2, 2017

mhipszki commented Feb 3, 2017

rafaelrinaldi commented Feb 3, 2017

mhipszki commented Feb 4, 2017

bestander commented Feb 5, 2017 • edited

rafaelrinaldi commented Feb 5, 2017

bestander commented Feb 21, 2017

rafaelrinaldi commented Feb 21, 2017

bestander commented Feb 21, 2017 via email

rafaelrinaldi commented Feb 27, 2017

adamyonk commented Mar 8, 2017

bestander commented Mar 22, 2017

rafaelrinaldi commented Apr 4, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Jan 17, 2018

rafaelrinaldi commented Mar 23, 2018 • edited

rafaelrinaldi commented Jan 10, 2017 •

edited

bestander commented Feb 5, 2017 •

edited

rafaelrinaldi commented Mar 23, 2018 •

edited