Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(prefer-await-to-then): ignore constructor scope unless with strict option #496

Merged
merged 2 commits into from
Jul 24, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions __tests__/prefer-await-to-then.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ ruleTester.run('prefer-await-to-then', rule, {
`function isThenable(obj) {
return obj && typeof obj.then === 'function';
}`,
`class Foo {
constructor () {
doSomething.then(abc);
}
}`,
],

invalid: [
Expand Down Expand Up @@ -65,6 +70,19 @@ ruleTester.run('prefer-await-to-then', rule, {
},
],
},
{
code: `class Foo {
constructor () {
doSomething.then(abc);
}
}`,
errors: [{ message }],
options: [
{
strict: true,
},
],
},
{
code: 'async function hi() { await thing().catch() }',
errors: [{ message }],
Expand Down
4 changes: 2 additions & 2 deletions rules/lib/is-inside-callback.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
const isInsidePromise = require('./is-inside-promise')

function isInsideCallback(node) {
const isCallExpression =
const isFunction =
node.type === 'FunctionExpression' ||
node.type === 'ArrowFunctionExpression' ||
node.type === 'FunctionDeclaration' // this may be controversial
Expand All @@ -13,7 +13,7 @@ function isInsideCallback(node) {

const name = node.params && node.params[0] && node.params[0].name
const firstArgIsError = name === 'err' || name === 'error'
const isInACallback = isCallExpression && firstArgIsError
const isInACallback = isFunction && firstArgIsError
return isInACallback
}

Expand Down
15 changes: 14 additions & 1 deletion rules/prefer-await-to-then.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,15 @@ module.exports = {
})
}

/** Returns true if node is inside a constructor */
function isInsideConstructor(node) {
return getAncestors(context, node).some((parent) => {
return (
parent.type === 'MethodDefinition' && parent.kind === 'constructor'
)
})
}

/**
* Returns true if node is created at the top-level scope.
* Await statements are not allowed at the top level,
Expand All @@ -53,7 +62,11 @@ module.exports = {

return {
'CallExpression > MemberExpression.callee'(node) {
if (isTopLevelScoped(node) || (!strict && isInsideYieldOrAwait(node))) {
if (
isTopLevelScoped(node) ||
(!strict && isInsideYieldOrAwait(node)) ||
(!strict && isInsideConstructor(node))
) {
return
}

Expand Down