Review CLI arguments

[rimutaka]

The app is using a garden variety of the argument parser that need to be upgraded to a more robust routine.

1. Review and rename the arguments to make them more self-explanatory
2. Switch to using a more robust parser:
   • https://github.com/blyxxyz/lexopt / https://www.reddit.com/r/rust/comments/oley2c/lexopt_a_minimalist_pedantic_argument_parser/
   • https://github.com/RazrFalcon/pico-args

[rimutaka]

App defaults

Running the app for the first time

• print a welcome message

Running the app with no params

• git user.email -> contributor email, primary email or use cached emails and primary_email values
• anonymous profile with no name (blank public_name and public_contact)
• process the current folder and submit a report

Default modifiers

• --emails -> list of contributor emails to include in the report, overrides git config
• --primary_email -> the preferred contact email, never made public
• --public_name -> the name to put in the public profile or blank to go private, the last used value persists in STM DB
• --public_contact -> email, twitter, github or any other type of contact, the last used value persists in STM DB
• --no_update -> generate reports, do not submit to STM
• --project -> path_to_project_to_be_analyzed, defaults to the current directory
• --report -> path_to_reports_folder, defaults to a platform specific location
• --rules -> path_to_folder_with_alternative_code_rules
• --log -> error|warn|info|debug|trace, defaults to error

Commands

• delete_profile -> deletes the profile from STM DB, can be restored by resubmitting the data
• make_private / make_anon -> resets public_name and public_contact to make the profile anonymous
• help -> prints welcome msg
• view / view_reports -> print the full path of the reports folder
• automate / auto -> add git-commit hook

git config user.email

• personal email
• work email, not for STM comms
• no-reply email
• unreachable ubuntu@aws-ec2-bla-bla.com

Use cases:

• process my project and submit the report
• process my project, do not submit anything
• just curious how it works
• process someone's else project -> project report only, nosub
• process someone's else project -> contributor report, nosub
• process someone's else project, submit reports

[rimutaka]

Need to document everything in README, but it may be a wasted effort right now. I'd better make a handler for Inbox messages and profile generation.

[rimutaka]

config and --config are similar-sounding, but have different purpose while help and --help are the same.

On the other hand --report and --config are consistent. --config_folder is a bit too long.

I'll close it for now. Low priority.