FEATURE: add a pretty output to `toolkit check pr` #8416

amtoine · 2023-03-12T12:46:18Z

when i write a PR, i run the tests and i like to have a pretty output to make extra clear which one of the tests did run, which one did not, etc, etc...

this always end up a variation of the template

cargo fmt --all -- --check to check standard code formatting (cargo fmt --all applies these changes)

cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect to check that you're using the standard code style

cargo test --workspace to check that all tests pass

but with emojis and without the descriptions

🟢 cargo fmt --all

🔴 cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect

🟡 cargo test --workspace

and a ⚫ (:black_circle:) when i did not have the time or the resources to run the check stage

in this PR, i came up with a way to do that automatically with the toolkit introduced in #8152 😋

Description

this PR

adds toolkit::pretty-print-command to print the command names being run with backticks and some colors
adds toolkit::report to return a "report" of the PR check stages => see help toolkit check pr
adds the --pretty option to toolkit check pr to return a list-with-emojis version of the check report, i.e. a GitHub-friendly list to drop in place in the "Tests + Formatting" section
adds a clear mention to toolkit check pr --pretty in the PR template to make it easily visible to anyone

hope you'll like it, that's not a huge deal but that's my attempt to encourage developers to show that they run the tests, what stages did pass and which one did not 😌 👋

User-Facing Changes

the developer can now use toolkit check pr --pretty to have a ready-to-use output for GitHub

Tests + Formatting

$nothing

After Submitting

$nothing

This commit allows the developer to run ```bash toolkit check pr --pretty ``` and get a *GitHub*-friendly output to be copy-pasted to the PR.

This is to encourage the use of a common way of showing the tests pass - a red circle means the stage does not pass - a green circle means the stage passes - a black circle means the stage did not run because of previous stages

fdncred · 2023-03-12T12:56:28Z

I'm confused, what's the pretty output look like?

codecov · 2023-03-12T13:13:36Z

Codecov Report

Merging #8416 (9f972bc) into main (a52386e) will increase coverage by 0.39%.
The diff coverage is n/a.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8416      +/-   ##
==========================================
+ Coverage   68.11%   68.50%   +0.39%     
==========================================
  Files         620      620              
  Lines       99709    99723      +14     
==========================================
+ Hits        67914    68317     +403     
+ Misses      31795    31406     -389

see 8 files with indirect coverage changes

amtoine · 2023-03-12T14:16:34Z

I'm confused, what's the pretty output look like?

yes of course, let me show you 👍

amtoine · 2023-03-12T14:19:59Z

without the `--pretty` option

if the formatting stage fails

╭────────┬───────╮
│ fmt    │ false │
│ clippy │       │
│ test   │       │
╰────────┴───────╯

if the clippy stage fails

╭────────┬───────╮
│ fmt    │ true  │
│ clippy │ false │
│ test   │       │
╰────────┴───────╯

if the test stage fails

╭────────┬───────╮
│ fmt    │ true  │
│ clippy │ true  │
│ test   │ false │
╰────────┴───────╯

if all the stages pass

╭────────┬──────╮
│ fmt    │ true │
│ clippy │ true │
│ test   │ true │
╰────────┴──────╯

with the `--pretty` option

if the formatting stage fails

🔴 toolkit fmt

⚫ toolkit clippy

⚫ toolkit test

if the clippy stage fails

🟢 toolkit fmt

🔴 toolkit clippy

⚫ toolkit test

if the test stage fails

🟢 toolkit fmt

🟢 toolkit clippy

🔴 toolkit test

if all the stages pass

🟢 toolkit fmt

🟢 toolkit clippy

🟢 toolkit test

amtoine · 2023-03-12T14:20:35Z

so the --pretty options outputs the emojis to have the colored circles and an easy to understand status of the tests 👍

fdncred · 2023-03-12T23:39:32Z

.github/pull_request_template.md

@@ -25,6 +25,10 @@ Make sure you've run and fixed any issues with these commands:
 > use toolkit.nu  # or use an `env_change` hook to activate it automatically
 > toolkit check pr
 > ```
+> you can replace this whole "Tests + Formatting" section by the list output of


let's just make --pretty the default and not add these lines. I'd like to keep this template as abbreviated as possible.

should be fixed in 9f972bc 😋

amtoine · 2023-03-18T10:10:50Z

is there anything i can do here? 😋
( yes i wanted to use this new feature for a PR right now and saw it was not merged 😆 )

fdncred · 2023-03-18T12:58:31Z

Lost track of it. Thanks

amtoine · 2023-03-18T13:02:18Z

Lost track of it. Thanks

no worries, it's far easier for me to keep track of my own stuff 😉
i thought a friendly ping might help 😌

amtoine added 5 commits March 12, 2023 12:34

add some ANSI formatting on the output command names

e9b38c4

return a record report of all the check stages

9170881

refactor the "check pr" report in a tool function

7476490

add a --pretty option to toolkit check pr

e84241e

This commit allows the developer to run ```bash toolkit check pr --pretty ``` and get a *GitHub*-friendly output to be copy-pasted to the PR.

add a mention to --pretty in the PR template

077ba84

This is to encourage the use of a common way of showing the tests pass - a red circle means the stage does not pass - a green circle means the stage passes - a black circle means the stage did not run because of previous stages

fdncred reviewed Mar 12, 2023

View reviewed changes

make the pretty report the default of toolkit check pr

9f972bc

fdncred merged commit c66bd5e into nushell:main Mar 18, 2023

amtoine deleted the feature/add-a-pretty-output-to-toolkit-check-pr branch March 18, 2023 13:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FEATURE: add a pretty output to `toolkit check pr` #8416

FEATURE: add a pretty output to `toolkit check pr` #8416

amtoine commented Mar 12, 2023

fdncred commented Mar 12, 2023

codecov bot commented Mar 12, 2023 •

edited

Loading

amtoine commented Mar 12, 2023

amtoine commented Mar 12, 2023 •

edited

Loading

amtoine commented Mar 12, 2023

fdncred Mar 12, 2023

amtoine Mar 13, 2023

amtoine commented Mar 18, 2023

fdncred commented Mar 18, 2023

amtoine commented Mar 18, 2023

FEATURE: add a pretty output to toolkit check pr #8416

FEATURE: add a pretty output to toolkit check pr #8416

Conversation

amtoine commented Mar 12, 2023

Description

User-Facing Changes

Tests + Formatting

After Submitting

fdncred commented Mar 12, 2023

codecov bot commented Mar 12, 2023 • edited Loading

Codecov Report

amtoine commented Mar 12, 2023

amtoine commented Mar 12, 2023 • edited Loading

without the --pretty option

with the --pretty option

amtoine commented Mar 12, 2023

fdncred Mar 12, 2023

Choose a reason for hiding this comment

amtoine Mar 13, 2023

Choose a reason for hiding this comment

amtoine commented Mar 18, 2023

fdncred commented Mar 18, 2023

amtoine commented Mar 18, 2023

FEATURE: add a pretty output to `toolkit check pr` #8416

FEATURE: add a pretty output to `toolkit check pr` #8416

codecov bot commented Mar 12, 2023 •

edited

Loading

amtoine commented Mar 12, 2023 •

edited

Loading

without the `--pretty` option

with the `--pretty` option