Skip to content

Remove stdout as format argument #247

Closed

Description

@BioPhoton

Extract of #191
The stdout format should be removed. We will always have some output, but some of it will be behind --verbose flag.

Current behavior

The report summary is printed to stdout based on the persist.format value (set in code-pushup.config.ts or via --persist.format CLI argument).

The default format is ['json', 'stdout']. It is not possible to skip 'json' (we create it anyway regardless, it's needed for the upload). However, if a user wants to get a Markdown report as well, they can easily omit stdout without realizing it. E.g. if they add --persist.format=md, then it removes stdout because the array is replaced.

Proposed change

We print the report summary regardless, and stdout will be removed from possible format values. If the user specifies --persist.format=md, then they will still see the report summary in the stdout.

The results of audits and categories are the most relevant information for the user when they run collect, and the report summary is minimal by design.

Activity

  1. added this to the 2. Integration milestone on Nov 14, 2023
  2. vmasek commented on Nov 14, 2023

    @vmasek
    Collaborator

    Is there stdout used as of now in CLI? If not, please close the issue

  3. BioPhoton commented on Nov 14, 2023

    @BioPhoton
    CollaboratorAuthor

    it is used

  4. changed the title [-]Remove `stdout` format[/-] [+]Remove `stdout` as format argument[/+] on Nov 22, 2023
  5. BioPhoton commented on Nov 22, 2023

    @BioPhoton
    CollaboratorAuthor

    Let's also add that the json file will get generated in any case.

  6. self-assigned this
    on Nov 23, 2023
  7. added a commit that references this issue on Nov 26, 2023
    9bc03d7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions