eth0izzle/shhgit

[Enhancement] Add option to exclude .gitignore-ed files

Open

#60 opened on Jul 25, 2020

View on GitHub
 (0 comments) (1 reaction) (0 assignees)JavaScript (474 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (3,644 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

As a developer and user of shhgit scanning local directories I most likely will have local files like for example .env files containing secrets which are protected through the full-disk-encryption of my machine and prevented to be accidentally committed through the .gitignore or ~/.gitignore_global file.

Expected behavior:

  • I can specify an option to exclude those files matching gitignore-entries from the search

Actual behavior:

  • I have to filter those entries from the shhgit log after the scan finished

Though this option should not be enabled by default as it reduces the visibility of secrets lingering around on the disk (which shouldn't exist in the first place) which could be committed through git add -f…

Contributor guide

Research direction
Implement an option to exclude files matching .gitignore patterns. This involves reading .gitignore and ~/.gitignore global, parsing gitignore rules, and applying them to the file scanning process.
Tech stack
javascript
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
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