Skip to content

docs(cli): 💅 add option grouping and examples - #553

Merged
BioPhoton merged 11 commits into
mainfrom
improve-help-command
Mar 12, 2024
Merged

docs(cli): 💅 add option grouping and examples#553
BioPhoton merged 11 commits into
mainfrom
improve-help-command

Conversation

@BioPhoton

@BioPhotonBioPhoton commented Mar 9, 2024

Copy link
Copy Markdown
Collaborator

This PR improves the help command. 💅

You can print the help text to the console by running code-pushup <any command or none> --help or code-pushup help.

Included changes:

  • adoption of cli wrapper. Added groups and examples properties and logic
  • added groups to cli object
  • added examples to cli object

Terminal output:

before improvementsafter improvements✨
Screenshot 2024-03-09 at 03 56 44Screenshot 2024-03-09 at 03 48 43

@github-actionsgithub-actionsBot added the 🔬 testing writing tests label Mar 9, 2024
@BioPhotonBioPhoton changed the title docs(cli): add option grouping and examplesdocs(cli): 💅 add option grouping and examplesMar 9, 2024
@BioPhoton
BioPhoton marked this pull request as ready for review March 9, 2024 03:20
@BioPhoton
BioPhoton requested a review from Tlacenka as a code ownerMarch 9, 2024 03:20

@matejchalkmatejchalk left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a nice improvement 🙂

Comment threade2e/cli-e2e/tests/__snapshots__/help.e2e.test.ts.snap
Comment threadpackages/cli/src/lib/cli.ts
@nx-cloud

nx-cloudBot commented Mar 11, 2024

Copy link
Copy Markdown

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 35be2a1. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 9 targets

Sent with 💌 from NxCloud.

@BioPhoton
BioPhoton requested review from matejchalk and removed request for TlacenkaMarch 11, 2024 19:27
Comment threade2e/cli-e2e/tests/help.e2e.test.ts Outdated
Comment threade2e/cli-e2e/tests/__snapshots__/help.e2e.test.ts.snap Outdated

@matejchalkmatejchalk left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me 👍

Do you also want to integrate the compare options from #556, as discussed here? #556 (comment)

@BioPhoton
BioPhoton merged commit b508105 into mainMar 12, 2024
@BioPhoton
BioPhoton deleted the improve-help-command branch March 12, 2024 15:33
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@BioPhoton@matejchalk