Skip to content

Commit 5666dea

Browse files
author
Esben Sparre Andreasen
committed
JS: rename js/useless-defensive-code to js/unneeded-defensive-code
1 parent 1db2e6c commit 5666dea

18 files changed

+11
-12
lines changed

‎change-notes/1.19/analysis-javascript.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323
| Replacement of a substring with itself (`js/identity-replacement`) | correctness, security, external/cwe/cwe-116 | Highlights string replacements that replace a string with itself, which usually indicates a mistake. Results shown on LGTM by default. |
2424
| Stored cross-site scripting (`js/stored-xss`) | security, external/cwe/cwe-079, external/cwe/cwe-116 | Highlights uncontrolled stored values flowing into HTML content, indicating a violation of [CWE-079](https://cwe.mitre.org/data/definitions/79.html). Results shown on LGTM by default. |
2525
| Unclear precedence of nested operators (`js/unclear-operator-precedence`) | maintainability, correctness, external/cwe/cwe-783 | Highlights nested binary operators whose relative precedence is easy to misunderstand. Results shown on LGTM by default. |
26+
| Unneeded defensive code | correctness, external/cwe/cwe-570, external/cwe/cwe-571 | Highlights locations where defensive code is not needed. Results are shown on LGTM by default. |
2627
| Useless assignment to property | maintainability | Highlights property assignments whose value is always overwritten. Results are shown on LGTM by default. |
27-
| Useless defensive code | correctness, external/cwe/cwe-570, external/cwe/cwe-571 | Highlights locations where defensive code serves no purpose. Results are shown on LGTM by default. |
2828
| User-controlled data in file | security, external/cwe/cwe-912 | Highlights locations where user-controlled data is written to a file. Results are not shown on LGTM by default. |
2929

3030
## Changes to existing queries

javascript/ql/src/Expressions/UselessDefensiveProgramming.qhelp renamed to javascript/ql/src/Expressions/UnneededDefensiveProgramming.qhelp

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
However, if the situation that some defensive code guards
1616
against never can occur, then the defensive code serves no purpose and
17-
it can safely be removed.
17+
can safely be removed.
1818

1919
</p>
2020

@@ -45,7 +45,7 @@
4545

4646
</p>
4747

48-
<sample src="examples/UselessDefensiveProgramming1_bad.js" />
48+
<sample src="examples/UnneededDefensiveProgramming1_bad.js" />
4949

5050
<p>
5151

@@ -56,7 +56,7 @@
5656

5757
</p>
5858

59-
<sample src="examples/UselessDefensiveProgramming1_good.js" />
59+
<sample src="examples/UnneededDefensiveProgramming1_good.js" />
6060

6161
<p>
6262

@@ -68,19 +68,19 @@
6868

6969
</p>
7070

71-
<sample src="examples/UselessDefensiveProgramming2_bad.js" />
71+
<sample src="examples/UnneededDefensiveProgramming2_bad.js" />
7272

7373
<p>
7474

7575
However, due to coercion rules, <code>v ==
7676
undefined</code> holds for both the situation where <code>v</code>
7777
is<code>undefined</code> and the situation where <code>v</code>
7878
is<code>null</code>, so the <code>v == null</code>
79-
guard serves no purpose, and it can be removed:
79+
guard serves no purpose, and can be removed:
8080

8181
</p>
8282

83-
<sample src="examples/UselessDefensiveProgramming2_good.js" />
83+
<sample src="examples/UnneededDefensiveProgramming2_good.js" />
8484

8585
</example>
8686
<references>

javascript/ql/src/Expressions/UselessDefensiveProgramming.ql renamed to javascript/ql/src/Expressions/UnneededDefensiveProgramming.ql

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
/**
2-
* @name Useless defensive code
3-
* @description If the situation some defensive code guards against never
4-
* happens, then the defensive code is not needed.
2+
* @name Unneeded defensive code
3+
* @description Defensive code that guards against a situation that never happens is not needed.
54
* @kind problem
65
* @problem.severity recommendation
7-
* @id js/useless-defensive-code
6+
* @id js/unneeded-defensive-code
87
* @tags correctness
98
* external/cwe/cwe-570
109
* external/cwe/cwe-571

javascript/ql/src/Expressions/examples/UselessDefensiveProgramming1_bad.js renamed to javascript/ql/src/Expressions/examples/UnneededDefensiveProgramming1_bad.js

File renamed without changes.

javascript/ql/src/Expressions/examples/UselessDefensiveProgramming1_good.js renamed to javascript/ql/src/Expressions/examples/UnneededDefensiveProgramming1_good.js

File renamed without changes.

javascript/ql/src/Expressions/examples/UselessDefensiveProgramming2_bad.js renamed to javascript/ql/src/Expressions/examples/UnneededDefensiveProgramming2_bad.js

File renamed without changes.

javascript/ql/src/Expressions/examples/UselessDefensiveProgramming2_good.js renamed to javascript/ql/src/Expressions/examples/UnneededDefensiveProgramming2_good.js

File renamed without changes.

javascript/ql/test/query-tests/Expressions/UselessDefensiveProgramming/HeterogeneousComparison.expected renamed to javascript/ql/test/query-tests/Expressions/UnneededDefensiveProgramming/HeterogeneousComparison.expected

File renamed without changes.

javascript/ql/test/query-tests/Expressions/UselessDefensiveProgramming/HeterogeneousComparison.qlref renamed to javascript/ql/test/query-tests/Expressions/UnneededDefensiveProgramming/HeterogeneousComparison.qlref

File renamed without changes.

javascript/ql/test/query-tests/Expressions/UselessDefensiveProgramming/UselessDefensiveProgramming.expected renamed to javascript/ql/test/query-tests/Expressions/UnneededDefensiveProgramming/UnneededDefensiveProgramming.expected

File renamed without changes.

0 commit comments

Comments
 (0)