chore(.gitignore): add playground directory to ignore list

docs(README.md): update command examples to include 'translate' keyword
feat(formality.go): introduce formality settings for language translation
refactor: remove dragoman.go to refactor translation implementation

feat(improve.go): add document improvement functionality with SEO optimization

- Introduces `Improver` struct to enhance document content for engagement, clarity, and SEO.
- Implements `Improve` method to process documents in chunks for scalability.
- Utilizes parameters like formality, keywords, and language for tailored improvements.
- Supports splitting documents into manageable chunks for individual enhancement.
- Ensures structural integrity of documents by preserving formatting elements.

feat(cli.go): restructure CLI options for translate and improve commands

- Encapsulate translation-related options within a `Translate` struct and introduce a new `Improve` command with its own set of options. This change organizes the CLI options more logically, separating translation and improvement functionalities into distinct command groups for better user experience and code maintainability.
- Replace `Rules` option with `Instructions` in both `Translate` and `Improve` commands to better reflect the purpose of providing guidance to the translation or improvement process.
- Add `Formality`, `Keywords`, and `Language` options to the `Improve` command to support text improvement features, allowing users to specify the formality level, optimize for certain keywords, and set the language for the improvement process.
- Modify the `Run` function to handle the new command structure, ensuring the application correctly processes commands based on the provided arguments and executes the appropriate functionality.
- Implement `translate` and `improve` functions to encapsulate the logic for each command, improving code organization and making it easier to maintain and extend the application with new features in the future.

refactor(cli.go): restructure output file creation to use nested options
feat(cli.go): introduce `improve` function for document enhancement with OpenAI
refactor(cli.go): update `getChunks` function to accept parameters directly for improved clarity and flexibility

feat: add translation model and translator with tests

- Implement a chat-based translation model interface and a function type to facilitate easy translation model creation.
- Develop a Translator struct with methods to translate text documents, supporting chunk-based translation, preservation of specific terms, and custom translation instructions.
- Include comprehensive unit tests to validate translation functionality, including handling of source and target languages, preservation of terms, and proper prompt generation based on translation parameters.

Author: bounoable

.gitignore

@@ -1,3 +1,4 @@
+playground/**
 *.exe
 *.exe~
 *.dll

README.md

@@ -55,7 +55,7 @@ human would understand (like 'English', 'German', 'French', etc.). If not
 provided, it defaults to 'auto', meaning the language is automatically detected.
 
 ```bash
-dragoman source.json --from English
+dragoman translate source.json --from English
 ```
 
 **`-t` or `--to`**
@@ -65,7 +65,7 @@ specified in any format that a human would understand (like 'English', 'German',
 'French', etc.). If not provided, it defaults to 'English'.
 
 ```bash
-dragoman source.json --to French
+dragoman translate source.json --to French
 ```
 
 **`-o` or `--out`**
@@ -74,7 +74,7 @@ The path to the output file where the translated content will be saved. If this
 option is not provided, the translated content will be printed to stdout.
 
 ```bash
-dragoman source.json --out target.json
+dragoman translate source.json --out target.json
 ```
 
 **`--split-chunks`**
@@ -85,7 +85,7 @@ with one of the provided prefixes will create a new chunk.
 
 **Example: Split a Markdown file into chunks when encountering H2 and H3 headings:**
 ```bash
-dragoman source.json --split-chunks "## " --split-chunks "### "
+dragoman translate source.json --split-chunks "## " --split-chunks "### "
 ```
 
 **`-u` or `--update`**
@@ -95,7 +95,7 @@ are missing in the output file. This option requires the source and output files
 to be JSON!
 
 ```bash
-dragoman source.json --out target.json --update
+dragoman translate source.json --out target.json --update
 ```
 
 #### Example
@@ -125,7 +125,7 @@ option to only translate the newly added fields and merge them into the output f
 ```
 
 ```bash
-dragoman en.json --out de.json --update
+dragoman translate en.json --out de.json --update
 ```
 
 Result:
@@ -146,7 +146,7 @@ Result:
 This option allows you to specify a list of specific words or phrases, separated by commas, that you want to remain unchanged during the translation process. It's particularly useful for ensuring that certain terms, which may have significance in their original form or are used in specific contexts (like code, trademarks, or names), are not altered. These specified terms will be recognized and preserved whether they appear in isolation or as part of larger strings. This feature is especially handy for content that includes embedded terms within other elements, such as HTML tags. For instance, using --preserve ensures that a term like <span class="font-bold">Drago</span>man retains its original form post-translation. Note that the effectiveness of this feature may vary depending on the language model used, and it is optimized for use with OpenAI's GPT models.
 
 ```bash
-dragoman source.json --preserve Dragoman
+dragoman translate source.json --preserve Dragoman
 ```
 
 **`-v` or `--verbose`**
@@ -155,7 +155,7 @@ A flag that, if provided, makes the CLI provide more detailed output about the
 process and result of the translation.
 
 ```bash
-dragoman source.json --verbose
+dragoman translate source.json --verbose
 ```
 
 **`-h` or `--help`**

dragoman.go

@@ -0,0 +1,45 @@
+package dragoman
+
+const (
+	// FormalityUnspecified indicates the absence of a specified formality level in
+	// translation or language settings.
+	FormalityUnspecified Formality = ""
+
+	// FormalityFormal represents the use of formal language and address forms,
+	// applicable across all languages where such distinctions exist.
+	FormalityFormal Formality = "formal"
+
+	// FormalityInformal specifies the use of informal language and address forms,
+	// applicable across various languages where distinctions between formality
+	// levels exist.
+	FormalityInformal Formality = "informal"
+)
+
+// Formality represents the level of formality in language, ranging from formal
+// to informal, providing contextual cues for language translation or usage. It
+// supports checking if a specific formality has been set and converts to its
+// string representation. Formality also guides language adjustments based on
+// the desired tone and social context.
+type Formality string
+
+// IsSpecified reports whether a [Formality] instance has a specified value
+// other than the default unspecified state.
+func (f Formality) IsSpecified() bool {
+	return f != FormalityUnspecified
+}
+
+// String returns the string representation of the formal language setting
+// encapsulated by the [Formality] type.
+func (f Formality) String() string {
+	return string(f)
+}
+
+func (f Formality) instruction() string {
+	if f == FormalityInformal {
+		return "Use informal language and address forms, applicable across all languages where such distinctions exist."
+	}
+	if f == FormalityFormal {
+		return "Use formal language and address forms, applicable across all languages where such distinctions exist."
+	}
+	return ""
+}