summaryrefslogtreecommitdiffstats
path: root/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/use-default-preference-values.js
blob: 87fc07057d589d259fed9ca44df6b163fc76a14c (plain)
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
/**
 * @fileoverview Require providing a second parameter to get*Pref
 * methods instead of using a try/catch block.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

"use strict";

module.exports = {
  meta: {
    docs: {
      url: "https://firefox-source-docs.mozilla.org/code-quality/lint/linters/eslint-plugin-mozilla/use-default-preference-values.html",
    },
    schema: [],
    type: "suggestion",
  },

  create(context) {
    return {
      TryStatement(node) {
        let types = ["Bool", "Char", "Float", "Int"];
        let methods = types.map(type => "get" + type + "Pref");
        if (
          node.block.type != "BlockStatement" ||
          node.block.body.length != 1
        ) {
          return;
        }

        let firstStm = node.block.body[0];
        if (
          firstStm.type != "ExpressionStatement" ||
          firstStm.expression.type != "AssignmentExpression" ||
          firstStm.expression.right.type != "CallExpression" ||
          firstStm.expression.right.callee.type != "MemberExpression" ||
          firstStm.expression.right.callee.property.type != "Identifier" ||
          !methods.includes(firstStm.expression.right.callee.property.name)
        ) {
          return;
        }

        context.report({
          node,
          message: "provide a default value instead of using a try/catch block",
        });
      },
    };
  },
};