[go_router] New feature improve debug full path

[hashirshoaeb]

This PR fixes flutter/flutter#148121

• Replaced => with | , ├─ and └─ to improve readability
• It prints the Widget name for easy referencing
• Shell routes does not have their own paths for it is presented as (Shell route) in the tree
• Prints the widget name of the routes it is building.

Pre-launch Checklist

• I read the Contributor Guide and followed the process outlined there for submitting PRs.
• I read the Tree Hygiene wiki page, which explains my responsibilities.
• I read and followed the relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
• I signed the CLA.
• The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
• I linked to at least one issue that this PR fixes in the description above.
• I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.
• I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
• I updated/added relevant documentation (doc comments with ///).
• I added new tests to check the change I am making, or this PR is test-exempt.
• All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

[google-cla]

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

[chunhtai]

This is so so much better than the previous, Thanks a lot!!

[chunhtai]

Wouldn't this always be Widget?

maybe just use GoRoute and GoRoute(redirectOnly)

[hashirshoaeb]

screenName is the name of the widget. it will not always print Widget. Otherwise it was for no use.
Just like in the logging_test.dart test it logs / (Text)

Example from my app:

[GoRouter] Full paths for routes:
           ├─/ (SplashScreen)
           ├─/intro (IntroScreen)
           ├─ (ShellRoute)
           │ ├─/main/year ()
           │ │ └─/main/year/month (HomeScreen)
           │ └─/main/profile (ProfileScreen)
           │   ├─/main/profile/analytics (AnalyticsScreen)
           │   └─/main/profile/settings (SettingsScreen)
           │     └─/main/profile/settings/license (LicenseAgreementScreen)
           └─/journal (JournalsListScreen)
             ├─/journal/new (JournalCreateScreen)
             └─/journal/:id (JournalDetailScreen)
               └─/journal/:id/edit (JournalEditScreen)

There are edge cases:

• screenName is only get printed, when user uses GoRouter.builder
• It does not print for GoRouter.pageBuilder
• It prints (Never) when GoRouter.builder throws Unimplemented Error

[hashirshoaeb]

instead of using magic strings

    final String newDecoration =
        parentDecoration.replaceAll('├─', '│ ').replaceAll('└─', '  ');

we can treat String as list of enum

    final newDecoration = parentDecoration.map((e) {
      switch (e) {
        case DecorType.branch:
          return DecorType.parentBranch;
        case DecorType.leaf:
          return DecorType.none;
        default:
          return e;
      }
    });

where DecorType is

enum DecorType {
  parentBranch('| '),
  branch('├─'),
  leaf('└─'),
  none('  '),
  ;

  final String value;
  const DecorType(this.value);

  @override
  String toString() => value;
}

@chunhtai What are your thoughts, is it worth changing?

[chunhtai]

yup that sounds better

[chunhtai]

LGTM

[hashirshoaeb]

Just checking. If anything is pending on my side, just let me know. @chunhtai @Hangyujin. Looking forward to the merge. 🙈

[hannah-hyj]

LGTM, this looks very helpful!

[hannah-hyj]

LGTM