Split debug options

[xsebek]

• replace _uiCheatMode :: Bool with _uiDebugOptions :: (Set DebugOption)
  • replace uiHideGoals with uiIsAutoPlay and debug option ShowGoalDialogsInAutoPlay
• add command line flag --debug and make --cheat an alias for --debug=creative only

  -x,--cheat               Enable cheat mode. This is an alias for --debug=creative
  -d,--debug OPTS          Use 'all' or a comma separated list of options:
                             * creative           allow toggling creative mode on/off
                             * editor             allow toggling the world editor mode on/off
                             * cesk               allow toggling the CESK debug view on/off
                             * all_robots         list all robots (including system robots) in the robot panel
                             * robot_id           list robot IDs in the robot panel
                             * hidden_goals       show hidden objectives in the goal dialog
                             * autoplay_goals     show goal dialogs when running in autoplay
                             * testing            show Testing folder in scenarios menu

It even has shell completions:

swarm --zsh-completion-script `which swarm` > ~/.oh-my-zsh/completions/_swarm
swarm --debug  # press Tab
# all  all_robots  autoplay_goals  cesk  creative  editor  hidden_goals  robot_id  testing

• closes better name for --cheat CLI option #1324

[byorgey]

Looks great! Definitely a big improvement over the status quo.

[byorgey]

I suggest something like this:

Suggested change

	debugOptions <- debug
	initialDebugOptions <- debug
	let debugOptions = Set.union cheatMode initialDebugOptions

Then we can get rid of the lambda + record update in the final return.

[xsebek]

I might have underestimated the powers of ApplicativeDo after last issues. I will try this. 👍

[xsebek]

Nope, this is not accepted by ApplicativeDo.

app/game/Main.hs:62:13: error:
    • No instance for (Monad Parser) arising from a use of ‘return’

[byorgey]

@xsebek what about

debugOptions <- Set.union cheatMode <$> debug

?

[xsebek]

Nope, that also needs a monad. I suppose it makes sense, how else would you write it in a a <$> ... <*> ... style?

I added a comment and made the return a bit nicer.

[byorgey]

Oh, right, because it's referring to cheatMode which is the result of a previous action. Actually, I now understand why let debug = Set.union cheatMode ... is not accepted either---for the same reason.

[byorgey]

Now I don't even understand why the existing code works.

[xsebek]

@byorgey I imagine GHC constucts a suitable a that puts everything in the right place:

(\c d o -> A (c + d) o) <$> cheat <*> debug <*> others