Enforce alignment of JSDoc comments
This CL adds the eslint-plugin-jsdoc plugin and enables just one rule,
`jsdoc/check-alignment`, which ensures that all the lines in a comment
are correctly aligned. For example:
```
/**
* foo
* bar
*/
```
Would fail the check and be corrected to:
```
/**
* foo
* bar
*/
```
DISABLE_THIRD_PARTY_CHECK=deliberate install + use of
eslint-plugin-jsdoc node_module
Bug: none
Change-Id: I969983cd550653654a334ede3409b8c850467245
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/4110906
Commit-Queue: Andres Olivares <[email protected]>
Reviewed-by: Andres Olivares <[email protected]>
Auto-Submit: Jack Franklin <[email protected]>
Commit-Queue: Jack Franklin <[email protected]>
diff --git a/front_end/panels/network/NetworkLogView.ts b/front_end/panels/network/NetworkLogView.ts
index 9a51c38..e2beac2 100644
--- a/front_end/panels/network/NetworkLogView.ts
+++ b/front_end/panels/network/NetworkLogView.ts
@@ -75,291 +75,291 @@
const UIStrings = {
/**
- *@description Text in Network Log View of the Network panel
- */
+ *@description Text in Network Log View of the Network panel
+ */
invertFilter: 'Invert',
/**
- *@description Tooltip for the 'invert' checkbox in the Network panel.
- */
+ *@description Tooltip for the 'invert' checkbox in the Network panel.
+ */
invertsFilter: 'Inverts the search filter',
/**
- *@description Text in Network Log View of the Network panel
- */
+ *@description Text in Network Log View of the Network panel
+ */
hideDataUrls: 'Hide data URLs',
/**
- *@description Data urlfilter ui element title in Network Log View of the Network panel
- */
+ *@description Data urlfilter ui element title in Network Log View of the Network panel
+ */
hidesDataAndBlobUrls: 'Hides data: and blob: URLs',
/**
- *@description Aria accessible name in Network Log View of the Network panel
- */
+ *@description Aria accessible name in Network Log View of the Network panel
+ */
resourceTypesToInclude: 'Resource types to include',
/**
- *@description Label for a filter in the Network panel
- */
+ *@description Label for a filter in the Network panel
+ */
hasBlockedCookies: 'Has blocked cookies',
/**
- *@description Tooltip for a checkbox in the Network panel. The response to a network request may include a
- * cookie (https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies). Such response cookies can
- * be malformed or otherwise invalid and the browser may choose to ignore or not accept invalid cookies.
- */
+ *@description Tooltip for a checkbox in the Network panel. The response to a network request may include a
+ * cookie (https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies). Such response cookies can
+ * be malformed or otherwise invalid and the browser may choose to ignore or not accept invalid cookies.
+ */
onlyShowRequestsWithBlocked: 'Only show requests with blocked response cookies',
/**
- *@description Label for a filter in the Network panel
- */
+ *@description Label for a filter in the Network panel
+ */
blockedRequests: 'Blocked Requests',
/**
- *@description Tooltip for a filter in the Network panel
- */
+ *@description Tooltip for a filter in the Network panel
+ */
onlyShowBlockedRequests: 'Only show blocked requests',
/**
- *@description Label for a filter in the Network panel
- */
+ *@description Label for a filter in the Network panel
+ */
thirdParty: '3rd-party requests',
/**
- *@description Tooltip for a filter in the Network panel
- */
+ *@description Tooltip for a filter in the Network panel
+ */
onlyShowThirdPartyRequests: 'Shows only requests with origin different from page origin',
/**
- *@description Text that appears when user drag and drop something (for example, a file) in Network Log View of the Network panel
- */
+ *@description Text that appears when user drag and drop something (for example, a file) in Network Log View of the Network panel
+ */
dropHarFilesHere: 'Drop HAR files here',
/**
- *@description Recording text text content in Network Log View of the Network panel
- */
+ *@description Recording text text content in Network Log View of the Network panel
+ */
recordingNetworkActivity: 'Recording network activity…',
/**
- *@description Text in Network Log View of the Network panel
- *@example {Ctrl + R} PH1
- */
+ *@description Text in Network Log View of the Network panel
+ *@example {Ctrl + R} PH1
+ */
performARequestOrHitSToRecordThe: 'Perform a request or hit {PH1} to record the reload.',
/**
- *@description Shown in the Network Log View of the Network panel when the user has not yet
- * recorded any network activity. This is an instruction to the user to start recording in order to
- * show network activity in the current UI.
- *@example {Ctrl + E} PH1
- */
+ *@description Shown in the Network Log View of the Network panel when the user has not yet
+ * recorded any network activity. This is an instruction to the user to start recording in order to
+ * show network activity in the current UI.
+ *@example {Ctrl + E} PH1
+ */
recordToDisplayNetworkActivity: 'Record network log ({PH1}) to display network activity.',
/**
- *@description Text that is usually a hyperlink to more documentation
- */
+ *@description Text that is usually a hyperlink to more documentation
+ */
learnMore: 'Learn more',
/**
- *@description Text to announce to screen readers that network data is available.
- */
+ *@description Text to announce to screen readers that network data is available.
+ */
networkDataAvailable: 'Network Data Available',
/**
- *@description Text in Network Log View of the Network panel
- *@example {3} PH1
- *@example {5} PH2
- */
+ *@description Text in Network Log View of the Network panel
+ *@example {3} PH1
+ *@example {5} PH2
+ */
sSRequests: '{PH1} / {PH2} requests',
/**
- *@description Message in the summary toolbar at the bottom of the Network log that shows the compressed size of the
- * resources transferred during a selected time frame over the compressed size of all resources transferred during
- * the whole network log.
- *@example {5 B} PH1
- *@example {10 B} PH2
- */
+ *@description Message in the summary toolbar at the bottom of the Network log that shows the compressed size of the
+ * resources transferred during a selected time frame over the compressed size of all resources transferred during
+ * the whole network log.
+ *@example {5 B} PH1
+ *@example {10 B} PH2
+ */
sSTransferred: '{PH1} / {PH2} transferred',
/**
- *@description Message in a tooltip that shows the compressed size of the resources transferred during a selected
- * time frame over the compressed size of all resources transferred during the whole network log.
- *@example {10} PH1
- *@example {15} PH2
- */
+ *@description Message in a tooltip that shows the compressed size of the resources transferred during a selected
+ * time frame over the compressed size of all resources transferred during the whole network log.
+ *@example {10} PH1
+ *@example {15} PH2
+ */
sBSBTransferredOverNetwork: '{PH1} B / {PH2} B transferred over network',
/**
- * @description Text in Network Log View of the Network panel. Appears when a particular network
- * resource is selected by the user. Shows how large the selected resource was (PH1) out of the
- * total size (PH2).
- * @example {40MB} PH1
- * @example {50MB} PH2
- */
+ * @description Text in Network Log View of the Network panel. Appears when a particular network
+ * resource is selected by the user. Shows how large the selected resource was (PH1) out of the
+ * total size (PH2).
+ * @example {40MB} PH1
+ * @example {50MB} PH2
+ */
sSResources: '{PH1} / {PH2} resources',
/**
- *@description Text in Network Log View of the Network panel
- *@example {40} PH1
- *@example {50} PH2
- */
+ *@description Text in Network Log View of the Network panel
+ *@example {40} PH1
+ *@example {50} PH2
+ */
sBSBResourcesLoadedByThePage: '{PH1} B / {PH2} B resources loaded by the page',
/**
- *@description Text in Network Log View of the Network panel
- *@example {6} PH1
- */
+ *@description Text in Network Log View of the Network panel
+ *@example {6} PH1
+ */
sRequests: '{PH1} requests',
/**
- *@description Message in the summary toolbar at the bottom of the Network log that shows the compressed size of
- * all resources transferred over network during a network activity log.
- *@example {4 B} PH1
- */
+ *@description Message in the summary toolbar at the bottom of the Network log that shows the compressed size of
+ * all resources transferred over network during a network activity log.
+ *@example {4 B} PH1
+ */
sTransferred: '{PH1} transferred',
/**
- *@description Message in a tooltip that shows the compressed size of all resources transferred over network during
- * a network activity log.
- *@example {4} PH1
- */
+ *@description Message in a tooltip that shows the compressed size of all resources transferred over network during
+ * a network activity log.
+ *@example {4} PH1
+ */
sBTransferredOverNetwork: '{PH1} B transferred over network',
/**
- *@description Text in Network Log View of the Network panel
- *@example {4} PH1
- */
+ *@description Text in Network Log View of the Network panel
+ *@example {4} PH1
+ */
sResources: '{PH1} resources',
/**
- *@description Text in Network Log View of the Network panel
- *@example {10} PH1
- */
+ *@description Text in Network Log View of the Network panel
+ *@example {10} PH1
+ */
sBResourcesLoadedByThePage: '{PH1} B resources loaded by the page',
/**
- *@description Text in Network Log View of the Network panel
- *@example {120ms} PH1
- */
+ *@description Text in Network Log View of the Network panel
+ *@example {120ms} PH1
+ */
finishS: 'Finish: {PH1}',
/**
- *@description Text in Network Log View of the Network panel
- *@example {3000ms} PH1
- */
+ *@description Text in Network Log View of the Network panel
+ *@example {3000ms} PH1
+ */
domcontentloadedS: 'DOMContentLoaded: {PH1}',
/**
- *@description Text in Network Log View of the Network panel
- *@example {40ms} PH1
- */
+ *@description Text in Network Log View of the Network panel
+ *@example {40ms} PH1
+ */
loadS: 'Load: {PH1}',
/**
- *@description Text for copying
- */
+ *@description Text for copying
+ */
copy: 'Copy',
/**
- *@description Text in Network Log View of the Network panel
- */
+ *@description Text in Network Log View of the Network panel
+ */
copyRequestHeaders: 'Copy request headers',
/**
- *@description Text in Network Log View of the Network panel
- */
+ *@description Text in Network Log View of the Network panel
+ */
copyResponseHeaders: 'Copy response headers',
/**
- *@description Text in Network Log View of the Network panel
- */
+ *@description Text in Network Log View of the Network panel
+ */
copyResponse: 'Copy response',
/**
- *@description Text in Network Log View of the Network panel
- */
+ *@description Text in Network Log View of the Network panel
+ */
copyStacktrace: 'Copy stack trace',
/**
- * @description A context menu command in the Network panel, for copying to the clipboard.
- * PowerShell refers to the format the data will be copied as.
- */
+ * @description A context menu command in the Network panel, for copying to the clipboard.
+ * PowerShell refers to the format the data will be copied as.
+ */
copyAsPowershell: 'Copy as `PowerShell`',
/**
- *@description A context menu command in the Network panel, for copying to the clipboard. 'fetch'
- * refers to the format the data will be copied as, which is compatible with the fetch web API.
- */
+ *@description A context menu command in the Network panel, for copying to the clipboard. 'fetch'
+ * refers to the format the data will be copied as, which is compatible with the fetch web API.
+ */
copyAsFetch: 'Copy as `fetch`',
/**
- * @description Text in Network Log View of the Network panel. An action that copies a command to
- * the developer's clipboard. The command allows the developer to replay this specific network
- * request in Node.js, a desktop application/framework. 'Node.js fetch' is a noun phrase for the
- * type of request that will be copied.
- */
+ * @description Text in Network Log View of the Network panel. An action that copies a command to
+ * the developer's clipboard. The command allows the developer to replay this specific network
+ * request in Node.js, a desktop application/framework. 'Node.js fetch' is a noun phrase for the
+ * type of request that will be copied.
+ */
copyAsNodejsFetch: 'Copy as `Node.js` `fetch`',
/**
- *@description Text in Network Log View of the Network panel. An action that copies a command to
- *the clipboard. It will copy the command in the format compatible with cURL (a program, not
- *translatable).
- */
+ *@description Text in Network Log View of the Network panel. An action that copies a command to
+ *the clipboard. It will copy the command in the format compatible with cURL (a program, not
+ *translatable).
+ */
copyAsCurlCmd: 'Copy as `cURL` (`cmd`)',
/**
- *@description Text in Network Log View of the Network panel. An action that copies a command to
- *the clipboard. It will copy the command in the format compatible with a Bash script.
- */
+ *@description Text in Network Log View of the Network panel. An action that copies a command to
+ *the clipboard. It will copy the command in the format compatible with a Bash script.
+ */
copyAsCurlBash: 'Copy as `cURL` (`bash`)',
/**
- *@description Text in Network Log View of the Network panel. An action that copies a command to
- *the clipboard. It will copy the command in the format compatible with a PowerShell script.
- */
+ *@description Text in Network Log View of the Network panel. An action that copies a command to
+ *the clipboard. It will copy the command in the format compatible with a PowerShell script.
+ */
copyAllAsPowershell: 'Copy all as `PowerShell`',
/**
- *@description Text in Network Log View of the Network panel. An action that copies a command to
- *the clipboard. It will copy the command in the format compatible with a 'fetch' command (fetch
- *should not be translated).
- */
+ *@description Text in Network Log View of the Network panel. An action that copies a command to
+ *the clipboard. It will copy the command in the format compatible with a 'fetch' command (fetch
+ *should not be translated).
+ */
copyAllAsFetch: 'Copy all as `fetch`',
/**
- *@description Text in Network Log View of the Network panel. An action that copies a command to
- *the clipboard. It will copy the command in the format compatible with a Node.js 'fetch' command
- *(fetch and Node.js should not be translated).
- */
+ *@description Text in Network Log View of the Network panel. An action that copies a command to
+ *the clipboard. It will copy the command in the format compatible with a Node.js 'fetch' command
+ *(fetch and Node.js should not be translated).
+ */
copyAllAsNodejsFetch: 'Copy all as `Node.js` `fetch`',
/**
- *@description Text in Network Log View of the Network panel. An action that copies a command to
- *the clipboard. It will copy the command in the format compatible with cURL (a program, not
- *translatable).
- */
+ *@description Text in Network Log View of the Network panel. An action that copies a command to
+ *the clipboard. It will copy the command in the format compatible with cURL (a program, not
+ *translatable).
+ */
copyAllAsCurlCmd: 'Copy all as `cURL` (`cmd`)',
/**
- *@description Text in Network Log View of the Network panel. An action that copies a command to
- *the clipboard. It will copy the command in the format compatible with a Bash script.
- */
+ *@description Text in Network Log View of the Network panel. An action that copies a command to
+ *the clipboard. It will copy the command in the format compatible with a Bash script.
+ */
copyAllAsCurlBash: 'Copy all as `cURL` (`bash`)',
/**
- *@description Text in Network Log View of the Network panel. An action that copies a command to
- *the clipboard. It will copy the command in the format compatible with cURL (a program, not
- *translatable).
- */
+ *@description Text in Network Log View of the Network panel. An action that copies a command to
+ *the clipboard. It will copy the command in the format compatible with cURL (a program, not
+ *translatable).
+ */
copyAsCurl: 'Copy as `cURL`',
/**
- *@description Text in Network Log View of the Network panel. An action that copies a command to
- *the clipboard. It will copy the command in the format compatible with cURL (a program, not
- *translatable).
- */
+ *@description Text in Network Log View of the Network panel. An action that copies a command to
+ *the clipboard. It will copy the command in the format compatible with cURL (a program, not
+ *translatable).
+ */
copyAllAsCurl: 'Copy all as `cURL`',
/**
- * @description Text in Network Log View of the Network panel. An action that copies data to the
- * clipboard. It will copy the data in the HAR (not translatable) format. 'all' refers to every
- * network request that is currently shown.
- */
+ * @description Text in Network Log View of the Network panel. An action that copies data to the
+ * clipboard. It will copy the data in the HAR (not translatable) format. 'all' refers to every
+ * network request that is currently shown.
+ */
copyAllAsHar: 'Copy all as `HAR`',
/**
- *@description A context menu item in the Network Log View of the Network panel
- */
+ *@description A context menu item in the Network Log View of the Network panel
+ */
saveAllAsHarWithContent: 'Save all as `HAR` with content',
/**
- *@description A context menu item in the Network Log View of the Network panel
- */
+ *@description A context menu item in the Network Log View of the Network panel
+ */
clearBrowserCache: 'Clear browser cache',
/**
- *@description A context menu item in the Network Log View of the Network panel
- */
+ *@description A context menu item in the Network Log View of the Network panel
+ */
clearBrowserCookies: 'Clear browser cookies',
/**
- *@description A context menu item in the Network Log View of the Network panel
- */
+ *@description A context menu item in the Network Log View of the Network panel
+ */
blockRequestUrl: 'Block request URL',
/**
- *@description A context menu item in the Network Log View of the Network panel
- *@example {example.com} PH1
- */
+ *@description A context menu item in the Network Log View of the Network panel
+ *@example {example.com} PH1
+ */
unblockS: 'Unblock {PH1}',
/**
- *@description A context menu item in the Network Log View of the Network panel
- */
+ *@description A context menu item in the Network Log View of the Network panel
+ */
blockRequestDomain: 'Block request domain',
/**
- *@description Text to replay an XHR request
- */
+ *@description Text to replay an XHR request
+ */
replayXhr: 'Replay XHR',
/**
- *@description Text in Network Log View of the Network panel
- */
+ *@description Text in Network Log View of the Network panel
+ */
areYouSureYouWantToClearBrowser: 'Are you sure you want to clear browser cache?',
/**
- *@description Text in Network Log View of the Network panel
- */
+ *@description Text in Network Log View of the Network panel
+ */
areYouSureYouWantToClearBrowserCookies: 'Are you sure you want to clear browser cookies?',
/**
- *@description A context menu item in the Network Log View of the Network panel
- * for creating a header override
- */
+ *@description A context menu item in the Network Log View of the Network panel
+ * for creating a header override
+ */
overrideHeaders: 'Override headers',
};
const str_ = i18n.i18n.registerUIStrings('panels/network/NetworkLogView.ts', UIStrings);
