[#6326] improve(CLI): Make CLI more extendable and maintainable.

[Abyss-lord]

What changes were proposed in this pull request?

Make CLI more extendable and maintainable.
design doc: https://docs.google.com/document/d/1JU20XPHBMb-boOhdNmeZC9acyYupuj7EvQKfc1JaJBo/edit?usp=sharing

Why are the changes needed?

Fix: #6326

Does this PR introduce any user-facing change?

No

How was this patch tested?

local test + ut

# ======= METALAKE =======
❯ gcli metalake details -m demo_metalake -i --output table
# +---+---------------+-------------+
# |   |   METALAKE    |   COMMENT   |
# +---+---------------+-------------+
# | 1 | demo_metalake | new comment |
# +---+---------------+-------------+

❯ gcli metalake details -m demo_metalake -i
# demo_metalake, new comment

❯ gcli metalake list  -m demo_metalake -i --output table
# +---+-------------------+
# |   |     METALAKE      |
# +---+-------------------+
# | 1 | demo_metalake     |
# | 2 | test_cli_metalake |
# | 3 | tyy               |
# | 4 | demo3             |
# | 5 | demo_metalake2    |
# +---+-------------------+

❯ gcli metalake list  -m demo_metalake -i
# demo_metalake
# test_cli_metalake
# tyy
# demo3
# demo_metalake2

❯ gcli metalake details -m demo_metalake -i --output table --quiet
# no output

# ======= CATALOG =======
❯ gcli catalog list  -m demo_metalake -i --output table
# +---+-------------------+
# |   |     CATALOG       |
# +---+-------------------+
# | 1 | File              |
# | 2 | Hive_catalog      |
# | 3 | Iceberg_catalog   |
# | 4 | Mysql_catalog     |
# | 5 | Test_hive_catalog |
# +---+-------------------+

❯ gcli catalog list  -m demo_metalake -i
# File
# Hive_catalog
# Iceberg_catalog
# Mysql_catalog
# Test_hive_catalog

❯ gcli catalog details  -m demo_metalake --name Hive_catalog  -i --output table
# +---+--------------+------------+----------+-------------+
# |   |   CATALOG    |    TYPE    | PROVIDER |   COMMENT   |
# +---+--------------+------------+----------+-------------+
# | 1 | Hive_catalog | RELATIONAL | hive     | new comment |
# +---+--------------+------------+----------+-------------+

❯ gcli catalog details  -m demo_metalake --name Hive_catalog  -i
# Hive_catalog, RELATIONAL, hive, new comment

[Abyss-lord]

@justinmclean @tengqm , could you please review this PR when you have time? I’d really appreciate your feedback. plz review my new design

[tengqm]

I'll refrain from leaving comments here till I get a whole picture about where we are heading.

[shaofengshi]

Hi @Abyss-lord, thanks for the PR, while I feel this change is a little bit heavy, which may make the CLI code harder to maintain. Regarding the feature, would you add more information in the issue description, so that we can understand the scenario? Thank you!

[Abyss-lord]

Hi @Abyss-lord, thanks for the PR, while I feel this change is a little bit heavy, which may make the CLI code harder to maintain. Regarding the feature, would you add more information in the issue description, so that we can understand the scenario? Thank you!

@shaofengshi As the CLI continues to evolve, we face growing challenges with code maintainability. There are two main issues we need to address:

1. Parameter Management Challenge:Currently, commands require numerous individual arguments. Adding a new option requires modifications across all commands.This approach doesn't scale well as we add more functionality
2. Inconsistent Output Handling:Output methods are fragmented between System.out/err and OutputFormat#output and Lack of standardized output handling makes the interface inconsistent

To address these issues, I propose the following solutions:
For the first question, I propose grouping related options into logical parameter clusters according to action not entity. This approach will improve code organization and maintainability. The proposed structure is illustrated in the following class diagram...

When the refactoring is complete the command just needs to pass the configuration + FullName, e.g.
newDeleteTable(url, ignore, force, metalake, catalog, schema, table) -> newDeleteTable(DeleteConfig config, FullName fullname)

For the second problem, I've redesigned the OutputFormat interface to improve extensibility. I refactor the OutputFormat to increase its extensibility, but also leave room for extension, such as sorting, limit and other functions.

Now all of the CLI's information can be displayed using a single output method.

Although this is a lot of code changes, IMHO I think it will be a big benefit for future client development.

design doc: https://docs.google.com/document/d/1JU20XPHBMb-boOhdNmeZC9acyYupuj7EvQKfc1JaJBo/edit?usp=sharing