Constnium/node_modules/eslint-plugin-promise/rules/prefer-await-to-then.js

59 lines
1.4 KiB
JavaScript
Raw Normal View History

2022-06-23 02:27:43 +02:00
/**
* Rule: prefer-await-to-then
* Discourage using then()/catch()/finally() and instead use async/await.
*/
'use strict'
const getDocsUrl = require('./lib/get-docs-url')
module.exports = {
meta: {
type: 'suggestion',
docs: {
url: getDocsUrl('prefer-await-to-then'),
},
schema: [],
},
create(context) {
/** Returns true if node is inside yield or await expression. */
function isInsideYieldOrAwait() {
return context.getAncestors().some((parent) => {
return (
parent.type === 'AwaitExpression' || parent.type === 'YieldExpression'
)
})
}
/**
* Returns true if node is created at the top-level scope.
* Await statements are not allowed at the top level,
* only within function declarations.
*/
function isTopLevelScoped() {
return context.getScope().block.type === 'Program'
}
return {
MemberExpression(node) {
if (isTopLevelScoped() || isInsideYieldOrAwait()) {
return
}
// if you're a then/catch/finally expression then you're probably a promise
if (
node.property &&
(node.property.name === 'then' ||
node.property.name === 'catch' ||
node.property.name === 'finally')
) {
context.report({
node: node.property,
message: 'Prefer await to then()/catch()/finally().',
})
}
},
}
},
}