1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
use crate::rule_prelude::*;
use ast::*;
use SyntaxKind::*;

declare_lint! {
    /**
    Disallow setters to return values.

    Setters cannot return values. To be more precise, a setter that returns a value is not treated as an error, but we
    cannot use the returned value at all. Thus, if you write a setter that will return something, it is most likely
    either completely unnecessary or a possible error.

    Note that `return` without a value is allowed because it is considered a control flow statement.

    This rule checks setters in:

    - Object literals
    - Class declarations and class expressions
    - Property descriptors in `Object.create`, `Object.defineProperty`, `Object.defineProperties`, and `Reflect.defineProperty`

    ## Incorrect code examples

    ```js
    let foo = {
        set a(value) {
            this.val = value;
            // The setter always returns a value
            return value;
        }
    };

    class Foo {
        set a(value) {
            this.val = value;
            // The setter always returns a value
            return this.val;
        }
    }

    const Bar = class {
        static set a(value) {
            if (value < 0) {
                this.val = 0;
                // The setter returns `0` if the value is negative
                return 0;
            }
            this.val = value;
        }
    };

    Object.defineProperty(foo, "bar", {
        set(value) {
            if (value < 0) {
                // The setter returns `false` if the value is negative
                return false;
            }
            this.val = value;
        }
    });
    ```

    ## Correct code examples

    ```js
    let foo = {
        set a(value) {
            this.val = value;
        }
    };

    class Foo {
        set a(value) {
            this.val = value;
        }
    }

    const Bar = class {
        static set a(value) {
            if (value < 0) {
                this.val = 0;
                // Returning without a value is allowed
                return;
            }
            this.val = value;
        }
    };

    Object.defineProperty(foo, "bar", {
        set(value) {
            if (value < 0) {
                // Throwing an error is also allowed
                throw new Error("Negative value is not allowed.");
            }
            this.val = value;
        }
    });
    ```
    */
    #[derive(Default)]
    NoSetterReturn,
    errors,
    "no-setter-return",
}

/// Check if the expr is either
/// - `Object.defineProperty`
/// - `Object.defineProperties`
/// - `Reflect.defineProperties`
/// and receives three arguments.
fn is_define_property(expr: &CallExpr) -> bool {
    expr.callee().map_or(false, |e| {
        [
            ["Object", ".", "defineProperty"],
            ["Object", ".", "defineProperties"],
            ["Reflect", ".", "defineProperties"],
        ]
        .iter()
        .any(|toks| e.syntax().structural_lossy_token_eq(toks))
    }) && expr.arguments().map_or(false, |a| a.args().count() == 3)
}

/// Check if the expr is `Object.create` and receives two arguments.
fn is_object_create(expr: &CallExpr) -> bool {
    expr.callee().map_or(false, |e| {
        e.syntax()
            .structural_lossy_token_eq(&["Object", ".", "create"])
    }) && expr.arguments().map_or(false, |a| a.args().count() == 2)
}

#[typetag::serde]
impl CstRule for NoSetterReturn {
    fn check_node(&self, node: &SyntaxNode, ctx: &mut RuleCtx) -> Option<()> {
        match node.kind() {
            CALL_EXPR => {
                let expr = node.to::<CallExpr>();
                if is_define_property(&expr) {
                    let args: Vec<Expr> = expr.arguments().unwrap().args().collect();
                    if let Some(obj) = args
                        .get(2)
                        .and_then(|expr| expr.syntax().try_to::<ObjectExpr>())
                    {
                        for prop in obj.props() {
                            self.check_object_props(args[1].syntax(), &prop, ctx);
                        }
                    }
                } else if is_object_create(&expr) {
                    let args: Vec<Expr> = expr.arguments().unwrap().args().collect();
                    if let Some(obj) = args
                        .get(1)
                        .and_then(|expr| expr.syntax().try_to::<ObjectExpr>())
                    {
                        for prop in obj.props() {
                            if let ObjectProp::LiteralProp(literal_prop) = prop {
                                if let Some(Expr::ObjectExpr(inner_obj)) = literal_prop.value() {
                                    for inner_prop in inner_obj.props() {
                                        self.check_object_props(
                                            literal_prop.syntax(),
                                            &inner_prop,
                                            ctx,
                                        );
                                    }
                                }
                            }
                        }
                    }
                }
            }
            SETTER => {
                let setter = node.to::<Setter>();
                if let Some(body) = setter.body() {
                    if let Some(key) = setter.key() {
                        self.check_stmts(key.syntax(), body.syntax(), body.stmts(), ctx);
                    }
                }
            }
            _ => {}
        }
        None
    }
}

