tools: prevent string literals in some assertions

String literals provided as the third argument to assert.strictEqual()
or assert.deepStrictEqual() will mask the values that are causing
issues. Use a lint rule to prevent such usage.

PR-URL: nodejs#22849
Reviewed-By: Teddy Katz <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>

.eslintrc.js

@@ -156,6 +156,7 @@ module.exports = {
     ],
     /* eslint-disable max-len */
     // If this list is modified, please copy the change to lib/.eslintrc.yaml
+    // and test/.eslintrc.yaml.
     'no-restricted-syntax': [
       'error',
       {
@@ -166,6 +167,10 @@ module.exports = {
         selector: "CallExpression[callee.object.name='assert'][callee.property.name='rejects'][arguments.length<2]",
         message: 'assert.rejects() must be invoked with at least two arguments.',
       },
+      {
+        selector: "CallExpression[callee.object.name='assert'][callee.property.name='strictEqual'][arguments.2.type='Literal']",
+        message: 'Do not use a literal for the third argument of assert.strictEqual()'
+      },
       {
         selector: "CallExpression[callee.object.name='assert'][callee.property.name='throws'][arguments.1.type='Literal']:not([arguments.1.regex])",
         message: 'Use an object as second argument of assert.throws()',

lib/.eslintrc.yaml

@@ -2,10 +2,14 @@ rules:
   no-restricted-syntax:
     # Config copied from .eslintrc.js
     - error
+    - selector: "CallExpression[callee.object.name='assert'][callee.property.name='deepStrictEqual'][arguments.2.type='Literal']"
+      message: "Do not use a literal for the third argument of assert.deepStrictEqual()"
     - selector: "CallExpression[callee.object.name='assert'][callee.property.name='doesNotThrow']"
       message: "Please replace `assert.doesNotThrow()` and add a comment next to the code instead."
     - selector: "CallExpression[callee.object.name='assert'][callee.property.name='rejects'][arguments.length<2]"
       message: "assert.rejects() must be invoked with at least two arguments."
+    - selector: "CallExpression[callee.object.name='assert'][callee.property.name='strictEqual'][arguments.2.type='Literal']"
+      message: "Do not use a literal for the third argument of assert.strictEqual()"
     - selector: "CallExpression[callee.object.name='assert'][callee.property.name='throws'][arguments.1.type='Literal']:not([arguments.1.regex])"
       message: "Use an object as second argument of assert.throws()"
     - selector: "CallExpression[callee.object.name='assert'][callee.property.name='throws'][arguments.length<2]"

test/.eslintrc.yaml

@@ -23,10 +23,14 @@ rules:
   no-restricted-syntax:
     # Config copied from .eslintrc.js
     - error
+    - selector: "CallExpression[callee.object.name='assert'][callee.property.name='deepStrictEqual'][arguments.2.type='Literal']"
+      message: "Do not use a literal for the third argument of assert.deepStrictEqual()"
     - selector: "CallExpression[callee.object.name='assert'][callee.property.name='doesNotThrow']"
       message: "Please replace `assert.doesNotThrow()` and add a comment next to the code instead."
     - selector: "CallExpression[callee.object.name='assert'][callee.property.name='rejects'][arguments.length<2]"
       message: "assert.rejects() must be invoked with at least two arguments."
+    - selector: "CallExpression[callee.object.name='assert'][callee.property.name='strictEqual'][arguments.2.type='Literal']"
+      message: "Do not use a literal for the third argument of assert.strictEqual()"
     - selector: "CallExpression[callee.object.name='assert'][callee.property.name='throws'][arguments.1.type='Literal']:not([arguments.1.regex])"
       message: "Use an object as second argument of assert.throws()"
     - selector: "CallExpression[callee.object.name='assert'][callee.property.name='throws'][arguments.length<2]"