Closed antalszava closed 4 years ago
Merging #312 into demo will not change coverage by
%
. The diff coverage isn/a
.
@@ Coverage Diff @@
## demo #312 +/- ##
=======================================
Coverage 97.66% 97.66%
=======================================
Files 50 50
Lines 6245 6245
=======================================
Hits 6099 6099
Misses 146 146
Continue to review full report at Codecov.
Legend - Click here to learn more
Δ = absolute <relative> (impact)
,ø = not affected
,? = missing data
Powered by Codecov. Last update b7a74bd...b7a74bd. Read the comment docs.
Context: The command line interface (CLI),
starship
has a few options which can be used. However, its functionality can be extended and tests need to be included such that most caveats for bugs are covered.In terms of portability, the idea is to keep the command line interface platform independent.
Description of the Change: Created a fixed CLI structure where there are two main types of options:
--
prefix, e.g.--ping
run
In more details this looks as follows: There are two general options:
--help
and--ping
, in more details:There are two commands:
configure
andrun
, in more details:Configure
Run
In terms of code structure, the ability to create unit tests was regarded (as an example, suggestions on how to write tests for the
argparse
method were followed).Benefits:
The idea behind separating the previously mentioned two groups:
starship configure --local
where--local
is an optional argument)In terms of functionality, users can:
Possible Drawbacks: To have
General options
appear when the help menu is queried, the protected member_optionals
of theArgumentParser
class was set. This was the best solution to be found for this task; caution must be taken in case the implementation of theArgumentParser
class changes.Related GitHub Issues: N/A