impl NoSetterReturn {
    fn check_object_props(
        &self,
        key: &SyntaxNode,
        prop: &ObjectProp,
        ctx: &mut RuleCtx,
    ) -> Option<()> {
        match prop {
            ObjectProp::LiteralProp(literal_prop) => {
                if literal_prop.key()?.text() != "set" {
                    return None;
                }
                match literal_prop.value()? {
                    Expr::FnExpr(decl) => {
                        self.check_stmts(key, decl.body()?.syntax(), decl.body()?.stmts(), ctx);
                    }
                    Expr::ArrowExpr(arrow) => {
                        if let ExprOrBlock::Block(block) = arrow.body()? {
                            self.check_stmts(key, block.syntax(), block.stmts(), ctx);
                        }
                    }
                    _ => {}
                }
            }
            ObjectProp::Setter(setter) => {
                self.check_stmts(key, setter.body()?.syntax(), setter.body()?.stmts(), ctx);
            }
            ObjectProp::Method(method) => {
                if method.name()?.text() != "set" {
                    return None;
                }
                self.check_stmts(key, method.body()?.syntax(), method.body()?.stmts(), ctx);
            }
            _ => {}
        }

        None
    }

    fn check_stmts(
        &self,
        key: &SyntaxNode,
        body: &SyntaxNode,
        mut stmts: impl Iterator<Item = Stmt>,
        ctx: &mut RuleCtx,
    ) {
        if stmts.any(|stmt| self.stmt_returns_value(&stmt)) {
            let err = ctx
                .err(
                    self.name(),
                    format!(
                        "setter properties are not allowed to return values, but `{}` does.",
                        key.trimmed_text(),
                    ),
                )
                .primary(body, "this setter somethimes or always returns a value");
            ctx.add_err(err);
        }
    }

    /// Return `true` if a stmt returns a value.
    fn stmt_returns_value(&self, stmt: &Stmt) -> bool {
        match stmt {
            Stmt::IfStmt(if_stmt) => {
                let cons_result = if_stmt
                    .cons()
                    .map_or(false, |cons| self.stmt_returns_value(&cons));
                let alt_result = if_stmt
                    .alt()
                    .map_or(false, |alt| self.stmt_returns_value(&alt));
                cons_result || alt_result
            }
            Stmt::BlockStmt(block) => block.stmts().any(|stmt| self.stmt_returns_value(&stmt)),
            Stmt::ReturnStmt(stmt) => stmt.value().is_some(),
            Stmt::SwitchStmt(switch) => switch.cases().any(|case| match case {
                SwitchCase::CaseClause(clause) => {
                    clause.cons().any(|s| self.stmt_returns_value(&s))
                }
                SwitchCase::DefaultClause(clause) => {
                    clause.cons().any(|s| self.stmt_returns_value(&s))
                }
            }),
            _ => false,
        }
    }
}

rule_tests! {
    NoSetterReturn::default(),
    err: {
        "
        let foo = {
            set bar(val) {
                return 42;
            }
        };
        ",
        "
        let bar = {
            set foo(val) {
                if (bar) {
                    return 42;
                }
            }
        };
        ",
        "
        let bar = {
            set foo(val) {
                switch (bar) {
                    case 5:
                    case 6:
                    if (bar) {
                        return 42;
                    }
                }
            }
        };
        ",
        "
        let bar = {
            set foo(val) {
                if (bar) {

                } else {
                    return 42;
                }
            }
        };
        ",
        "
        class Foo {
            set bar(val) {
                return 42;
            }
        }
        ",
        "
        let Foo = class {
            set bar(val) {
                return 42;
            }
        };
        ",
        "
        Object.create(null, {
            foo: {
                set(val) {
                    return 42;
                }
            }
        });
        ",
        "
        Object.defineProperty(foo, 'bar', {
            set(val) {
                return 42;
            }
        });
        ",
        "
        Object.defineProperties(foo, 'bar', {
            set(val) {
                return 42;
            }
        });
        ",
        "
        Reflect.defineProperties(foo, 'bar', {
            set(val) {
                return 42;
            }
        });
        ",
    },
    ok: {
        "({ set foo(val) { return; } })",
        "({ set foo(val) { if (val) { return; } } })",
        "class A { set foo(val) { return; } }",
        "(class { set foo(val) { if (val) { return; } else { return; } return; } })",
        "class A { set foo(val) { try {} catch(e) { return; } } }",
        "Object.defineProperty(foo, 'bar', { set(val) { return; } })",
    },
}