Skip to content

Add Argcomplete for Command-Line Auto-Completion & Completer Functions#10

Merged
httpdss merged 8 commits into
mainfrom
args-autocomplete
Sep 20, 2024
Merged

Add Argcomplete for Command-Line Auto-Completion & Completer Functions#10
httpdss merged 8 commits into
mainfrom
args-autocomplete

Conversation

@httpdss
Copy link
Copy Markdown
Owner

@httpdss httpdss commented Sep 20, 2024

Overview:
This pull request introduces command-line auto-completion for the struct script using the argcomplete library, along with some refactoring and enhancements in the command structure. Additionally, completer functions are implemented to streamline argument handling.

Changes:

  • Added argcomplete for auto-completion in the Dockerfile and Python scripts.
  • Updated the README.md with instructions for enabling auto-completion.
  • Modified YAML template files to use a consistent syntax for variables ({{@ var @}}).
  • Integrated command-line completers for options such as log_level and file_strategy in the struct_module.
  • Updated the requirements.txt to include argcomplete.
  • Created tests for filter functions, focusing on get_latest_release and stringify.

Justification:
The inclusion of command-line auto-completion improves the developer experience by allowing faster and more accurate command entry. The added completers make commands more user-friendly and reduce errors during input. YAML files have been refactored for better consistency.

Impact:

  • Users will now benefit from auto-completion when using the struct script.
  • The new completion functionality will require reloading of shell configuration for it to take effect.
  • Refactored YAML templates and improved testing coverage enhance maintainability and consistency.

@httpdss httpdss self-assigned this Sep 20, 2024
@httpdss httpdss changed the title Args autocomplete Add Argcomplete for Command-Line Auto-Completion & Completer Functions Sep 20, 2024
@httpdss httpdss marked this pull request as ready for review September 20, 2024 02:44
@httpdss httpdss merged commit 3a66405 into main Sep 20, 2024
@httpdss httpdss deleted the args-autocomplete branch September 20, 2024 02:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant