slimtoolkit/slim

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

Open

#597 geöffnet am 22. Okt. 2023

Auf GitHub ansehen
 (5 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Go (673 Forks)batch import
enhancementgood first issuehelp wanted

Repository-Metriken

Stars
 (17.694 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Das Problem beschreibt, dass ein Platzhalter Flag bereits im CLI Code existiert. Zur Implementierung sollten Sie die CLI Befehlsdefinitionen im Repository untersuchen (wahrscheinlich unter Verwendung einer Bibliothek wie cobra), um zu verstehen, wie Flags derzeit verarbeitet werden. Die Aufgabe besteht darin, eine Logik hinzuzufügen, die eine durch das Flag angegebene JSON Datei liest, deren Inhalt analysiert und sie den entsprechenden Befehlsparametern zuordnet. Sehen Sie sich vorhandene Beispiele für die Flag Verarbeitung in der Codebasis als Referenz an. Stellen Sie sicher, dass Konflikte oder Überschreibungen zwischen Dateiparametern und direkten Flags klar behandelt werden.
Tech Stack
go
Domain
cli
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
4
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Go language knowledgeCLI flag handling experience
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65