BirjuVachhani commented 2 years ago

Summary

This is an attempt to rewrite the whole cli app to have better structure and scalability. Current structure is very old and somewhat rigid. This rewrite is expected to help with ease of feature implementation and maintainability.

Tasks

Core Tasks

[x] Basic Structure using CommandRunner, Command from args package.
[x] Rename info command to about.
[x] Migrate non-core commands like version, info, check-updates.
[x] Refactor check-updates flag to check-for-updates.
[x] Implement --license flag command.
[x] Implement --docs command.
[x] Make both old and new executables available until merge.
[x] Setup Logging.
[x] Migrate create command.
[x] Migrate build command.
[x] Fix tests.
[x] Consolidate all the strings used (optional).
[x] Restructure logging/output to utilize ansi color pens.
[x] Hook-up checking for new version whenever a command/flag-command is executed.

Documentation

[x] Code docs for base structure.
[x] Code docs for utilities.
[x] Code docs for non-core commands.
[x] Code docs for core commands.
[x] Update docs site.

What to expect

Core public APIs like create and build commands won't change.
Some non-core apis will change in terms of usage.
No timeline has been yet figured out to complete this and release. This is very experimental right now and might stay that way for unknown amount of time.
New features are expected to be built upon this if this is finished early, else, a migration would be performed.

codecov-commenter commented 2 years ago

Codecov Report

Merging #52 (f1b5111) into main (05e4902) will decrease coverage by 12.34%. The diff coverage is 41.84%.

@@             Coverage Diff             @@
##             main      #52       +/-   ##
===========================================
- Coverage   70.75%   58.40%   -12.35%     
===========================================
  Files          15       31       +16     
  Lines         571      714      +143     
===========================================
+ Hits          404      417       +13     
- Misses        167      297      +130

Impacted Files	Coverage Δ
lib/src/cli/commands/base_command.dart	`0.00% <0.00%> (ø)`
lib/src/cli/commands/build_command.dart	`0.00% <0.00%> (ø)`
lib/src/cli/commands/create_command.dart	`0.00% <0.00%> (ø)`
lib/src/cli/flag_commands/about_flag_command.dart	`0.00% <0.00%> (ø)`
lib/src/cli/flag_commands/base_flag_command.dart	`0.00% <0.00%> (ø)`
.../cli/flag_commands/check_updates_flag_command.dart	`0.00% <0.00%> (ø)`
lib/src/cli/flag_commands/docs_flag_command.dart	`0.00% <0.00%> (ø)`
...ib/src/cli/flag_commands/license_flag_command.dart	`0.00% <0.00%> (ø)`
...ib/src/cli/flag_commands/version_flag_command.dart	`0.00% <0.00%> (ø)`
lib/src/cli/models/asset_group.dart	`83.87% <ø> (ø)`
... and 23 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.