RFC: Configure linguist not to ignore node_modules

[rreusser]

Checklist

Please ensure the following tasks are completed before filing an issue.

• Read and understood the Code of Conduct.
• Searched for existing issues and pull requests.
• If this is a general question, searched the FAQ for an existing answer.
• If this is a feature request, the issue name begins with RFC: .

Description

Description of the issue (or feature request).

Github detects a javascript project and collapses any changes in a directory called node_modules when submitting a PR, which I think makes it tedious to review changes. I think it's possible to disable this behavior by configuring linguist to treat lib/node_modules as not vendored (i.e. ignored for the sake of stats and PR review) code.

Related Issues

Does this issue (or feature request) have any related issues?

No.

Questions

Any questions for reviewers?

No.

Other

Any other information relevant to this issue (or feature request)? This may include screenshots, references, stack traces, sample output, and/or implementation notes.

Small, important changes get collapsed:

Demo

If relevant, provide a link to a live demo.

• https://github.com/stdlib-js/stdlib/compare/develop...rreusser:feature/factorial2?expand=1

Reproduction

If this issue is a bug report, what steps are required to reproduce the unexpected output? (If this is a feature request, remove this section.)

In order to reproduce this bug, do the following:

• submit a pull request
• view changes

Expected Results

What are the expected results?

Important changes are visible

Actual Results

What are the actual results?

Important changes are collapsed

[rreusser]

Solving this might just be a one-line addition to .gitattributes of lib/node_modules linguist-vendored=false

[kgryte]

Addressed via commit 20a7043. Can you rebase onto the latest develop and see if the issue is resolved?

[rreusser]

Sad face. Long story short, the juxtaposition of "ignore binary or vendored files and suppress generated files in diffs" suggested specifying vendored files affects diffs. It does do both, but gitattributes files is not available on the front end server, so this doesn't seem to have any effect.

[kgryte]

Thanks for linking in that issue thread. Alas, we'll have to resort to inconvenient ergonomics on this one. On the flip side, the ability to "opt-in" to see a diff is handy, especially when only wanting to see which files changed.

[kgryte]

One side effect of fiddling with .gitattributes is that the language statistics are now a bit odd. Need to explore a bit more to see how linguist is determining LOC per file type.

[rreusser]

It sounds back and forth and unclear and maybe reports of it working temporarily. There's vendored and generated. Maybe that line needs to be lib/node_modules/* linguist-generated=false. See: github-linguist/linguist#3539 (comment)

(Another iteration or two and it'll probably balance out the cost of investigating too much further 😄 )

[rreusser]

Ah, maybe this is the line:

As an added bonus, unlike vendored and documentation files, these files are suppressed in diffs.

So maybe it's both vendored and generated and it's marking it not-generated that prevents suppression.

[kgryte]

Set the pathname attribute in commit 885a6fc. Perhaps this will work.

[rreusser]

Worked, thanks! Hopefully doesn't mix up the stats too much. If the stats are okay, I'm perfectly content to consider solved.

[kgryte]

Awesome. Yeah, not too concerned about GitHub getting the language stats a bit off. We have internal tooling which does more accurate computations. Closing...