hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-01-06 19:20:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

JavaScript: Teach AutoBuild to exclude minified files from extraction by default .

Browse Source 
This adds default exclusion filters for `**/*.min.js` and `**/*-min.js` to the JavaScript auto-builder, meaning that files matching these patterns will no longer be extracted,
unless they are re-included in the `.lgtm.yml` file.

Alerts in minified code aren't shown by default anyway, so we can save ourselves some work by not analyzing them in the first place.

While including minified files in the snapshot can in theory improve analysis results in non-minified files, this is likely to be rare in practice.
This commit is contained in:
Max Schaefer
2018-11-19 16:41:32 +00:00
parent dd4c9654f2
commit 19aa12106c
3 changed files with 43 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
javascript/extractor/src/com/semmle/js/extractor/AutoBuild.java
View File

@@ -111,7 +111,7 @@ import com.semmle.util.trap.TrapWriter;
*
* <p>
* The filtering phase is parameterised by a list of include/exclude patterns in the style of
* {@link ProjectLayout} specifications. There are some built-in include patterns discussed
* {@link ProjectLayout} specifications. There are some built-in include/exclude patterns discussed
* below. Additionally, the environment variable <code>LGTM_INDEX_FILTERS</code> is interpreted
* as a newline-separated list of patterns to append to that list (hence taking precedence over
* the built-in patterns). Unlike for {@link ProjectLayout}, patterns in
@@ -140,6 +140,15 @@ import com.semmle.util.trap.TrapWriter;
* </p>
*
* <p>
* The default exclusion patterns cause the following files to be excluded:
* </p>
* <ul>
* <li>All JavaScript files whose name ends with <code>-min.js</code> or <code>.min.js</code>.
* Such files typically contain minified code. Since LGTM by default does not show results
* in minified files, it is not usually worth extracting them in the first place.</li>
* </ul>
*
* <p>
* JavaScript files are normally extracted with {@link SourceType#AUTO}, but an explicit
* source type can be specified in the environment variable <code>LGTM_INDEX_SOURCE_TYPE</code>.
* </p>
@@ -317,6 +326,10 @@ public class AutoBuild {
patterns.add("**/.eslintrc*");
patterns.add("**/package.json");
// exclude files whose name strongly suggests they are minified
patterns.add("-**/*.min.js");
patterns.add("-**/*-min.js");
String base = LGTM_SRC.toString().replace('\\', '/');
// process `$LGTM_INDEX_FILTERS`
for (String pattern : Main.NEWLINE.split(getEnvVar("LGTM_INDEX_FILTERS", ""))) {

19
javascript/extractor/src/com/semmle/js/extractor/test/AutoBuildTests.java
View File

@@ -433,4 +433,23 @@ public class AutoBuildTests {
addFile(true, LGTM_SRC, "tst.js");
runTest();
}
@Test
public void minifiedFilesAreExcluded() throws IOException {
addFile(true, LGTM_SRC, "admin.js");
addFile(false, LGTM_SRC, "jquery.min.js");
addFile(false, LGTM_SRC, "lib", "lodash-min.js");
addFile(true, LGTM_SRC, "compute_min.js");
runTest();
}
@Test
public void minifiedFilesCanBeReIncluded() throws IOException {
envVars.put("LGTM_INDEX_FILTERS", "include:**/*.min.js\ninclude:**/*-min.js");
addFile(true, LGTM_SRC, "admin.js");
addFile(true, LGTM_SRC, "jquery.min.js");
addFile(true, LGTM_SRC, "lib", "lodash-min.js");
addFile(true, LGTM_SRC, "compute_min.js");
runTest();
}
}