isomorphic-git/isomorphic-git

statusMatrix() does not work correctly when there is a symlink that targets an ignored directory

Closed

#1,215 opened on Aug 30, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)JavaScript (351 forks)batch import
buggood first issue

Repository metrics

Stars
 (7,054 stars)
PR merge metrics
 (Avg merge 13d 13h) (7 merged PRs in 30d)

Description

Bug description

When there is a symlink that targets an ignored directory (such as node_modules), statusMatrix() would list files within the ignored directory as "new". This is different from git status --porcelain=v1 when these files are not listed.

Steps to reproduce

  1. Clone https://github.com/KSXGitHub/isomorphic-git-issue-incorrect-file-listing-for-symlink.git
  2. Run npm install and npm test

You will see that the files "within" symlink-to-ignored-directory are listed by isomorphic-git but not by native git.

Contributor guide

Research direction
Investigate the statusMatrix implementation in isomorphic git to understand how it handles symlinks. Specifically, look at how it enumerates files and applies .gitignore rules. The bug occurs when a symlink targets an ignored directory; the files inside the symlink target are incorrectly listed. Trace the code path that discovers files and filters based on ignore rules. Check if the symlink itself is being resolved before filtering.
Tech stack
javascript
Domain
backendapi
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60