Support for XML/HTML tags on the API calls and a myriad of other things

[GwynethLlewelyn]

First of all, thank you so much for your code! It was really an inspiration for me.

As mentioned before, I've been playing around with many of the features of the DeepL API, starting with your code for inspiration — mostly because you already have a CLI framework in place!

Essentially, I needed access to the extra features that the DeepL API allows — more specifically, support for XML and HTML tags (which DeepL recognises as such, and is careful in translating only the text between the tags). This required a profound rewrite of the core of your code — which focused only on text translation — while still making it more-or-the-less compatible at the upper levels.

But this is by no means a "complete rewrite" of the code. For instance, I believe that it would be better to stick to a pure JSON implementation, both for the API requests and the replies; right now, the requests are still made as they originally were made in your code.

Your concept of saving some of the settings is an excellent idea! But it becomes harder — and requires a lot of code duplication — to support more settings. At some point, I sort of gave up maintaining it in sync with the extra settings; instead, most of the information in the settings subtly migrated to the context and to the "client" type (the client for the API calls, that is), except for the DeepL API key, which comes from the environment variables. There is a reason for that: I was checking on the CLI code, and they are currently beta-testing version 3 — which includes better support for saving the settings automatically! Currently, such support exists via cli-altsrc, but it requires quite a lot of code duplication. So, I'm sort of preparing myself for the upcoming changes, and possibly, in the future, I'll take a look at how it is implemented and see if it's straightforward.

Also, I'm very lazy in writing testing code 😞 I did update your existing testing code for the changes in function names and/or signatures, so that you can still run the tests; however, the additional code I've added does not have any testing — sorry about that!

Anyway, I hope you find at least some of it useful!

Summary by CodeRabbit

• New Features
  • Introduced autocomplete functionality for Bash, PowerShell, and Zsh to enhance command-line usability.
  • Added support for new GitHub Actions and Go tools in CI/CD workflows.
  • Expanded .gitignore to exclude more files, improving developer workflow.
  • Enhanced DeepL translation tool with new CLI options and improved version information handling.
  • Introduced whimsical test data stories for more engaging testing scenarios.
• Documentation
  • Added a .editorconfig file to ensure consistent coding styles.
  • Updated copyright year in the LICENSE file.
  • Improved installation and usage instructions, including advanced commands and shell autocompletion scripts.
• Chores
  • Configured Renovate for automated dependency updates.
• Bug Fixes
  • Refined error messages and logic in test functions for clarity and reliability.

[GwynethLlewelyn]

@coderabbitai review

[coderabbitai]

Actionable comments posted: 2

[GwynethLlewelyn]

@Omochice it was actually fun to work with the AI to review the code — I even learned abut how to design some simple tests, too!

I wonder if you need me to add anything else...?

Cheers,

[Omochice]

I apologize for the delay 🙇

Thank you for your exceptional work!

I've verified that it functions smoothly with both plain text and XML formats.

Implementing subcommands is indeed a great idea, although it will necessitate a major version bump due to its impact on the user interface.

Subcommands significantly enhance the code's extensibility, so I'll merge this pull request.

Thanks again!

[Omochice]

Oops!

Since this project was still in the v0.0.x release phase, there was no need to increase the major version.

I'm thinking of releasing it as v0.1.0.