Merge pull request #7984 from erik-krogh/fix-ql-for-ql-js

JS: fix most ql-for-ql warnings

Author: erik-krogh

javascript/ql/examples/queries/dataflow/BackendIdor/BackendIdor.ql

@@ -13,7 +13,7 @@ import DataFlow
 import DataFlow::PathGraph
 
 /**
- * Tracks user-controlled values into a 'userId' property sent to a backend service.
+ * A taint-tracking configuration that tracks user-controlled values into a 'userId' property sent to a backend service.
  */
 class IdorTaint extends TaintTracking::Configuration {
   IdorTaint() { this = "IdorTaint" }
@@ -34,7 +34,7 @@ class IdorTaint extends TaintTracking::Configuration {
 }
 
 /**
- * Sanitize values that have succesfully been compared to another value.
+ * A sanitizer for values that have succesfully been compared to another value.
  */
 class EqualityGuard extends TaintTracking::SanitizerGuardNode, ValueNode {
   override EqualityTest astNode;

javascript/ql/examples/queries/dataflow/InformationDisclosure/InformationDisclosure.ql

@@ -13,7 +13,8 @@ import DataFlow
 import DataFlow::PathGraph
 
 /**
- * Tracks authentication tokens ("authKey") to a postMessage call with unrestricted target origin.
+ * A dataflow configuration that tracks authentication tokens ("authKey")
+ * to a postMessage call with unrestricted target origin.
  *
  * For example:
  * ```

javascript/ql/examples/queries/dataflow/StoredXss/StoredXss.ql

@@ -12,7 +12,7 @@ import semmle.javascript.security.dataflow.StoredXssQuery
 import DataFlow::PathGraph
 
 /**
- * Data returned from a MySQL query, such as the `data` parameter in this example:
+ * The data returned from a MySQL query, such as the `data` parameter in this example:
  * ```
  * let mysql = require('mysql');
  * let connection = mysql.createConnection();

javascript/ql/examples/queries/dataflow/StoredXss/StoredXssTypeTracking.ql

@@ -28,7 +28,7 @@ DataFlow::SourceNode mysqlConnection(DataFlow::TypeTracker t) {
 DataFlow::SourceNode mysqlConnection() { result = mysqlConnection(DataFlow::TypeTracker::end()) }
 
 /**
- * Data returned from a MySQL query.
+ * The data returned from a MySQL query.
  *
  * For example:
  * ```

javascript/ql/experimental/adaptivethreatmodeling/lib/experimental/adaptivethreatmodeling/BaseScoring.qll

@@ -15,7 +15,7 @@ external predicate availableMlModels(
 ATMConfig getCfg() { any() }
 
 /**
- * Scoring information produced by a scoring model.
+ * A string containing scoring information produced by a scoring model.
  *
  * Scoring models include embedding models and endpoint scoring models.
  */

javascript/ql/lib/semmle/javascript/DefensiveProgramming.qll

@@ -188,7 +188,7 @@ module DefensiveExpressionTest {
   }
 
   /**
-   * Comparison against `undefined`, such as `x === undefined`.
+   * A comparison against `undefined`, such as `x === undefined`.
    */
   class UndefinedComparison extends NullUndefinedComparison {
     UndefinedComparison() { op2type = TTUndefined() }

javascript/ql/lib/semmle/javascript/Routing.qll

@@ -652,7 +652,7 @@ module Routing {
    */
   module Router {
     /**
-     * Creation of a mutable router object.
+     * The creation of a mutable router object.
      */
     abstract class Range extends DataFlow::Node {
       /** Gets a reference to this router. */

javascript/ql/lib/semmle/javascript/TypeScript.qll

@@ -1679,7 +1679,7 @@ class EnumScope extends @enum_scope, Scope {
 }
 
 /**
- * Scope induced by a declaration of form `declare module "X" {...}`.
+ * A scope induced by a declaration of form `declare module "X" {...}`.
  */
 class ExternalModuleScope extends @external_module_scope, Scope {
   override string toString() { result = "external module scope" }
@@ -2836,12 +2836,7 @@ class ConstructorCallSignatureType extends CallSignatureType, @constructor_signa
 private class PromiseTypeName extends TypeName {
   PromiseTypeName() {
     // The name must suggest it is a promise.
-    exists(string name | name = this.getName() |
-      name.matches("%Promise") or
-      name.matches("%PromiseLike") or
-      name.matches("%Thenable") or
-      name.matches("%Deferred")
-    ) and
+    this.getName().matches(["%Promise", "%PromiseLike", "%Thenable", "%Deferred"]) and
     // The `then` method should take a callback, taking an argument of type `T`.
     exists(TypeReference self, Type thenMethod | self = this.getType() |
       self.getNumTypeArgument() = 1 and

javascript/ql/lib/semmle/javascript/dataflow/TaintTracking.qll

@@ -635,39 +635,18 @@ module TaintTracking {
           pred.asExpr() = succ.getAstNode().(MethodCallExpr).getReceiver() and
           (
             // sorted, interesting, properties of String.prototype
-            name = "anchor" or
-            name = "big" or
-            name = "blink" or
-            name = "bold" or
-            name = "concat" or
-            name = "fixed" or
-            name = "fontcolor" or
-            name = "fontsize" or
-            name = "italics" or
-            name = "link" or
-            name = "padEnd" or
-            name = "padStart" or
-            name = "repeat" or
-            name = "replace" or
-            name = "replaceAll" or
-            name = "slice" or
-            name = "small" or
-            name = "split" or
-            name = "strike" or
-            name = "sub" or
-            name = "substr" or
-            name = "substring" or
-            name = "sup" or
-            name = "toLocaleLowerCase" or
-            name = "toLocaleUpperCase" or
-            name = "toLowerCase" or
-            name = "toUpperCase" or
-            name = "trim" or
-            name = "trimLeft" or
-            name = "trimRight" or
+            name =
+              [
+                "anchor", "big", "blink", "bold", "concat", "fixed", "fontcolor", "fontsize",
+                "italics", "link", "padEnd", "padStart", "repeat", "replace", "replaceAll", "slice",
+                "small", "split", "strike", "sub", "substr", "substring", "sup",
+                "toLocaleLowerCase", "toLocaleUpperCase", "toLowerCase", "toUpperCase", "trim",
+                "trimLeft", "trimRight"
+              ]
+            or
             // sorted, interesting, properties of Object.prototype
-            name = "toString" or
-            name = "valueOf" or
+            name = ["toString", "valueOf"]
+            or
             // sorted, interesting, properties of Array.prototype
             name = "join"
           )

javascript/ql/lib/semmle/javascript/dataflow/TypeInference.qll

@@ -230,7 +230,7 @@ class AnalyzedModule extends TopLevel {
 }
 
 /**
- * Flow analysis for functions.
+ * A function for which analysis results are available.
  */
 class AnalyzedFunction extends DataFlow::AnalyzedValueNode {
   override Function astNode;