forks
/
D-Scanner
mirror of https://github.com/dlang-community/D-Scanner.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Exclude `.git` from search paths. 

Currently dscanner searches for files in the target directory ending in `.d` or `.di`.

Git has some hidden files in `.git`, which log commits to files. These files share the same name as the tracked file: For example `.git/logs/refs/heads/somedfile.d` actually contains Git data, not D code.

A naive call to dscanner using `dscanner --syntaxCheck` or `dscanner --styleCheck` (therefore also `dub lint...`) will attempt to check these Git files, resulting in spurious errors, such as:
```sh
./.git/logs/refs/heads/charstream.d(1:1)[error]:
./.git/logs/refs/heads/charstream.d(1:118)[warn]: Line is longer than 120 characters
```

I believe Git is a common enough tool that we're justified to handle this case inside D scanner, rather than asking the user to write configuration files with dodge the `.git` folder.
This commit is contained in:
H Paterson 2020-03-21 18:28:59 +13:00 committed by GitHub
parent 54e073e308
commit 346d11f5e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/dscanner/utils.d
View File

@ -84,7 +84,7 @@ string[] expandArgs(string[] args)
{ {
import std.file : isFile, FileException, dirEntries, SpanMode; import std.file : isFile, FileException, dirEntries, SpanMode;
import std.algorithm.iteration : map; import std.algorithm.iteration : map;
import std.algorithm.searching : endsWith; import std.algorithm.searching : endsWith, find;
// isFile can throw if it's a broken symlink. // isFile can throw if it's a broken symlink.
bool isFileSafe(T)(T a) bool isFileSafe(T)(T a)
@ -105,7 +105,7 @@ string[] expandArgs(string[] args)
else else
foreach (item; dirEntries(arg, SpanMode.breadth).map!(a => a.name)) foreach (item; dirEntries(arg, SpanMode.breadth).map!(a => a.name))
{ {
if (isFileSafe(item) && (item.endsWith(`.d`) || item.endsWith(`.di`))) if (isFileSafe(item) && (item.endsWith(`.d`) || item.endsWith(`.di`)) && !item.find('.git'))
rVal ~= item; rVal ~= item;
else else
continue; continue;