slimtoolkit/slim

CLI Enhancement: Ability to specify all command parameters in a json file ("command-params-file" flag)

Open

#597 ouverte le 22 oct. 2023

Voir sur GitHub
 (5 commentaires) (1 réaction) (0 assignés)Go (673 forks)batch import
enhancementgood first issuehelp wanted

Métriques du dépôt

Stars
 (17 694 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Right now each CLI command accepts a set of command parameters as separate command line flags. It's ok for adhoc use, but it's less ideal for automation. The goal for the "command-params-file" flag is to provide an ability to specify all required command-specific parameters in one JSON formatted file.

There's already a placeholder for the flag, but there's no logic to load and process the file data.

This is a good first issue for somebody already comfortable with Go and refactoring a significant amount of CLI flag processing code.

Guide contributeur

Direction de recherche
Le problème décrit qu'un indicateur de substitution existe déjà dans le code CLI. Pour implémenter, examinez les définitions de commande CLI dans le dépôt (utilisant probablement une bibliothèque comme cobra) pour comprendre comment les indicateurs sont actuellement traités. La tâche consiste à ajouter la logique qui lit un fichier JSON spécifié par l'indicateur, analyse son contenu et le mappe aux paramètres de commande appropriés. Consultez les exemples existants de gestion des indicateurs dans la base de code pour référence. Assurez vous de gérer clairement tout conflit ou remplacement entre les paramètres de fichier et les indicateurs directs.
Stack technique
go
Domaine
cli
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
4
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Go language knowledgeCLI flag handling experience
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65