Struct rslint_core::groups::errors::GetterReturn

pub struct GetterReturn {
    pub allow_implicit: bool,
}

Disallow getter properties which do not always return a value.

Getters are special properties introduced in ES5 which call a function when a property is accessed. The value returned will be the value returned for the property access:

let obj = {
    // Using object literal syntax
    get foo() {
        return 5;
    }
}

// Using the defineProperty function
Object.defineProperty(obj, "foo", {
    get: function() {
        return 5;
    }
})

Getters are expected to return a value, it is a bad practice to use getters to run some function without a return. This rule makes sure that does not happen and enforces a getter always returns a value.

Incorrect code examples

// The getter does not always return a value, it would not return anything
// if bar is falsey
let obj = {
    get foo() {
        if (bar) {
            return foo;
        }
    }
}

Correct code examples

// The getter always returns a value
let obj = {
    get foo() {
        if (bar) {
            return foo;
        } else {
            return bar;
        }
    }
}

Fields

allow_implicit: bool

Whether to allow implicitly returning undefined with return;. true by default.

Implementations

impl GetterReturn

pub fn new() -> Self

Trait Implementations

impl Clone for GetterReturn

fn clone(&self) -> GetterReturn

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CstRule for GetterReturn

fn check_node(&self, node: &SyntaxNode, ctx: &mut RuleCtx) -> Option<()>

Check an individual node in the syntax tree. You can use the match_ast macro to make matching a node to an ast node easier. The reason this uses nodes and not a visitor is because nodes are more flexible, converting them to an AST node has zero cost and you can easily traverse surrounding nodes. Defaults to doing nothing.

fn check_token(&self, token: &SyntaxToken, ctx: &mut RuleCtx) -> Option<()>

Check an individual token in the syntax tree. Defaults to doing nothing.

fn check_root(&self, root: &SyntaxNode, ctx: &mut RuleCtx) -> Option<()>

Check the root of the tree one time. This method is guaranteed to only be called once. The root’s kind will be either SCRIPT or MODULE. Defaults to doing nothing.

impl Debug for GetterReturn

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetterReturn

fn default() -> GetterReturn

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GetterReturn

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Rule for GetterReturn

fn name(&self) -> &'static str

A unique, kebab-case name for the rule.

fn group(&self) -> &'static str

The name of the group this rule belongs to.

fn docs(&self) -> &'static str

Optional docs for the rule, an empty string by default

fn tags(&self) -> &'static [Tag]

A list of tags present on this rule. Empty by default.

fn recommended(&self) -> bool

Whether this rule is recommended, this is a simple helper around Self::tags.

impl Serialize for GetterReturn

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.