Skip to content

Allowed unused parameters before used ones #12139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed

Allowed unused parameters before used ones #12139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
20de26b
Reverted allowing _-prefixed unused parameters
Nov 10, 2016
5ab9405
Changed unused param checking to rely on order
Nov 10, 2016
63f8884
Added _-prefixed unused parameter allowance back
Nov 10, 2016
da90201
Added tests for unused parameters with underscore
Nov 10, 2016
1e6d518
Added tests for unused parameter ordering
Nov 10, 2016
ac8b814
Stopped created unusedParameterLocals by default
Nov 10, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 47 additions & 14 deletions src/compiler/checker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15958,24 +15958,57 @@ namespace ts {

function checkUnusedLocalsAndParameters(node: Node): void {
if (node.parent.kind !== SyntaxKind.InterfaceDeclaration && noUnusedIdentifiers && !isInAmbientContext(node)) {
for (const key in node.locals) {
const local = node.locals[key];
if (!local.isReferenced) {
if (local.valueDeclaration && getRootDeclaration(local.valueDeclaration).kind === SyntaxKind.Parameter) {
const parameter = <ParameterDeclaration>getRootDeclaration(local.valueDeclaration);
if (compilerOptions.noUnusedParameters &&
!isParameterPropertyDeclaration(parameter) &&
!parameterIsThisKeyword(parameter) &&
!parameterNameStartsWithUnderscore(local.valueDeclaration.name)) {
error(local.valueDeclaration.name, Diagnostics._0_is_declared_but_never_used, local.name);
}
}
else if (compilerOptions.noUnusedLocals) {
forEach(local.declarations, d => errorUnusedLocal(d.name || d, local.name));
if (compilerOptions.noUnusedParameters) {
checkUnusedParameterLocals(node.locals);
}

if (compilerOptions.noUnusedLocals) {
checkUnusedLocals(node.locals);
}
}
}

function checkUnusedParameterLocals(locals: Map<Symbol>): void {
let unusedParameterLocals: Symbol[] | undefined;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From a performance perspective I was hesitant to make a new [] no matter what. Hence the slight added complexity.


for (const key in locals) {
const local = locals[key];
if (!isLocalParameter(local)) {
continue;
}

const parameter = <ParameterDeclaration>getRootDeclaration(local.valueDeclaration);
if (!isParameterPropertyDeclaration(parameter) && !parameterIsThisKeyword(parameter)) {
if (local.isReferenced || parameterNameStartsWithUnderscore(local.valueDeclaration.name)) {
if (unusedParameterLocals) {
unusedParameterLocals.length = 0;
}
} else if (unusedParameterLocals) {
unusedParameterLocals.push(local);
} else {
unusedParameterLocals = [local];
}
}
}

if (unusedParameterLocals) {
forEach(unusedParameterLocals, local => error(local.valueDeclaration.name, Diagnostics._0_is_declared_but_never_used, local.name));
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should unusedParameterLocals be sorted? Map guarantees iteration in insertion order, but does TS guarantee locals be in inserted order? Do we want to rely on that guarantee?

}
}

function checkUnusedLocals(locals: Map<Symbol>): void {
for (const key in locals) {
const local = locals[key];
if (local.isReferenced || isLocalParameter(local)) {
continue;
}

forEach(local.declarations, d => errorUnusedLocal(d.name || d, local.name));
}
}

function isLocalParameter(local: Symbol): boolean {
return local.valueDeclaration && getRootDeclaration(local.valueDeclaration).kind === SyntaxKind.Parameter;
}

function errorUnusedLocal(node: Node, name: string) {
Expand Down
8 changes: 4 additions & 4 deletions ...aselines/reference/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration1.errors.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration1.ts(2,18): error TS6133: 'person' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration1.ts(2,51): error TS6133: 'person3' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration1.ts(3,9): error TS6133: 'unused' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration1.ts(4,14): error TS6133: 'maker' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration1.ts(4,20): error TS6133: 'child' is declared but never used.
Expand All @@ -7,9 +7,9 @@ tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration1

==== tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration1.ts (5 errors) ====

function greeter(person: string, person2: string) {
~~~~~~
!!! error TS6133: 'person' is declared but never used.
function greeter(person: string, person2: string, person3: string) {
~~~~~~~
!!! error TS6133: 'person3' is declared but never used.
var unused = 20;
~~~~~~
!!! error TS6133: 'unused' is declared but never used.
Expand Down
4 changes: 2 additions & 2 deletions tests/baselines/reference/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration1.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//// [unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration1.ts]

function greeter(person: string, person2: string) {
function greeter(person: string, person2: string, person3: string) {
var unused = 20;
function maker(child: string): void {
var unused2 = 22;
Expand All @@ -9,7 +9,7 @@ function greeter(person: string, person2: string) {
}

//// [unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration1.js]
function greeter(person, person2) {
function greeter(person, person2, person3) {
var unused = 20;
function maker(child) {
var unused2 = 22;
Expand Down
8 changes: 4 additions & 4 deletions ...aselines/reference/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration2.errors.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration2.ts(2,18): error TS6133: 'person' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration2.ts(2,51): error TS6133: 'person3' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration2.ts(3,9): error TS6133: 'unused' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration2.ts(4,14): error TS6133: 'maker' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration2.ts(4,20): error TS6133: 'child' is declared but never used.
Expand All @@ -9,9 +9,9 @@ tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration2

==== tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration2.ts (7 errors) ====

function greeter(person: string, person2: string) {
~~~~~~
!!! error TS6133: 'person' is declared but never used.
function greeter(person: string, person2: string, person3: string) {
~~~~~~~
!!! error TS6133: 'person3' is declared but never used.
var unused = 20;
~~~~~~
!!! error TS6133: 'unused' is declared but never used.
Expand Down
4 changes: 2 additions & 2 deletions tests/baselines/reference/unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration2.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//// [unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration2.ts]

function greeter(person: string, person2: string) {
function greeter(person: string, person2: string, person3: string) {
var unused = 20;
function maker(child: string): void {
var unused2 = 22;
Expand All @@ -12,7 +12,7 @@ function greeter(person: string, person2: string) {
}

//// [unusedLocalsOnFunctionDeclarationWithinFunctionDeclaration2.js]
function greeter(person, person2) {
function greeter(person, person2, person3) {
var unused = 20;
function maker(child) {
var unused2 = 22;
Expand Down
8 changes: 4 additions & 4 deletions ...baselines/reference/unusedLocalsOnFunctionDeclarationWithinFunctionExpression1.errors.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionExpression1.ts(2,25): error TS6133: 'person' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionExpression1.ts(2,58): error TS6133: 'person3' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionExpression1.ts(3,9): error TS6133: 'unused' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionExpression1.ts(4,14): error TS6133: 'maker' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionExpression1.ts(4,20): error TS6133: 'child' is declared but never used.
Expand All @@ -7,9 +7,9 @@ tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionExpression1.

==== tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionExpression1.ts (5 errors) ====

var greeter = function (person: string, person2: string) {
~~~~~~
!!! error TS6133: 'person' is declared but never used.
var greeter = function (person: string, person2: string, person3: string) {
~~~~~~~
!!! error TS6133: 'person3' is declared but never used.
var unused = 20;
~~~~~~
!!! error TS6133: 'unused' is declared but never used.
Expand Down
4 changes: 2 additions & 2 deletions tests/baselines/reference/unusedLocalsOnFunctionDeclarationWithinFunctionExpression1.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//// [unusedLocalsOnFunctionDeclarationWithinFunctionExpression1.ts]

var greeter = function (person: string, person2: string) {
var greeter = function (person: string, person2: string, person3: string) {
var unused = 20;
function maker(child: string): void {
var unused2 = 22;
Expand All @@ -9,7 +9,7 @@ var greeter = function (person: string, person2: string) {
}

//// [unusedLocalsOnFunctionDeclarationWithinFunctionExpression1.js]
var greeter = function (person, person2) {
var greeter = function (person, person2, person3) {
var unused = 20;
function maker(child) {
var unused2 = 22;
Expand Down
8 changes: 4 additions & 4 deletions ...baselines/reference/unusedLocalsOnFunctionDeclarationWithinFunctionExpression2.errors.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionExpression2.ts(2,25): error TS6133: 'person' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionExpression2.ts(2,58): error TS6133: 'person3' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionExpression2.ts(3,9): error TS6133: 'unused' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionExpression2.ts(4,14): error TS6133: 'maker' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionExpression2.ts(4,20): error TS6133: 'child' is declared but never used.
Expand All @@ -9,9 +9,9 @@ tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionExpression2.

==== tests/cases/compiler/unusedLocalsOnFunctionDeclarationWithinFunctionExpression2.ts (7 errors) ====

var greeter = function (person: string, person2: string) {
~~~~~~
!!! error TS6133: 'person' is declared but never used.
var greeter = function (person: string, person2: string, person3: string) {
~~~~~~~
!!! error TS6133: 'person3' is declared but never used.
var unused = 20;
~~~~~~
!!! error TS6133: 'unused' is declared but never used.
Expand Down
4 changes: 2 additions & 2 deletions tests/baselines/reference/unusedLocalsOnFunctionDeclarationWithinFunctionExpression2.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//// [unusedLocalsOnFunctionDeclarationWithinFunctionExpression2.ts]

var greeter = function (person: string, person2: string) {
var greeter = function (person: string, person2: string, person3: string) {
var unused = 20;
function maker(child: string): void {
var unused2 = 22;
Expand All @@ -12,7 +12,7 @@ var greeter = function (person: string, person2: string) {
}

//// [unusedLocalsOnFunctionDeclarationWithinFunctionExpression2.js]
var greeter = function (person, person2) {
var greeter = function (person, person2, person3) {
var unused = 20;
function maker(child) {
var unused2 = 22;
Expand Down
8 changes: 4 additions & 4 deletions ...baselines/reference/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration1.errors.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration1.ts(2,18): error TS6133: 'person' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration1.ts(2,51): error TS6133: 'person3' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration1.ts(3,9): error TS6133: 'unused' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration1.ts(4,9): error TS6133: 'maker' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration1.ts(4,27): error TS6133: 'child' is declared but never used.
Expand All @@ -7,9 +7,9 @@ tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration1.

==== tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration1.ts (5 errors) ====

function greeter(person: string, person2: string) {
~~~~~~
!!! error TS6133: 'person' is declared but never used.
function greeter(person: string, person2: string, person3: string) {
~~~~~~~
!!! error TS6133: 'person3' is declared but never used.
var unused = 20;
~~~~~~
!!! error TS6133: 'unused' is declared but never used.
Expand Down
4 changes: 2 additions & 2 deletions tests/baselines/reference/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration1.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//// [unusedLocalsOnFunctionExpressionWithinFunctionDeclaration1.ts]

function greeter(person: string, person2: string) {
function greeter(person: string, person2: string, person3: string) {
var unused = 20;
var maker = function (child: string): void {
var unused2 = 22;
Expand All @@ -9,7 +9,7 @@ function greeter(person: string, person2: string) {
}

//// [unusedLocalsOnFunctionExpressionWithinFunctionDeclaration1.js]
function greeter(person, person2) {
function greeter(person, person2, person3) {
var unused = 20;
var maker = function (child) {
var unused2 = 22;
Expand Down
8 changes: 4 additions & 4 deletions ...baselines/reference/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration2.errors.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration2.ts(2,18): error TS6133: 'person' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration2.ts(2,51): error TS6133: 'person3' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration2.ts(3,9): error TS6133: 'unused' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration2.ts(4,9): error TS6133: 'maker' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration2.ts(4,26): error TS6133: 'child' is declared but never used.
Expand All @@ -9,9 +9,9 @@ tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration2.

==== tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration2.ts (7 errors) ====

function greeter(person: string, person2: string) {
~~~~~~
!!! error TS6133: 'person' is declared but never used.
function greeter(person: string, person2: string, person3: string) {
~~~~~~~
!!! error TS6133: 'person3' is declared but never used.
var unused = 20;
~~~~~~
!!! error TS6133: 'unused' is declared but never used.
Expand Down
4 changes: 2 additions & 2 deletions tests/baselines/reference/unusedLocalsOnFunctionExpressionWithinFunctionDeclaration2.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//// [unusedLocalsOnFunctionExpressionWithinFunctionDeclaration2.ts]

function greeter(person: string, person2: string) {
function greeter(person: string, person2: string, person3: string) {
var unused = 20;
var maker = function(child: string): void {
var unused2 = 22;
Expand All @@ -12,7 +12,7 @@ function greeter(person: string, person2: string) {
}

//// [unusedLocalsOnFunctionExpressionWithinFunctionDeclaration2.js]
function greeter(person, person2) {
function greeter(person, person2, person3) {
var unused = 20;
var maker = function (child) {
var unused2 = 22;
Expand Down
8 changes: 4 additions & 4 deletions .../baselines/reference/unusedLocalsOnFunctionExpressionWithinFunctionExpression1.errors.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionExpression1.ts(2,25): error TS6133: 'person' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionExpression1.ts(2,58): error TS6133: 'person3' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionExpression1.ts(3,9): error TS6133: 'unused' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionExpression1.ts(4,9): error TS6133: 'maker' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionExpression1.ts(4,27): error TS6133: 'child' is declared but never used.
Expand All @@ -7,9 +7,9 @@ tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionExpression1.t

==== tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionExpression1.ts (5 errors) ====

var greeter = function (person: string, person2: string) {
~~~~~~
!!! error TS6133: 'person' is declared but never used.
var greeter = function (person: string, person2: string, person3: string) {
~~~~~~~
!!! error TS6133: 'person3' is declared but never used.
var unused = 20;
~~~~~~
!!! error TS6133: 'unused' is declared but never used.
Expand Down
4 changes: 2 additions & 2 deletions tests/baselines/reference/unusedLocalsOnFunctionExpressionWithinFunctionExpression1.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//// [unusedLocalsOnFunctionExpressionWithinFunctionExpression1.ts]

var greeter = function (person: string, person2: string) {
var greeter = function (person: string, person2: string, person3: string) {
var unused = 20;
var maker = function (child: string): void {
var unused2 = 22;
Expand All @@ -9,7 +9,7 @@ var greeter = function (person: string, person2: string) {
}

//// [unusedLocalsOnFunctionExpressionWithinFunctionExpression1.js]
var greeter = function (person, person2) {
var greeter = function (person, person2, person3) {
var unused = 20;
var maker = function (child) {
var unused2 = 22;
Expand Down
8 changes: 4 additions & 4 deletions .../baselines/reference/unusedLocalsOnFunctionExpressionWithinFunctionExpression2.errors.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionExpression2.ts(2,25): error TS6133: 'person' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionExpression2.ts(2,58): error TS6133: 'person3' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionExpression2.ts(3,9): error TS6133: 'unused' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionExpression2.ts(4,9): error TS6133: 'maker' is declared but never used.
tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionExpression2.ts(4,27): error TS6133: 'child' is declared but never used.
Expand All @@ -9,9 +9,9 @@ tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionExpression2.t

==== tests/cases/compiler/unusedLocalsOnFunctionExpressionWithinFunctionExpression2.ts (7 errors) ====

var greeter = function (person: string, person2: string) {
~~~~~~
!!! error TS6133: 'person' is declared but never used.
var greeter = function (person: string, person2: string, person3: string) {
~~~~~~~
!!! error TS6133: 'person3' is declared but never used.
var unused = 20;
~~~~~~
!!! error TS6133: 'unused' is declared but never used.
Expand Down
4 changes: 2 additions & 2 deletions tests/baselines/reference/unusedLocalsOnFunctionExpressionWithinFunctionExpression2.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//// [unusedLocalsOnFunctionExpressionWithinFunctionExpression2.ts]

var greeter = function (person: string, person2: string) {
var greeter = function (person: string, person2: string, person3: string) {
var unused = 20;
var maker = function (child: string): void {
var unused2 = 22;
Expand All @@ -12,7 +12,7 @@ var greeter = function (person: string, person2: string) {
}

//// [unusedLocalsOnFunctionExpressionWithinFunctionExpression2.js]
var greeter = function (person, person2) {
var greeter = function (person, person2, person3) {
var unused = 20;
var maker = function (child) {
var unused2 = 22;
Expand Down
Loading