Merge pull request github#10730 from erik-krogh/ql-last-msg

QL: fix some more style-guide violations in the alert-messages

Author: erik-krogh

ql/ql/src/qlpack.yml

@@ -6,4 +6,4 @@ suites: codeql-suites
 defaultSuiteFile: codeql-suites/ql-code-scanning.qls
 extractor: ql
 dependencies:
-  codeql/typos: 0.0.2-dev
+  codeql/typos: 0.0.3-dev

ql/ql/src/queries/bugs/MissingSanitizerGuardCase.ql

@@ -25,4 +25,4 @@ from SanGuard guard
 where
   not exists(TypeExpr t | t.getResolvedType().(ClassType).getDeclaration() = guard) and
   not guard.hasAnnotation("deprecated")
-select guard, "Guard class is not mentioned anywhere"
+select guard, "Guard class is not mentioned anywhere."

ql/ql/src/queries/performance/DontUseGetAQlClass.ql

@@ -19,4 +19,4 @@ where
   not call.getLocation().getFile().getAbsolutePath().matches("%/" + ["meta", "test"] + "/%") and
   not call.getLocation().getFile().getBaseName().toLowerCase() =
     ["consistency.ql", "test.ql", "tst.ql", "tests.ql"]
-select call, "Don't use .getAQlClass"
+select call, "Don't use '.getAQlClass()'."

ql/ql/src/queries/performance/NonInitialStdLibImport.ql

@@ -27,4 +27,4 @@ Import importBefore(Import i) {
 
 from Import i
 where isStdLibImport(i, _) and exists(importBefore(i))
-select i, "This import may cause reevaluation to occur, as there are other imports preceding it"
+select i, "This import may cause reevaluation to occur, as there are other imports preceding it."

ql/ql/src/queries/performance/TransitiveStep.ql

@@ -161,5 +161,5 @@ predicate transitiveDelta(Call rec, TransitivelyClosedCall tc) {
 
 from Call rec, TransitivelyClosedCall tc, AstNode reason
 where transitiveDelta(rec, tc) and reason = tc.getReason()
-select tc, "This recursive delta is transively closed $@, which may be a performance problem.",
-  reason, "here"
+select tc, "This recursive delta is $@, which may be a performance problem.", reason,
+  "transitively closed"

ql/ql/src/queries/performance/UnusedField.ql

@@ -31,5 +31,6 @@ where
     )
   ) and
   (if clz = implClz then extraMsg = "." else extraMsg = " of any class between it and $@.")
-select clz, "The field $@ declared in $@ is not used in the characteristic predicate" + extraMsg,
-  field, field.getName(), clz, clz.getName(), implClz, implClz.getName()
+select clz,
+  "This class declares the $@ but does not bind it in the characteristic predicate" + extraMsg,
+  field, "field " + field.getName(), implClz, implClz.getName()

ql/ql/src/queries/style/AcronymsShouldBeCamelCase.ql

@@ -14,4 +14,4 @@ import codeql_ql.style.AcronymsShouldBeCamelCaseQuery
 
 from string name, AstNode node
 where shouldBePascalCased(name, node, _)
-select node, "Acronyms in " + name + " should be PascalCase/camelCase"
+select node, "Acronyms in " + name + " should be PascalCase/camelCase."

ql/ql/src/queries/style/AlertMessage.ql

@@ -126,7 +126,7 @@ String avoidHere(Select sel, string part) {
 String avoidArticleInLinkText(Select sel) {
   result = sel.getExpr((any(int i | i > 1))) and
   result = getSelectPart(sel, _) and
-  result.getValue().regexpMatch("a|an .*")
+  result.getValue().regexpMatch("(a|an) .*")
 }
 
 /**
@@ -203,6 +203,9 @@ AstNode getAlertLocLink(Select sel) {
 from AstNode node, string msg, Select sel
 where
   not node.getLocation().getFile().getAbsolutePath().matches("%/test/%") and
+  not node.getLocation().getFile().getAbsolutePath().matches("%/examples/%") and
+  not node.getLocation().getFile().getAbsolutePath().matches("%/experimental/%") and
+  not node.getLocation().getFile().getAbsolutePath().matches("%/meta/%") and
   sel.getQueryDoc().getQueryKind() = ["problem", "path-problem"] and
   (
     node = shouldHaveFullStop(sel) and

ql/ql/src/queries/style/DeadCode.ql

@@ -12,4 +12,4 @@ import codeql_ql.style.DeadCodeQuery
 
 from AstNode node
 where isDead(node)
-select node, "Code is dead"
+select node, "This code is never used, and it's not publicly exported."

ql/ql/src/queries/style/FieldOnlyUsedInCharPred.ql

@@ -22,4 +22,4 @@ where
       call.getEnclosingPredicate() = c.getCharPred() and call.getTarget() instanceof NewTypeBranch
     ).getAnArgument() and
   not f.getVarDecl().overrides(_)
-select f, "Field is only used in CharPred"
+select f, "Field is only used in CharPred."