lint: disallow console.log and similar #5087
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jpinkney-aws
approved these changes
May 31, 2024
justinmk3
reviewed
Jun 6, 2024
| @@ -3,8 +3,10 @@ | |||
| * SPDX-License-Identifier: Apache-2.0 | |||
| */ | |||
|
|
|||
| // Disable because this is the main logger file. | |||
| /* eslint-disable aws-toolkits/no-console-log */ | |||
There was a problem hiding this comment.
can we put this in the ConsoleLogger scope? shouldn't be needed for the rest of this file.
justinmk3
reviewed
Jun 6, 2024
| @@ -686,6 +686,8 @@ class ProcessTerminal implements vscode.Pseudoterminal { | |||
| public constructor(private readonly process: ChildProcess) { | |||
| // Used in integration tests | |||
| if (isAutomation()) { | |||
| // Disable because it is a test. | |||
| // eslint-disable-next-line aws-toolkits/no-console-log | |||
| this.onDidWrite(text => console.log(text.trim())) | |||
There was a problem hiding this comment.
This is fine for specific, intentionally cases. But it's good to have the rule generally enabled for tests.
justinmk3
reviewed
Jun 6, 2024
| @@ -187,6 +187,8 @@ export class WebviewClientFactory { | |||
| }, | |||
| get: (_, prop) => { | |||
| if (typeof prop !== 'string') { | |||
| // Disable because we cannot log to extension in a webview. | |||
| // eslint-disable-next-line aws-toolkits/no-console-log | |||
| console.warn(`Tried to index webview client with non-string property: ${String(prop)}`) | |||
There was a problem hiding this comment.
Can we forward logs to the backend? Do we have a webview base class that could have a log() function?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
vscodeand nothing else. This is done by moving perfLogger to its own file.License
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.