hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-23 07:45:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

remove more false positives from the ql/missing-parameter-qldoc query

Browse Source
This commit is contained in:
Erik Krogh Kristensen
2022-07-13 09:57:17 +02:00
parent 4b50c68934
commit dded3af3d8
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
ql/ql/src/queries/style/MissingParameterInQlDoc.ql
View File

@@ -44,7 +44,10 @@ private string getAMentionedNonParameter(Predicate p) {
not result.toLowerCase() = getAParameterName(p).toLowerCase() and
// keywords
not result =
["true", "false", "NaN", "this", "forall", "exists", "null", "break", "return", "not"] and
[
"true", "false", "NaN", "this", "forall", "exists", "null", "break", "return", "not", "if",
"then", "else", "import"
] and
not result = any(Aggregate a).getKind() and // min, max, sum, count, etc.
not result = getMentionedThings(p.getLocation().getFile()) and
not result = any(Annotation a).getName() and // private, final, etc.
@@ -66,7 +69,7 @@ private string getMentionedThings(File file) {
private string getAnUndocumentedParameter(Predicate p) {
result = getAParameterName(p) and
not result.toLowerCase() = getADocumentedParameter(p).toLowerCase() and
not result = ["config", "conf", "cfg"] and // DataFlow configurations are often undocumented, and that's fine.
not result = ["config", "conf", "cfg", "t", "t2"] and // DataFlow configurations / type-trackers are often undocumented, and that's fine.
not (
// "the given" often refers to the first parameter.
p.getQLDoc().getContents().regexpMatch("(?s).*\\bthe given\\b.*") and
@@ -85,7 +88,7 @@ private string getMentionedNonParameters(Predicate p) {
}
from Predicate p
where not p.getLocation().getFile().getBaseName() = "Aliases.qll" // these are OK
where not p.getLocation().getFile().getBaseName() in ["Aliases.qll", "TreeSitter.qll"] // these are OK
select p,
"The QLDoc has no documentation for " + getUndocumentedParameters(p) + ", but the QLDoc mentions "
+ getMentionedNonParameters(p)