Skip to content

Fix #4005 command-line options help is incomplete #4018

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Feb 26, 2018
Merged

Fix #4005 command-line options help is incomplete #4018

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7578c37
Fix #4005 command-line options help is incomplete
Feb 20, 2018
f169cbd
Erase the string builder and use the 's' string formatter for all add…
Feb 22, 2018
a2a0a0d
Move defaultValue and formatSetting helpers under the helpStr. Refact…
Feb 22, 2018
fab4c4f
Remove unused param from defaultValue call. Remove extra spaces from …
Feb 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion compiler/src/dotty/tools/dotc/config/CompilerCommand.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,14 @@ object CompilerCommand extends DotClass {
val ss = (ctx.settings.allSettings filter cond).toList sortBy (_.name)
val width = (ss map (_.name.length)).max
def format(s: String) = ("%-" + width + "s") format s
def helpStr(s: Setting[_]) = s"${format(s.name)} ${s.description}"
def formatSettings(name: String, value: String) = if (value.nonEmpty) format("\n") ++ s" $name: $value." else ""
Copy link
Contributor

Choose a reason for hiding this comment

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

Hm, why do we need to use format on \n? I'm probably being slow (or rushed)...
And expressions can go inside the s formatter...
Any chance we can use s"\n${format(name)} ${format(value)}"? That's closer to what we do in helpStr, and hopefully clearer.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I use format("\n") as a hack to start the second line with an empty first column for Default or Choices
screen shot 2018-02-20 at 16 12 08

def helpStr(s: Setting[_]) = {
val help = StringBuilder.newBuilder
help.append(s"${format(s.name)} ${s.description}")
help.append(formatSettings("Default", s.defaultValue))
help.append(formatSettings("Choices", s.legalChoices))
help.toString
Copy link
Contributor

Choose a reason for hiding this comment

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

Since this code already using the s formatter, what about just one expression?
s"${format(s.name)} ${s.description}${formatSettings("Default", s.defaultValue)}${formatSettings("Choices", s.legalChoices)}"? You can put arbitrary expressions inside ${} 🙂

}
ss map helpStr mkString "\n"
}

Expand Down
8 changes: 7 additions & 1 deletion compiler/src/dotty/tools/dotc/config/Settings.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,13 @@ object Settings {
state.update(idx, x.asInstanceOf[T])
}

def isDefaultIn(state: SettingsState) = valueIn(state) == default
def isDefaultIn(state: SettingsState): Boolean = valueIn(state) == default

Copy link
Contributor

Choose a reason for hiding this comment

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

I guess we don’t need to add this type annotation, no? Otherwise, LGTM.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I followed the Boy Scout Rule and added this small thing :) Is it true that the public methods have to have the return type annotation? Please correct me if I am not right.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh I see! Fine with me.

def defaultValue: String = implicitly[ClassTag[T]] match {
Copy link
Contributor

Choose a reason for hiding this comment

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

I would make it an inner method of def helpStr. Also you don't need a cast here:

def defaultValue(setting: Setting[_]): String = setting.default match {
  case _: Int | _: String => setting.default.toString
  case _ => ""
}

case StringTag => default.asInstanceOf[String]
case IntTag => default.asInstanceOf[Int].toString
case _ => ""
Copy link
Contributor

Choose a reason for hiding this comment

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

Both branches could be default.toString, but it seems you want to exclude defaults that aren't String and Int? Could you explain why?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I found that only for these tag classes there are meaningful default values. For example for the -version there is default: Boolean == false, what does not make sense.

}

def legalChoices: String =
if (choices.isEmpty) ""
Expand Down