Allow underscore prefix to bypass noUnusedLocals warning

This PR continues [Allow leading underscore for
types...](#58884),
taking into account feedback from https://github.com/microsoft/TypeScript/pull/58884/files#r1643108204.

The initial commit on this PR is original work by @a-tarasyuk. The second
commit enhances the test suite and reverts the change to checker.ts to
get a new baseline on the test suite for easier comparison with the
changes. The third commit changes checker.ts to allow any unused local if
it is prefixed with an underscore. This has the effect of newly allowing
the following unused declarations:

```ts
// Variables were previously allowed only in destructuring and for-loops
const _unusedVar = 2;
let _unusedLet = 4;
var _unusedVar2 = 6;

// These two no longer raise
// error TS6198: All destructured elements are unused
const { _a, _b } = { _a: 1, _b: 1 };
function f2({_a, _b})

function _unusedFunc() { }
const _unusedArrow = () => { };
class _UnusedClass { }
interface _UnusedInterface { }
type _UnusedType = string;
enum _UnusedEnum { A }
namespace _UnusedNamespace { ... }
```

As far as I can tell, enum members and properties are not checked in the
checkUnusedLocalsAndParameters function, and we do not need to special-case
them.

Closes #58561

Author: jonshea

src/compiler/checker.ts

@@ -44409,21 +44409,6 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
         return tryCast(getRootDeclaration(node), isParameter);
     }
 
