lirantal/detect-secrets

Enhancement: Support for enabling debug logs via flags

Geschlossen

#1 geöffnet am 05.07.2019

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (5 Forks)github user discovery
good first issuestale

Repository-Metriken

Stars
 (52 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 6T 13h) (4 gemergte PRs in 30 T)

Beschreibung

Is your feature request related to a problem? Please describe. If I'm trying to debug how detect-secrets work then I need to run it with DEBUG=detect-secrets which lint-staged isn't friendly with. Instead, I'd want to pass it some flags like --debug in order to enable debugging.

Describe the solution you'd like

  1. Add a --debug flag to enable debugging
  2. This should enable debug dynamically via debug.enable('detect-secrets')
  3. Discard the flag from process.argv so it doesn't get passed to the actual detect-secrets-hook tool

Describe alternatives you've considered Open to other ideas

Contributor Guide

Research-Richtung
Untersuche die Codebasis, um zu finden, wo Kommandozeilenargumente geparst werden (z.B. mit yargs oder process.argv). Implementiere dann ein ` debug` Flag, das über das `debug` Paket den 'detect secrets' Debug Namensraum aktiviert, und stelle sicher, dass das Flag entfernt wird, bevor die Argumente an das zugrunde liegende Tool übergeben werden.
Tech Stack
javascriptnodejs
Domain
cli
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
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.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70