return-in-computed-property.js

/**
 * @fileoverview Enforces that a return statement is present in computed property (return-in-computed-property)
 * @author Armano
 */
'use strict'

const utils = require('../utils')

function create (context) {
  const options = context.options[0] || {}
  const treatUndefinedAsUnspecified = !(options.treatUndefinedAsUnspecified === false)

  const forbiddenNodes = []

  // ----------------------------------------------------------------------
  // Public
  // ----------------------------------------------------------------------

  return Object.assign({},
    utils.executeOnFunctionsWithoutReturn(treatUndefinedAsUnspecified, node => {
      forbiddenNodes.push(node)
    }),
    utils.executeOnVue(context, properties => {
      const computedProperties = utils.getComputedProperties(properties)

      computedProperties.forEach(cp => {
        forbiddenNodes.forEach(el => {
          if (cp.value && cp.value.parent === el) {
            context.report({
              node: el,
              message: 'Expected to return a value in "{{name}}" computed property.',
              data: {
                name: cp.key
              }
            })
          }
        })
      })
    })
  )
}

// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------

module.exports = {
  meta: {
    docs: {
      description: 'enforce that a return statement is present in computed property',
      category: 'essential',
      url: 'https://github.com/vuejs/eslint-plugin-vue/blob/master/docs/rules/return-in-computed-property.md'
    },
    fixable: null, // or "code" or "whitespace"
    schema: [
      {
        type: 'object',
        properties: {
          treatUndefinedAsUnspecified: {
            type: 'boolean'
          }
        },
        additionalProperties: false
      }
    ]
  },

  create
}