From 346d11f5e097ebc53f46ead937ba1278fe56092b Mon Sep 17 00:00:00 2001 From: H Paterson <26947190+patha454@users.noreply.github.com> Date: Sat, 21 Mar 2020 18:28:59 +1300 Subject: [PATCH 1/4] 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. --- src/dscanner/utils.d | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/dscanner/utils.d b/src/dscanner/utils.d index 92d25e5..d5b1d29 100644 --- a/src/dscanner/utils.d +++ b/src/dscanner/utils.d @@ -84,7 +84,7 @@ string[] expandArgs(string[] args) { import std.file : isFile, FileException, dirEntries, SpanMode; 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. bool isFileSafe(T)(T a) @@ -105,7 +105,7 @@ string[] expandArgs(string[] args) else 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; else continue; From 497a900f210a0a0831110f60162922adc5fc5283 Mon Sep 17 00:00:00 2001 From: H Paterson <26947190+patha454@users.noreply.github.com> Date: Sat, 21 Mar 2020 18:52:00 +1300 Subject: [PATCH 2/4] Exclude all hidden directories. --- src/dscanner/utils.d | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/dscanner/utils.d b/src/dscanner/utils.d index d5b1d29..e5938c1 100644 --- a/src/dscanner/utils.d +++ b/src/dscanner/utils.d @@ -4,6 +4,7 @@ import std.array : appender, uninitializedArray; import std.stdio : stdin, stderr, File; import std.conv : to; import std.encoding : BOM, BOMSeq, EncodingException, getBOM; +import std.path : dirSeparator; import std.format : format; import std.file : exists, read; @@ -105,7 +106,7 @@ string[] expandArgs(string[] args) else foreach (item; dirEntries(arg, SpanMode.breadth).map!(a => a.name)) { - if (isFileSafe(item) && (item.endsWith(`.d`) || item.endsWith(`.di`)) && !item.find('.git')) + if (isFileSafe(item) && (item.endsWith(`.d`) || item.endsWith(`.di`)) && !item.find(dirSeparator ~ '.')) rVal ~= item; else continue; From 7f10a0598a4a6ba66e787381d2616f0db94eeb00 Mon Sep 17 00:00:00 2001 From: H Paterson <26947190+patha454@users.noreply.github.com> Date: Sat, 21 Mar 2020 18:56:58 +1300 Subject: [PATCH 3/4] Fix find function Use `canFind`, not `find` - which returns the post-string, not a boolean. --- src/dscanner/utils.d | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/dscanner/utils.d b/src/dscanner/utils.d index e5938c1..934c847 100644 --- a/src/dscanner/utils.d +++ b/src/dscanner/utils.d @@ -106,7 +106,7 @@ string[] expandArgs(string[] args) else foreach (item; dirEntries(arg, SpanMode.breadth).map!(a => a.name)) { - if (isFileSafe(item) && (item.endsWith(`.d`) || item.endsWith(`.di`)) && !item.find(dirSeparator ~ '.')) + if (isFileSafe(item) && (item.endsWith(`.d`) || item.endsWith(`.di`)) && !item.canFind(dirSeparator ~ '.')) rVal ~= item; else continue; From 064be72ee72b825bc74e03ff8948cd2057e66746 Mon Sep 17 00:00:00 2001 From: H Paterson <26947190+patha454@users.noreply.github.com> Date: Sat, 21 Mar 2020 18:58:07 +1300 Subject: [PATCH 4/4] Fix imports Because I'm rubbish at programming. --- src/dscanner/utils.d | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/dscanner/utils.d b/src/dscanner/utils.d index 934c847..4c7edb7 100644 --- a/src/dscanner/utils.d +++ b/src/dscanner/utils.d @@ -4,7 +4,6 @@ import std.array : appender, uninitializedArray; import std.stdio : stdin, stderr, File; import std.conv : to; import std.encoding : BOM, BOMSeq, EncodingException, getBOM; -import std.path : dirSeparator; import std.format : format; import std.file : exists, read; @@ -85,7 +84,8 @@ string[] expandArgs(string[] args) { import std.file : isFile, FileException, dirEntries, SpanMode; import std.algorithm.iteration : map; - import std.algorithm.searching : endsWith, find; + import std.algorithm.searching : endsWith, canFind; + import std.path : dirSeparator; // isFile can throw if it's a broken symlink. bool isFileSafe(T)(T a)