Skip to content

Latest commit

 

History

History
209 lines (139 loc) · 10.1 KB

CHANGELOG.md

File metadata and controls

209 lines (139 loc) · 10.1 KB

goodnight.py Changelog

[UNRELEASED]

REL 2.0.0 - ??? ?? 20?? [#x]

???

REL 1.0.0 - ??? ?? 2024 [#x]

First release Announcing the release on Reddit & Discord

DEV 0.3.4 - Mar ?? 2024 [#x]

Adding and implementing --version aka -v: print the program's version.
Redacting and making unit tests.
Announcing the release date of the first release on Reddit & Discord.

DEV 0.3.3 - Mar ?? 2024 [#x]

Adjusting the Makefile error prints, improving the install target.
Refining type handling and redefining class types with new extensions.
Making --ignore not ignore other parameters.
Redacting a demonstration script and a demonstration source file.
Updating the README demonstration gif.


[RELEASED]

DEV 0.3.2 - Feb 06 2024 [#101]

Added a Ctrl+D handler, exiting the program gracefully with a context message.
Fixed the long overdue bug of FILE_AV suppressing the CLI asking for parameters.
Added True/False logic to boolean program parameters this allows --no-copy=False, to counter the preferences file's values if needed.
Added default.log, a tutorial source file.
Fixed inability to use default values in some CLI prompts, shebangs oddity.
Added more issue templates to the repository.
Reached the 100 commits milestone. (YOOHOO! 🎉)

DEV 0.3.1 - Jan 21 2024 [#90]

Enhanced the Makefile and its prints.
Changed the Parameters class' constructor to taking a dictionary argument, to avoid having 20 arguments.
Added and implemented --nick-nth: forcing the nickname to be after the nth phrase.
Added and implemented --pref-file aka -p: punctually, using a specifice file as set preferences file.
Added default.sav, a tutorial preferences file.
Updated the README's general information to reflect changes.

DEV 0.3.0 - Jan 06 2024 [#79]

Created a Makefile and executable file at the root of the repository, for clarity.
Added confirmation prompt if the delay is set to a high value (> 10000) through CLI.
Implemented the possibility to set the delay to p: press Enter to proceed after each interation.
Implemented --XXX=x parameter syntax.
Implemented duplicate parameter error handling.
Enhanced verbosity presence and context messages.


DEV 0.2.9 - Jan 04 2024 [#73]

Added and implemented --times: compute and print x goodnights.
Added and implemented --delay: add a delay between each goodnight iteration (in milliseconds).
Created this file (hello), CODE OF CONDUCT and CONTRIBUTING.

DEV 0.2.8 - Dec 31 2023 [#64]

Implemented --alternate aka -a: make the program alternate between commas/emoji and "and"s.
Added and implemented --infinite aka -i: make the program infinitely generate goodnights.
-i is therefore not an alias of --ignore any more.
Created Goodnight class holding the result text and a boolean for --other-step's steps.

DEV 0.2.7 - Dec 13 2023 [#60]

Added and implemented --no-copy, disabling clipboard copy.
Added --alternate.
Deprecated and removed --isave; as --save can be combined with --default.

DEV 0.2.6 - Nov 26 2023 [#56]

Added and implemented --save aka -S: save runtime preferences to file.
Improved largely the code efficiency and its structure, for maintainability.
Implemented regex handles for arguments interpretation, for clarity.
Added types on handled exceptions.
Added LICENSE file and issue templates.

DEV 0.2.5 - Nov 13 2023 [#46]

Added and implemented --other-step aka -o: make the program use the even-numbered phrase gaps as "and"s instead of commas.
Updated usage/help function to reflect additions.
Set 999 as maximum value for -n and -b upper bound.
Added confirmation prompt if -n or -b is set to a high value (> 6) through CLI.


DEV 0.2.4 - Nov 09 2023 [#44]

Added documentation: commenting code, source.log and boosting the README.
Fixed default parameter skip for -n and -b.

DEV 0.2.3 - Nov 08 2023 [#42]

Improved coding style (ty SonarLint).
Adjusted README badges.

DEV 0.2.2 - Nov 06 2023 [#39]

Implemented the possibility to have several PHRASES (and others) in a source file.
Added warning prompt if it is the case, asking if the user wants to continue.

DEV 0.2.1 - Nov 06 2023 [#38]

Added nicer transition "and" between phrases instead of commas.
Adjusted the presentation gif.

DEV 0.2.0 - Nov 06 2023 [#37]

Implemented phrase picking.
Added -r as an alias of --allow-repetition.
Added a presentation gif to the README.


DEV 0.1.6 - Nov 05 2023 [#34]

Fixed usedEmoji malfunction (picked emoji not removed from list).
Removed apparent double quotes around every element (e.g. "phrase" instead of phrase).

DEV 0.1.5 - Nov 05 2023 [#33]

Fixed multioptional parameters oddity: disallowing long parameters and their aliases.
Removed CLI asking for parameters that are already set by the preferences file.

DEV 0.1.4 - Nov 05 2023 [#31]

Implemented emoji picking.
Improved context verbosity and prints quality on --verbose.
Fixed missing file extraction case on --allow-repetition.

DEV 0.1.3 - Nov 05 2023 [#29]

Added and implemented --allow-repetition:.
. . allow the same phrase to be picked several times if all other phrases have been picked Implemented nickname picking.
Created a Contents class that holds the source file's contents, for clarity.
Fixed some -n and -b oddities.

DEV 0.1.2 - Nov 04 2023 [#28]

Added and implemented --default: using default values for all parameters.
Added warning if a high upper bound / value is set for -b/-n.
Fixed CLI oddities: unhandled parameter exceptions.
Added links on README badges.

DEV 0.1.1 - Nov 03 2023 [#23]

Added and implemented --isave: ignore preferences, save CLI answers as preferences.
Added possibility to set a random range as a value nbPhrases (picks a random number between the two bounds)

DEV 0.1.0 - Nov 02 2023 [#21]

Added weighting feature to source extractor (Contents class).
Renamed --debug to --verbose.
Major README overhaul.


DEV 0.0.5 - Nov 01 2023 [#19]

Added and implemented --debug: a mode that prints the program's steps.
Added nicknames to source extractor.
Deprecated and removed -D.
Created Types file with type aliases for clarity.

DEV 0.0.4 - Nov 01 2023 [#11]

Completed implementation of -s (source file selection).
Added a sources extractor (phrases, emoji).
Added multioptional parameters handling for boolean parameters (e.g. -eD).

DEV 0.0.3 - Nov 01 2023 [#8]

Added -s (implementation in progress).
Added preferences.sav file: save to it with -D, ignore its contents with -i/--ignore.
Added a Ctrl+C handler, exiting the program gracefully with a context message.

DEV 0.0.2 - Oct 31 2023 [#6]

Added parameter handling under forms -X and --XXX.
Completed setup for Exit and Help.

DEV 0.0.1 - Oct 30 2023 [#4]

Added Parameters class to handle and hold program parameters.
Added and implemented -n (number of phrases to draw), -e (toggle emoji mode), -w (for whom).
Added first elementary components.

DEV 0.0.0 - Oct 30 2023 [#1]

Project creation.


Back to top