Improve implementation for JSON and raw options

[ghost]

Purpose

Continue the work to align the Zonemaster-CLI implementation with its own documentation.

Context

Follow-up on #308
#247 (comment)

Changes

• Make --json-stream entail --json
• Deprecate --[no-]json-translate, use --[no-]raw instead
• Refactor CLI.pm

How to test this PR

Test several configurations mixing --json, --raw, --json-stream.

zonemaster-cli --json-stream --raw zonemaster.net
zonemaster-cli --json-stream zonemaster.net
zonemaster-cli --json zonemaster.net
zonemaster-cli --json --raw zonemaster.net
zonemaster-cli --json --json-stream --raw zonemaster.net

[marc-vanderwal]

A big improvement, definitely, which reduces the combinations of command-line options that do nothing (e.g. --no-json-translate without having given either --json or --json-stream).

With this design, all combinations make sense, except for one: --json-stream --no-json. Currently, it does the same thing as either --json-stream alone or --json-stream --json. I think zonemaster-cli should error out instead.

Because --[no-]json-translate is going to be deprecated, it may be a good thing to warn the user, and tell them the new set of options to use. For example:

• if --no-json-translate is given, tell them they should pass --raw instead;
• if --json-translate is given, tell them they should pass --no-raw instead;
• additionally, if --no-json-translate or --json-translate is given without either --json or --json-stream, tell the user that the option has no effect without either of those two.

[ghost]

Thanks for the review and comments. I've updated the PR to display error and/or warning messages to the user.

[ghost]

Rebased to fix conflicts and incorporate latest release changes. Please re-review.

[marc-vanderwal]

Looks good to me.

[tgreenx]

v2023.1 Release testing

Basic testing:

• Make --json-stream entail --json. --> OK
• Deprecate --[no-]json-translate, use --[no-]raw instead. --> OK

Bugs:

• --json-translate shows the deprecation warning message, but --json_translate does not. --> Fix option --[no-]json-translate #337

Observations:

• --json --no-raw (or just --json) includes the content of --raw (message tag and args). --> Acceptable but undocumented behavior.