License and license related flags #1

Merged
cafkafk merged 13 commits from dev into main 2023-06-09 18:36:30 +02:00

13 commits

Author SHA1 Message Date
Christina Sørensen
696eacf8d7
bump to V0.0.2: license to license
Added licenses to files in src.

Implemented flags:
- warranty
- license

Added license notice to help.

Refactored parts of the code.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
2023-06-09 18:31:22 +02:00
Christina Sørensen
0f7b525a55
Made -h, --help show license notice
Moved the help template into its own const, and concatenated it with the
interactive notice to append it to the help output.

Also, adjusted the license, warranty, and notice strings for increased
readability.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
2023-06-09 18:28:19 +02:00
Christina Sørensen
c38b524e09
Finalized license, warranty flags
Made the clap Parser able to be run without a subcommand, by wrapping
the subcommand field of the Parser struct in an Option<Command>.

Further destructured the subcommand arms fields in main with Some(),
and made the default case None just return ().

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
2023-06-09 18:16:28 +02:00
Christina Sørensen
c8ea855451
Implemented the flag arms for license, warranty
Implemented the flag arms for license, warranty in main,
but this will not work before we make the clap Parser able
to be run without a subcommand, by wrapping the subcommand
field of the Parser struct in an Option<Command>.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
2023-06-09 18:14:06 +02:00
Christina Sørensen
3e3566ea3c
Made utils/strings consts public
Made the following utils/strings consts public
- INTERACTIVE_NOTICE
- INTERACTIVE_LICENSE
- INTERACTIVE_WARRANTY

This is to allow their use in the flags match in main.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
2023-06-09 17:30:42 +02:00
Christina Sørensen
db6e905cbc
Added arm to match statement for waranty in main
Added an arm to the match statement for parsing flags in main.

Using the pattern and hopefully ongoing convention of making
unimplemented arms indicated by using the unimplemented!() macro.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
2023-06-09 17:25:15 +02:00
Christina Sørensen
65190b8752
Decided to go for a glass of water
My room temperature is approaching that of my processor.

Hydrating is very important, in order to keep myself in peak shape for
coding, I took a tactical water break.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
2023-06-09 16:26:58 +02:00
Christina Sørensen
9bbabb9367
Added --warranty flag, typos
Added the --warranty flag.

Removed part of docstring that said the --license would give full-text.
This is wrong, as will be implementing the shorter notice.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
2023-06-09 16:25:25 +02:00
Christina Sørensen
661b730c44
Added licensing string constants to utils/strings
Added these three constants to utils/strings:
- INTERACTIVE_NOTICE
- INTERACTIVE_LICENSE
- INTERACTIVE_WARRANTY

These were based of the license text's notices for interactive programs,
found in the "How to Apply These Terms to Your New Programs" section.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
2023-06-09 16:22:04 +02:00
Christina Sørensen
7c7d9f6129
Added GPLv3 header to files in src/
This is what the GPLv3 recommends, as can be referred in the LICENSE
file.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
2023-06-09 16:09:32 +02:00
Christina Sørensen
e8dd2b177c
Init utils/strings module
For keeping longer text output helpers, such as e.g. license text and
CoC.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
2023-06-09 16:01:26 +02:00
Christina Sørensen
7217c1cbfa
Removed commented out code in main.rs
For some reason, the match arm for --quick had only been commented out.
Now it's removed.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
2023-06-09 15:57:34 +02:00
Christina Sørensen
eb92038fbf
Refactored GitRepo associated functions
Strings representing where to run commands where one of:

.current_dir(&(self.path.to_owned() + &self.name))
.current_dir(format!("{}{}", &self.path, &self.name))

Decided to change all instances to the latter, as asking people seemed
to prefer it for readability.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
2023-06-09 14:51:24 +02:00