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

[Feature request] Print version at the beginning of the execution #3148

Open
4 of 6 tasks
psfinaki opened this issue Jan 14, 2025 · 2 comments
Open
4 of 6 tasks

[Feature request] Print version at the beginning of the execution #3148

psfinaki opened this issue Jan 14, 2025 · 2 comments

Comments

@psfinaki
Copy link
Contributor

I propose Fantomas prints its version at the very beginning of its execution.

The existing way to deal with this is to just separately ask for the tool version using --version.

Pros and Cons

The advantages of making this adjustment to Fantomas are:

  • sometimes multiple versions of the tool are installed on the machine (e.g. locally and globally) and having the version printed decreases cognitive load in these situations
  • this would also help maintainers since the screenshots with problems would also include the version number, reducing a need to communicate this
  • this is common behavior for many dotnet tools (at least in my practice)

The disadvantages of making this adjustment to Fantomas are - cannot think of any.

Extra information

Estimated cost (XS, S, M, L, XL, XXL): XS. Or XS/S if this is configurable.

Related suggestions: (put links to related suggestions here) - didn't find any.

Affidavit (please submit!)

Please tick this by placing a cross in the box:

Please tick all that apply:

  • This is not a breaking change to Fantomas
  • I or my company would be willing to help implement and/or test this
  • This suggestion is part of the Microsoft style guide (please add a link to section if so)
  • This suggestion is part of the G-Research style guide (please add a link to section if so)
@nojaf
Copy link
Contributor

nojaf commented Jan 14, 2025

Hmm, I'm not immediately drawn to a "yes" on this one. How many people really have this problem?

Sometimes multiple versions of the tool are installed on the machine (e.g., locally and globally), and having the version printed decreases cognitive load in these situations.

One could argue it also increases cognitive load. My initial reaction is that showing it all the time may not be that meaningful for most users.

This would also help maintainers since the screenshots with problems would include the version number, reducing the need to communicate this.

We expect folks to report issues via our online tool and would really like to discourage screenshots. The online tool allows us to verify if the problem is indeed on the latest main branch and encourages users to put effort into creating a minimal sample.

This is common behavior for many .NET tools (at least in my experience).

I wouldn’t say this reflects my experience, not with .NET tools nor other formatters.

The disadvantages of making this adjustment to Fantomas are - I can't think of any.

With frequent daily use, it holds little value, so I would prefer to list it when using --verbosity detailed.

For those reading this, please upvote this issue with 👍 if you would like to see the version by default. Downvote using 👎 if you would not prefer this.

@brianrourkeboll
Copy link
Member

I would prefer to list it when using --verbosity detailed.

I think this makes the most sense.

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

No branches or pull requests

3 participants