是否有不需要空类型的规则,例如“显式函数返回类型”?

时间:2019-09-15 02:11:45

标签: typescript eslint

是否有任何ESLint规则执行与 [explicit-function-return-type]但不需要在函数上使用void类型吗?

如果没有,我应该如何执行此自定义规则?

1 个答案:

答案 0 :(得分:0)

对于那些想要规则的人,我已经设法执行了此自定义规则,但是它目前仅适用于类中的方法。 我正在使用Angular应用程序,所以效果很好。

const expUtil = require("@typescript-eslint/experimental-utils");

module.exports = (context) => {
  /**
   * Checks if a node is a constructor.
   * @param node The node to check
   */
  function isConstructor(node) {
    return (!!node &&
      node.type === expUtil.AST_NODE_TYPES.MethodDefinition &&
      node.kind === 'constructor');
  }
  /**
   * Checks if a node is a setter.
   */
  function isSetter(node) {
    return (!!node &&
      (node.type === expUtil.AST_NODE_TYPES.MethodDefinition ||
        node.type === expUtil.AST_NODE_TYPES.Property) &&
      node.kind === 'set');
  }

  /**
   * Checks if a node is returning some value
   */
  function isReturningValue(node) {
    const content = node.value.body;
    const returnVal = content.body.find(n => 
      n.type === expUtil.AST_NODE_TYPES.ReturnStatement
    );

    return (returnVal && !!returnVal.argument);
  }

  /**
   * Checks if a function declaration/expression has a return type.
   */
  function checkFunctionReturnType(node) {
    if (node.returnType ||
      node.value.returnType ||
      isConstructor(node.parent) ||
      isSetter(node.parent)) {
      return;
    }

    if (!isReturningValue(node)) {
      return;
    }

    context.report(
      node, 'Functions of type void should not return any value'
    );
  }

  return {
    MethodDefinition: checkFunctionReturnType
  };
};