-    function isValidUnusedLocalDeclaration(declaration: Declaration): boolean {
-        if (isBindingElement(declaration)) {
-            if (isObjectBindingPattern(declaration.parent)) {
-                /**
-                 * ignore starts with underscore names _
-                 * const { a: _a } = { a: 1 }
-                 */
-                return !!(declaration.propertyName && isIdentifierThatStartsWithUnderscore(declaration.name));
-            }
-            return isIdentifierThatStartsWithUnderscore(declaration.name);
-        }
-        return isAmbientModule(declaration) ||
-            (isVariableDeclaration(declaration) && isForInOrOfStatement(declaration.parent.parent) || isImportedDeclaration(declaration)) && isIdentifierThatStartsWithUnderscore(declaration.name!);
-    }
-
     function checkUnusedLocalsAndParameters(nodeWithLocals: HasLocals, addDiagnostic: AddUnusedDiagnostic): void {
         // Ideally we could use the ImportClause directly as a key, but must wait until we have full ES6 maps. So must store key along with value.
         const unusedImports = new Map<string, [ImportClause, ImportedDeclaration[]]>();
@@ -44438,7 +44423,8 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
 
             if (local.declarations) {
                 for (const declaration of local.declarations) {
-                    if (isValidUnusedLocalDeclaration(declaration)) {
+                    const name = getNameOfDeclaration(declaration);
+                    if (isAmbientModule(declaration) || name && isIdentifierThatStartsWithUnderscore(name)) {
                         continue;
                     }
 

tests/baselines/reference/noUnusedLocals_types.errors.txt

@@ -1,13 +1,9 @@
 noUnusedLocals_types.ts(4,6): error TS6196: 'UnusedType1' is declared but never used.
 noUnusedLocals_types.ts(5,11): error TS6196: 'UnusedInterface1' is declared but never used.
 noUnusedLocals_types.ts(6,7): error TS6196: 'UnusedClass1' is declared but never used.
-noUnusedLocals_types.ts(9,6): error TS6196: '_UnusedType2' is declared but never used.
-noUnusedLocals_types.ts(10,11): error TS6196: '_UnusedInterface2' is declared but never used.
-noUnusedLocals_types.ts(11,7): error TS6196: '_UnusedClass2' is declared but never used.
-noUnusedLocals_types.ts(15,6): error TS6196: '_Helper' is declared but never used.
 
 
-==== noUnusedLocals_types.ts (7 errors) ====
+==== noUnusedLocals_types.ts (3 errors) ====
     // Test specifically for type declarations with underscore prefix
 
     // These should all produce errors (no underscore)
@@ -23,19 +19,11 @@ noUnusedLocals_types.ts(15,6): error TS6196: '_Helper' is declared but never use
 
     // These should NOT produce errors (underscore prefix)
     type _UnusedType2 = string;
-         ~~~~~~~~~~~~
-!!! error TS6196: '_UnusedType2' is declared but never used.
     interface _UnusedInterface2 { x: number; }  
-              ~~~~~~~~~~~~~~~~~
-!!! error TS6196: '_UnusedInterface2' is declared but never used.
     class _UnusedClass2 { }
-          ~~~~~~~~~~~~~
-!!! error TS6196: '_UnusedClass2' is declared but never used.
 
     // Mixed usage - only the one without underscore should error
     type UsedInOther = number;
     type _Helper = UsedInOther; // _Helper is not an error, but it uses UsedInOther
-         ~~~~~~~
-!!! error TS6196: '_Helper' is declared but never used.
 
     export {};

tests/baselines/reference/unusedLocalsStartingWithUnderscore.errors.txt

@@ -1,27 +1,16 @@
 unusedLocalsStartingWithUnderscore.ts(2,7): error TS6133: 'unusedVar' is declared but its value is never read.
-unusedLocalsStartingWithUnderscore.ts(3,7): error TS6133: '_unusedVar' is declared but its value is never read.
 unusedLocalsStartingWithUnderscore.ts(5,5): error TS6133: 'unusedLet' is declared but its value is never read.
-unusedLocalsStartingWithUnderscore.ts(6,5): error TS6133: '_unusedLet' is declared but its value is never read.
 unusedLocalsStartingWithUnderscore.ts(8,5): error TS6133: 'unusedVar2' is declared but its value is never read.
-unusedLocalsStartingWithUnderscore.ts(9,5): error TS6133: '_unusedVar2' is declared but its value is never read.
-unusedLocalsStartingWithUnderscore.ts(11,7): error TS6198: All destructured elements are unused.
-unusedLocalsStartingWithUnderscore.ts(12,7): error TS6198: All destructured elements are unused.
+unusedLocalsStartingWithUnderscore.ts(11,9): error TS6133: 'a1' is declared but its value is never read.
 unusedLocalsStartingWithUnderscore.ts(15,10): error TS6133: 'unusedFunc' is declared but its value is never read.
-unusedLocalsStartingWithUnderscore.ts(16,10): error TS6133: '_unusedFunc' is declared but its value is never read.
 unusedLocalsStartingWithUnderscore.ts(18,7): error TS6133: 'unusedArrow' is declared but its value is never read.
-unusedLocalsStartingWithUnderscore.ts(19,7): error TS6133: '_unusedArrow' is declared but its value is never read.
 unusedLocalsStartingWithUnderscore.ts(22,7): error TS6196: 'UnusedClass' is declared but never used.
-unusedLocalsStartingWithUnderscore.ts(23,7): error TS6196: '_UnusedClass' is declared but never used.
 unusedLocalsStartingWithUnderscore.ts(26,11): error TS6196: 'UnusedInterface' is declared but never used.
-unusedLocalsStartingWithUnderscore.ts(27,11): error TS6196: '_UnusedInterface' is declared but never used.
 unusedLocalsStartingWithUnderscore.ts(30,6): error TS6196: 'UnusedType' is declared but never used.
-unusedLocalsStartingWithUnderscore.ts(31,6): error TS6196: '_UnusedType' is declared but never used.
 unusedLocalsStartingWithUnderscore.ts(34,6): error TS6196: 'UnusedEnum' is declared but never used.
-unusedLocalsStartingWithUnderscore.ts(35,6): error TS6196: '_UnusedEnum' is declared but never used.
 unusedLocalsStartingWithUnderscore.ts(39,12): error TS6133: 'x' is declared but its value is never read.
 unusedLocalsStartingWithUnderscore.ts(41,12): error TS6133: 'x' is declared but its value is never read.
 unusedLocalsStartingWithUnderscore.ts(44,11): error TS6133: 'UnusedNamespace' is declared but its value is never read.
-unusedLocalsStartingWithUnderscore.ts(47,11): error TS6133: '_UnusedNamespace' is declared but its value is never read.
 unusedLocalsStartingWithUnderscore.ts(52,7): error TS6133: 'unusedA' is declared but its value is never read.
 unusedLocalsStartingWithUnderscore.ts(54,8): error TS6133: 'unusedC' is declared but its value is never read.
 unusedLocalsStartingWithUnderscore.ts(61,7): error TS6196: 'TestClass' is declared but never used.
@@ -34,82 +23,62 @@ unusedLocalsStartingWithUnderscore.ts(74,11): error TS6196: 'TestInterface' is d
 unusedLocalsStartingWithUnderscore.ts(79,7): error TS6133: 'obj' is declared but its value is never read.
 
 
-==== unusedLocalsStartingWithUnderscore.ts (34 errors) ====
+==== unusedLocalsStartingWithUnderscore.ts (23 errors) ====
     // Variables
     const unusedVar = 1; // error
           ~~~~~~~~~
 !!! error TS6133: 'unusedVar' is declared but its value is never read.
     const _unusedVar = 2; // ok
-          ~~~~~~~~~~
-!!! error TS6133: '_unusedVar' is declared but its value is never read.
 
     let unusedLet = 3; // error  
         ~~~~~~~~~
 !!! error TS6133: 'unusedLet' is declared but its value is never read.
     let _unusedLet = 4; // ok
-        ~~~~~~~~~~
-!!! error TS6133: '_unusedLet' is declared but its value is never read.
 
     var unusedVar2 = 5; // error
         ~~~~~~~~~~
 !!! error TS6133: 'unusedVar2' is declared but its value is never read.
     var _unusedVar2 = 6; // ok
-        ~~~~~~~~~~~
-!!! error TS6133: '_unusedVar2' is declared but its value is never read.
 
     const { a1, _b1 } = { a1: 1, _b1: 2 }; // error on a1
-          ~~~~~~~~~~~
-!!! error TS6198: All destructured elements are unused.
+            ~~
+!!! error TS6133: 'a1' is declared but its value is never read.
     const { _a2, _b2 } = { _a2: 1, _b2: 2 }; // ok
-          ~~~~~~~~~~~~
-!!! error TS6198: All destructured elements are unused.
 
     // Functions
     function unusedFunc() { } // error
              ~~~~~~~~~~
 !!! error TS6133: 'unusedFunc' is declared but its value is never read.
     function _unusedFunc() { } // ok
-             ~~~~~~~~~~~
-!!! error TS6133: '_unusedFunc' is declared but its value is never read.
 
     const unusedArrow = () => { }; // error
           ~~~~~~~~~~~
 !!! error TS6133: 'unusedArrow' is declared but its value is never read.
     const _unusedArrow = () => { }; // ok
-          ~~~~~~~~~~~~
-!!! error TS6133: '_unusedArrow' is declared but its value is never read.
 
     // Classes
     class UnusedClass { } // error
           ~~~~~~~~~~~
 !!! error TS6196: 'UnusedClass' is declared but never used.
     class _UnusedClass { } // ok
-          ~~~~~~~~~~~~
-!!! error TS6196: '_UnusedClass' is declared but never used.
 
     // Interfaces
     interface UnusedInterface { } // error
               ~~~~~~~~~~~~~~~
 !!! error TS6196: 'UnusedInterface' is declared but never used.
     interface _UnusedInterface { } // ok
-              ~~~~~~~~~~~~~~~~
-!!! error TS6196: '_UnusedInterface' is declared but never used.
 
     // Type aliases
     type UnusedType = string; // error
          ~~~~~~~~~~
 !!! error TS6196: 'UnusedType' is declared but never used.
     type _UnusedType = string; // ok
-         ~~~~~~~~~~~
-!!! error TS6196: '_UnusedType' is declared but never used.
 
     // Enums
     enum UnusedEnum { A } // error
          ~~~~~~~~~~
 !!! error TS6196: 'UnusedEnum' is declared but never used.
     enum _UnusedEnum { A } // ok
-         ~~~~~~~~~~~
-!!! error TS6196: '_UnusedEnum' is declared but never used.
 
     // Declarations in for loops
     for (const _x of []) { } // ok
@@ -128,8 +97,6 @@ unusedLocalsStartingWithUnderscore.ts(79,7): error TS6133: 'obj' is declared but
         export const x = 1;
     }
     namespace _UnusedNamespace { // ok
-              ~~~~~~~~~~~~~~~~
-!!! error TS6133: '_UnusedNamespace' is declared but its value is never read.
         export const x = 1;
     }
 

tests/baselines/reference/unusedParametersWithUnderscore.errors.txt

@@ -2,9 +2,9 @@ unusedParametersWithUnderscore.ts(1,12): error TS6133: 'a' is declared but its v
 unusedParametersWithUnderscore.ts(1,19): error TS6133: 'c' is declared but its value is never read.
 unusedParametersWithUnderscore.ts(1,27): error TS6133: 'd' is declared but its value is never read.
 unusedParametersWithUnderscore.ts(1,29): error TS6133: 'e___' is declared but its value is never read.
-unusedParametersWithUnderscore.ts(5,13): error TS6198: All destructured elements are unused.
-unusedParametersWithUnderscore.ts(11,16): error TS6133: 'arg' is declared but its value is never read.
-unusedParametersWithUnderscore.ts(17,13): error TS6133: 'arg' is declared but its value is never read.
+unusedParametersWithUnderscore.ts(9,14): error TS6198: All destructured elements are unused.
+unusedParametersWithUnderscore.ts(15,16): error TS6133: 'arg' is declared but its value is never read.
+unusedParametersWithUnderscore.ts(21,13): error TS6133: 'arg' is declared but its value is never read.
 
 
 ==== unusedParametersWithUnderscore.ts (7 errors) ====
@@ -19,9 +19,13 @@ unusedParametersWithUnderscore.ts(17,13): error TS6133: 'arg' is declared but it
 !!! error TS6133: 'e___' is declared but its value is never read.
     }
 
-    
+    // ok because of underscore prefix
     function f2({_a, __b}) {
-                ~~~~~~~~~
+    }
+    
+    // error
+    function f2b({ a, b }) {
+                 ~~~~~~~~
 !!! error TS6198: All destructured elements are unused.
     }
 

tests/baselines/reference/unusedParametersWithUnderscore.js

@@ -4,10 +4,14 @@
 function f(a, _b, c, ___, d,e___, _f) {
 }
 
-
+// ok because of underscore prefix
 function f2({_a, __b}) {
 }
 
+// error
+function f2b({ a, b }) {
+}
+
 function f3([_a, ,__b]) {
 }
 
@@ -27,9 +31,14 @@ var f8 = function (_) { };
 //// [unusedParametersWithUnderscore.js]
 function f(a, _b, c, ___, d, e___, _f) {
 }
+// ok because of underscore prefix
 function f2(_c) {
     var _a = _c._a, __b = _c.__b;
 }
+// error
+function f2b(_c) {
+    var a = _c.a, b = _c.b;
+}
 function f3(_c) {
     var _a = _c[0], __b = _c[2];
 }

tests/baselines/reference/unusedParametersWithUnderscore.symbols

@@ -12,41 +12,48 @@ function f(a, _b, c, ___, d,e___, _f) {
 >_f : Symbol(_f, Decl(unusedParametersWithUnderscore.ts, 0, 33))
 }
 
-
+// ok because of underscore prefix
 function f2({_a, __b}) {
 >f2 : Symbol(f2, Decl(unusedParametersWithUnderscore.ts, 1, 1))
 >_a : Symbol(_a, Decl(unusedParametersWithUnderscore.ts, 4, 13))
 >__b : Symbol(__b, Decl(unusedParametersWithUnderscore.ts, 4, 16))
 }
 
+// error
+function f2b({ a, b }) {
+>f2b : Symbol(f2b, Decl(unusedParametersWithUnderscore.ts, 5, 1))
+>a : Symbol(a, Decl(unusedParametersWithUnderscore.ts, 8, 14))
+>b : Symbol(b, Decl(unusedParametersWithUnderscore.ts, 8, 17))
+}
+
 function f3([_a, ,__b]) {
->f3 : Symbol(f3, Decl(unusedParametersWithUnderscore.ts, 5, 1))
->_a : Symbol(_a, Decl(unusedParametersWithUnderscore.ts, 7, 13))
->__b : Symbol(__b, Decl(unusedParametersWithUnderscore.ts, 7, 18))
+>f3 : Symbol(f3, Decl(unusedParametersWithUnderscore.ts, 9, 1))
+>_a : Symbol(_a, Decl(unusedParametersWithUnderscore.ts, 11, 13))
+>__b : Symbol(__b, Decl(unusedParametersWithUnderscore.ts, 11, 18))
 }
 
 function f4(...arg) {
->f4 : Symbol(f4, Decl(unusedParametersWithUnderscore.ts, 8, 1))
->arg : Symbol(arg, Decl(unusedParametersWithUnderscore.ts, 10, 12))
+>f4 : Symbol(f4, Decl(unusedParametersWithUnderscore.ts, 12, 1))
+>arg : Symbol(arg, Decl(unusedParametersWithUnderscore.ts, 14, 12))
 }
 
 function f5(..._arg) {
->f5 : Symbol(f5, Decl(unusedParametersWithUnderscore.ts, 11, 1))
->_arg : Symbol(_arg, Decl(unusedParametersWithUnderscore.ts, 13, 12))
+>f5 : Symbol(f5, Decl(unusedParametersWithUnderscore.ts, 15, 1))
+>_arg : Symbol(_arg, Decl(unusedParametersWithUnderscore.ts, 17, 12))
 }
 
 function f6(arg?, _arg?) {
->f6 : Symbol(f6, Decl(unusedParametersWithUnderscore.ts, 14, 1))
->arg : Symbol(arg, Decl(unusedParametersWithUnderscore.ts, 16, 12))
->_arg : Symbol(_arg, Decl(unusedParametersWithUnderscore.ts, 16, 17))
+>f6 : Symbol(f6, Decl(unusedParametersWithUnderscore.ts, 18, 1))
+>arg : Symbol(arg, Decl(unusedParametersWithUnderscore.ts, 20, 12))
+>_arg : Symbol(_arg, Decl(unusedParametersWithUnderscore.ts, 20, 17))
 }
 
 var f7 = _ => undefined;
->f7 : Symbol(f7, Decl(unusedParametersWithUnderscore.ts, 19, 3))
->_ : Symbol(_, Decl(unusedParametersWithUnderscore.ts, 19, 8))
+>f7 : Symbol(f7, Decl(unusedParametersWithUnderscore.ts, 23, 3))
+>_ : Symbol(_, Decl(unusedParametersWithUnderscore.ts, 23, 8))
 >undefined : Symbol(undefined)
 
 var f8 = function (_) { };
->f8 : Symbol(f8, Decl(unusedParametersWithUnderscore.ts, 21, 3))
->_ : Symbol(_, Decl(unusedParametersWithUnderscore.ts, 21, 19))
+>f8 : Symbol(f8, Decl(unusedParametersWithUnderscore.ts, 25, 3))
+>_ : Symbol(_, Decl(unusedParametersWithUnderscore.ts, 25, 19))
 

tests/baselines/reference/unusedParametersWithUnderscore.types

@@ -20,7 +20,7 @@ function f(a, _b, c, ___, d,e___, _f) {
 >   : ^^^
 }
 
-
+// ok because of underscore prefix
 function f2({_a, __b}) {
 >f2 : ({ _a, __b }: { _a: any; __b: any; }) => void
 >   : ^           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -30,6 +30,16 @@ function f2({_a, __b}) {
 >    : ^^^
 }
 
+// error
+function f2b({ a, b }) {
+>f2b : ({ a, b }: { a: any; b: any; }) => void
+>    : ^        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+>a : any
+>  : ^^^
+>b : any
+>  : ^^^
+}
+
 function f3([_a, ,__b]) {
 >f3 : ([_a, , __b]: [any, any, any]) => void
 >   : ^           ^^^^^^^^^^^^^^^^^^^^^^^^^^

tests/baselines/reference/unusedTypeDeclarations.errors.txt

@@ -1,14 +1,11 @@
 unusedTypeDeclarations.ts(1,6): error TS6196: 'T1' is declared but never used.
-unusedTypeDeclarations.ts(2,6): error TS6196: '_T2' is declared but never used.
 
 
-==== unusedTypeDeclarations.ts (2 errors) ====
+==== unusedTypeDeclarations.ts (1 errors) ====
     type T1 = number;  // error
          ~~
 !!! error TS6196: 'T1' is declared but never used.
     type _T2 = number; // ok
-         ~~~
-!!! error TS6196: '_T2' is declared but never used.
 
     export {};
 

tests/baselines/reference/unusedVariablesWithUnderscoreInBindingElement.errors.txt

@@ -132,10 +132,13 @@ unusedVariablesWithUnderscoreInBindingElement.ts(81,11): error TS6198: All destr
 
     function t7() {
         // error
-        const { _a1, _b1 } = { _a1: 1, _b1: 1 };
-              ~~~~~~~~~~~~
+        const { a0, b0 } = { a0: 1, b0: 1 };
+              ~~~~~~~~~~
 !!! error TS6198: All destructured elements are unused.
 
+        // ok 
+        const { _a1, _b1 } = { _a1: 1, _b1: 1 };
+    
         // ok
         const { a2: _a2, b2: _b2 } = { a2: 1, b2: 1 };
 

tests/baselines/reference/unusedVariablesWithUnderscoreInBindingElement.js

@@ -81,6 +81,9 @@ function t6() {
 
 function t7() {
     // error
+    const { a0, b0 } = { a0: 1, b0: 1 };
+
+    // ok 
     const { _a1, _b1 } = { _a1: 1, _b1: 1 };
 
     // ok
@@ -130,9 +133,11 @@ function t6() {
 }
 function t7() {
     // error
-    var _a = { _a1: 1, _b1: 1 }, _a1 = _a._a1, _b1 = _a._b1;
+    var _a = { a0: 1, b0: 1 }, a0 = _a.a0, b0 = _a.b0;
+    // ok 
+    var _b = { _a1: 1, _b1: 1 }, _a1 = _b._a1, _b1 = _b._b1;
     // ok
-    var _b = { a2: 1, b2: 1 }, _a2 = _b.a2, _b2 = _b.b2;
+    var _c = { a2: 1, b2: 1 }, _a2 = _c.a2, _b2 = _c.b2;
     // ok
-    var _c = { _a3: 1, _b3: 1 }, _ignoreA3 = _c._a3, _ignoreB3 = _c._b3;
+    var _d = { _a3: 1, _b3: 1 }, _ignoreA3 = _d._a3, _ignoreB3 = _d._b3;
 }