build(lint): migrate away from forEach (WIP) #6277
Closed
Conversation
This file contains hidden or 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
justinmk3
reviewed
Dec 19, 2024
| 'aws-toolkits/no-console-log': 'error', | ||
| 'aws-toolkits/no-json-stringify-in-log': 'error', | ||
| 'aws-toolkits/no-printf-mismatch': 'error', | ||
| 'aws-toolkits/no-foreach': 'error', |
Contributor
There was a problem hiding this comment.
We depend on eslint-plugin-unicorn so I think we can use this rule: https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-array-for-each.md
in .eslintrc.js where we enable the rule, let's put a comment like:
// Discourage `.forEach` because it can lead to accidental, incorrect use of async callbacks.
Contributor
Author
There was a problem hiding this comment.
Good idea! That rule also comes with a way to auto-fix most cases so I switched over to it completely here: #6281
justinmk3
reviewed
Dec 19, 2024
| const requestId = resp.$response.requestId | ||
| logStr += `\n${indent('RequestID: ', 4)}${requestId},\n${indent('Customizations:', 4)}` | ||
| resp.customizations.forEach((c, index) => { | ||
| for (const [c, index] of enumerate(resp.customizations)) { |
Contributor
There was a problem hiding this comment.
Does using enumerate() mean we are iterating the collection twice? Does this work instead:
for (const [index, element] of array.entries()) {
Contributor
Author
|
Moved to #6281 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Problem
forEach can lead to race conditions with async methods, and is often used instead of
map,find,some,reduce,flatMap, etc...Solution
Add a lint rule for forEach and migrate away from it.
feature/xbranches will not be squash-merged at release time.