lirantal/detect-secrets

Enhancement: Support for enabling debug logs via flags

Closed

#1 opened on Jul 5, 2019

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)JavaScript (5 forks)github user discovery
good first issuestale

Repository metrics

Stars
 (52 stars)
PR merge metrics
 (Avg merge 6d 13h) (4 merged PRs in 30d)

Description

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 direction
Examine the codebase to find where command line arguments are parsed (e.g., using yargs or process.argv). Then implement a ` debug` flag that enables the 'detect secrets' debug namespace via the `debug` package, and ensure the flag is stripped before passing arguments to the underlying tool.
Tech stack
javascriptnodejs
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70