Docs [Golang] [Package]

bannercli/banner.go

@@ -1,12 +1,21 @@
+// Copyright (c) 2023 H0llyW00dzZ
+//
 // Package bannercli provides functionality to print different styles of banners
 // to the terminal. These styles include binary representation and simple
 // animation effects to enhance the visual presentation of CLI applications.
-// # bannercli/banner.go
-// Example usage:
 //
-// bannercli.PrintTypingBanner("ChatGPT Session Exporter", 100*time.Millisecond)
+// # Example Usage
 //
-// Copyright (c) 2023 H0llyW00dzZ
+//	func main() {
+//		// ... existing code ...
+//
+//		// Display a binary banner
+//		banner.PrintTypingBanner("ChatGPT Session Exporter", 100*time.Millisecond)
+//		// Optionally, display an typing animated banner
+//		banner.PrintAnimatedBanner("ChatGPT Session Exporter", 3, 200*time.Millisecond)
+//
+//		// ... rest of your main function ...
+//	}
 package bannercli
 
 import (
@@ -18,8 +27,6 @@ import (
 // PrintBinaryBanner prints a binary representation of a banner.
 // Each character of the message is converted into its binary form.
 // Spaces between words are widened to enhance readability.
-//
-// Copyright (c) 2023 H0llyW00dzZ
 func PrintBinaryBanner(message string) {
 	banner := strings.ReplaceAll(message, " ", "   ")
 	for _, char := range banner {
@@ -32,8 +39,6 @@ func PrintBinaryBanner(message string) {
 // horizontally across the terminal. The animation repeats the number of times
 // specified by the `repeat` parameter with a delay between each frame as
 // specified by the `delay` parameter.
-//
-// Copyright (c) 2023 H0llyW00dzZ
 func PrintAnimatedBanner(message string, repeat int, delay time.Duration) {
 	for r := 0; r < repeat; r++ {
 		for i := 0; i < len(message); i++ {
@@ -48,7 +53,7 @@ func PrintAnimatedBanner(message string, repeat int, delay time.Duration) {
 //
 // Each character appears sequentially with a delay, simulating a typing effect.
 //
-// Copyright (c) 2023 H0llyW00dzZ
+// Note: This simulation typing just like a human would type.
 func PrintTypingBanner(message string, delay time.Duration) {
 	for _, char := range message {
 		fmt.Printf("%c", char)

exporter/session.go

@@ -1,3 +1,5 @@
+// Copyright (c) 2023 H0llyW00dzZ
+//
 // Package exporter provides tools for extracting and converting chat session data
 // from JSON files into various formats, such as CSV and JSON datasets.
 //

filesystem/file_system.go

@@ -1,3 +1,5 @@
+// Copyright (c) 2023 H0llyW00dzZ
+//
 // Package filesystem provides an abstraction over the native file system operations.
 //
 // This allows for easy testing and mocking of file system interactions.

filesystem/file_system_mock.go

@@ -1,3 +1,5 @@
+// Copyright (c) 2023 H0llyW00dzZ
+//
 // Below, the package filesystem (@file_system_mock.go) furnishes a mock implementation of the FileSystem
 // interface intended for testing. It enables the monitoring of file operations and
 // the emulation of file system interactions without real disk I/O, showcasing the

interactivity/interactivity.go

@@ -1,3 +1,5 @@
+// Copyright (c) 2023 H0llyW00dzZ
+//
 // Package interactivity provides functions to handle interactive command-line interfaces.
 //
 // It includes utilities for prompting users for confirmation and reading their input in a context-aware manner, which allows for graceful

repairdata/repairdata.go

@@ -1,3 +1,5 @@
+// Copyright (c) 2023 H0llyW00dzZ
+//
 // Package repairdata provides utilities for transforming JSON data from an old format to a new format.
 //
 // It specifically ensures that each session's modelConfig contains a 'systemprompt' field.