Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The explain feature is cool but it's hidden #7

Open
nahsra opened this issue Dec 20, 2023 · 2 comments
Open

The explain feature is cool but it's hidden #7

nahsra opened this issue Dec 20, 2023 · 2 comments

Comments

@nahsra
Copy link
Contributor

nahsra commented Dec 20, 2023

When I run pixee fix <dir>, I get great output, but I don't know the details of the changes being made, but that's my immediate next question. I found out later I could use pixee explain to search through the changes and see the ones I want. This was fantastic, but I had to discover about pixee explain later.

Can we tell the user to run pixee explain right after, or better yet, just "go into" that mode after the changes are done?

Said another way -- right now the use case for running pixee fix . feels like: "Run the codemods and show me what codemods hit." That doesn't feel right -- it should be "Run the codemods and show me the details of the changes."

@drdavella
Copy link
Member

Thanks for the feedback!

I agree it's not too intuitive, but I also think there's value in having the default provide a smaller, more digestible summary.

How would you feel if we keep the default behavior but running pixee fix --explain puts you into explain mode after the results summary? And we could make sure to call out this option in the default output of pixee fix.

@AmanPython
Copy link
Contributor

AmanPython commented Dec 26, 2023

Hi @drdavella,

I agree with your suggestion that there's value in having the default provide a smaller, more digestible summary. I also suggest the following changes:

  • Add pixee explain in the results of pixee fix . to see the changes.
  • Running pixee fix --explain will put the user into explain mode after the results summary.

PR for above change

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants