eth0izzle/shhgit

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

Ouverte

#60 ouverte le 25 juil. 2020

Voir sur GitHub
 (0 commentaire) (1 réaction) (0 personne assignée)JavaScript (481 forks)batch import
enhancementhelp wanted

Métriques du dépôt

Stars
 (3 976 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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…

Guide contributeur

Direction de recherche
Le problème demande une option pour exclure les fichiers correspondant aux règles .gitignore. La mise en œuvre impliquerait probablement de modifier la logique de scan des fichiers pour filtrer les chemins correspondant aux motifs gitignore. Des bibliothèques Go existantes comme 'gitignore' peuvent être utilisées. Le changement doit être derrière un drapeau désactivé par défaut. La fonction de scan dans la base de code (probablement dans un fichier comme 'scanner.go' ou 'main.go') doit être mise à jour pour accepter et appliquer les règles gitignore. Comme le problème n'a pas d'activité, le contributeur doit d'abord confirmer avec les mainteneurs si cette fonctionnalité est toujours souhaitée.
Stack technique
javascript
Domaine
backend
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.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70