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

No sensible difference between commands doctor, about, and version #1665

Closed
julienrf opened this issue Dec 8, 2022 · 4 comments · Fixed by #1744
Closed

No sensible difference between commands doctor, about, and version #1665

julienrf opened this issue Dec 8, 2022 · 4 comments · Fixed by #1744
Assignees
Labels
enhancement New feature or request SIP-46 All the issues related to SIP-46 to turn Scala CLI into the official scala runner command.

Comments

@julienrf
Copy link
Contributor

julienrf commented Dec 8, 2022

Is your feature request related to a problem? Please describe.

Currently (scala 0.1.18 installed via cs install scala-experimental), the documentation says the following:

Doctor commands:
  doctor  Print details about this application

Miscellaneous commands:
  about    Print details about this application
  version  Print version

It is not clear what are the differences between doctor, about, and version.

I tried all of them and I got the following output:

$ scala doctor
Your scala version (0.1.18) is current.
scala can be updated by your package manager since it is correctly installed in only one location: .
Your scala is a native application.

$ scala about
Scala code runner version: 0.1.18
Scala version (default): 3.2.1
$ scala version
Scala code runner version: 0.1.18
Scala version (default): 3.2.1

Describe the solution you'd like

I suggest keeping the behavior of version as it is, but improving its documentation to the following:

Print the version of the scala runner and the default Scala version (unless specified in the project).

I suggest removing the about command, or renaming doctor into about (so, removing doctor) because “about” is more self-explanatory or intuitive to me (but that might be purely subjective).

@julienrf julienrf added the enhancement New feature or request label Dec 8, 2022
@prolativ
Copy link

prolativ commented Dec 8, 2022

Was doctor command inspired by metals doctor? This thought made me realize that it would make sense to have a command not only to give a user some information about the scala runner itself, but also about the current configuration of a given project. But I would probably call it something like project or project-info instead of doctor.
Then running scala project . would read the using directives from all the sources and then print out the scala version, declared dependencies, compiler options etc., taking into account possible differences between configurations for different target platforms

@tgodzik
Copy link
Member

tgodzik commented Dec 20, 2022

I suggest removing the about command, or renaming doctor into about (so, removing doctor) because “about” is more self-explanatory or intuitive to me (but that might be purely subjective).

Makes sense from my side. And we should probably also include something like @prolativ suggested, but that should be a separate feature request.

@Gedochao
Copy link
Contributor

@prolativ I extracted the project sub-command feature into a separate issue: #1722

@julienrf after some offline discussion, it seems we'll proceed with this ticket as follows:

  • the about sub-command will be merged back to the version sub-command and removed
  • the doctor sub-command will be removed, while its current features will be delivered through other means at a later date (possibly expanding the existing actionable diagnostics)
    • this is based on the current approach of making Scala CLI interactive, rather than something you should run the doctor sub-command with to see what's wrong
  • this way, we'll go down to just having the version sub-command

@Gedochao Gedochao added the SIP-46 All the issues related to SIP-46 to turn Scala CLI into the official scala runner command. label Dec 22, 2022
@Gedochao Gedochao self-assigned this Dec 23, 2022
@julienrf
Copy link
Contributor Author

julienrf commented Jan 4, 2023

Thank you for addressing this issue promptly!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request SIP-46 All the issues related to SIP-46 to turn Scala CLI into the official scala runner command.
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants