Skip to content

Commit 7f25c1b

Browse files
committed
JS: address doc-review comments
1 parent c70997f commit 7f25c1b

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

change-notes/1.24/analysis-javascript.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
| Regular expression always matches (`js/regex/always-matches`) | correctness, regular-expressions | Highlights regular expression checks that trivially succeed by matching an empty substring. Results are shown on LGTM by default. |
2929
| Missing await (`js/missing-await`) | correctness | Highlights expressions that operate directly on a promise object in a nonsensical way, instead of awaiting its result. Results are shown on LGTM by default. |
3030
| Prototype pollution in utility function (`js/prototype-pollution-utility`) | security, external/cwe/cwe-400, external/cwe/cwe-471 | Highlights recursive copying operations that are susceptible to prototype pollution. Results are shown on LGTM by default. |
31-
| Unsafe jQuery plugin (`js/unsafe-jquery-plugin`) | Highlights potential XSS vulnerabilities in unsafely designed jQuery plugins. |
31+
| Unsafe jQuery plugin (`js/unsafe-jquery-plugin`) | Highlights potential XSS vulnerabilities in unsafely designed jQuery plugins. Results are shown on LGTM by default. |
3232

3333
## Changes to existing queries
3434

javascript/ql/src/Security/CWE-079/UnsafeJQueryPlugin.qhelp

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,14 @@
1010
configurable through options provided by the clients of the
1111
plugin.
1212

13-
Clients, however, do not know the implementation details of the
14-
plugin, so it is important to document the capabilities of each
15-
option. Of particular importance is the documentation for the plugin
16-
options that the client is responsible for sanitizing.
13+
14+
Clients, however, do not know the implementation details
15+
of the plugin, so it is important to document the capabilities of each
16+
option. The documentation for the plugin options that the client is
17+
responsible for sanitizing is of particular importance.
1718

1819
Otherwise, the plugin may write user input (for example, a URL query
19-
parameter) to a web page without properly sanitizing the input first,
20+
parameter) to a web page without properly sanitizing it first,
2021
which allows for a cross-site scripting vulnerability in the client
2122
application through dynamic HTML construction.
2223

@@ -36,8 +37,8 @@
3637
<example>
3738
<p>
3839

39-
The following example shows a jQuery plugin that selects a DOM
40-
element, and copies its text content another DOM element. The
40+
The following example shows a jQuery plugin that selects a
41+
DOM element, and copies its text content to another DOM element. The
4142
selection is performed by using the plugin option
4243
<code>sourceSelector</code> as a CSS selector.
4344

@@ -47,7 +48,7 @@
4748

4849
<p>
4950

50-
This is however not a safe plugin, since the call to
51+
This is, however, not a safe plugin, since the call to
5152
<code>jQuery</code> interprets <code>sourceSelector</code> as HTML if
5253
it is a string that starts with <code>&lt;</code>.
5354

0 commit comments

Comments
 (0)