Contents

/**
 * Rule: catch-or-return
 * Ensures that promises either include a catch() handler
 * or are returned (to be handled upstream)
 */

'use strict'

const getDocsUrl = require('./lib/get-docs-url')
const isPromise = require('./lib/is-promise')

module.exports = {
  meta: {
    docs: {
      url: getDocsUrl('catch-or-return')
    },
    messages: {
      terminationMethod: 'Expected {{ terminationMethod }}() or return'
    }
  },
  create(context) {
    const options = context.options[0] || {}
    const allowThen = options.allowThen
    let terminationMethod = options.terminationMethod || 'catch'

    if (typeof terminationMethod === 'string') {
      terminationMethod = [terminationMethod]
    }

    return {
      ExpressionStatement(node) {
        if (!isPromise(node.expression)) {
          return
        }

        // somePromise.then(a, b)
        if (
          allowThen &&
          node.expression.type === 'CallExpression' &&
          node.expression.callee.type === 'MemberExpression' &&
          node.expression.callee.property.name === 'then' &&
          node.expression.arguments.length === 2
        ) {
          return
        }

        // somePromise.catch()
        if (
          node.expression.type === 'CallExpression' &&
          node.expression.callee.type === 'MemberExpression' &&
          terminationMethod.indexOf(node.expression.callee.property.name) !== -1
        ) {
          return
        }

        // somePromise['catch']()
        if (
          node.expression.type === 'CallExpression' &&
          node.expression.callee.type === 'MemberExpression' &&
          node.expression.callee.property.type === 'Literal' &&
          node.expression.callee.property.value === 'catch'
        ) {
          return
        }

        context.report({
          node,
          messageId: 'terminationMethod',
          data: { terminationMethod }
        })
      }
    }
  }
}

Version data entries

43 entries across 43 versions & 1 rubygems

Version	Path
govuk_publishing_components-18.0.0	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.21.0	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.20.0	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.19.1	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.19.0	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.18.0	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.17.0	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.16.0	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.15.0	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.14.0	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.13.0	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.12.2	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.12.1	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.12.0	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.11.0	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.10.0	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.9.0	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.8.0	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.7.0	node_modules/eslint-plugin-promise/rules/catch-or-return.js
govuk_publishing_components-17.6.1	node_modules/eslint-plugin-promise/rules/catch-or-return.js