eslint-plugin-ember/lib/rules/template-no-yield-only.js at 19e44c40ec3026d1817e39167b240b537540ad2e · johanrd/eslint-plugin-ember · GitHub

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
function isEmptyNode(node) {
  return (
    node.type === 'GlimmerMustacheCommentStatement' ||
    node.type === 'GlimmerCommentStatement' ||
    (node.type === 'GlimmerTextNode' && !node.chars.trim())
  );
}

function isYieldOnly(node) {
  return (
    node.type === 'GlimmerMustacheStatement' &&
    node.path &&
    node.path.type === 'GlimmerPathExpression' &&
    node.path.original === 'yield' &&
    node.params &&
    node.params.length === 0
  );
}

/** @type {import('eslint').Rule.RuleModule} */
module.exports = {
  meta: {
    type: 'suggestion',
    docs: {
      description: 'disallow components that only yield',
      category: 'Best Practices',
      url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/template-no-yield-only.md',
      templateMode: 'both',
    },
    fixable: null,
    schema: [],
    messages: {
      noYieldOnly: '{{yieldExpression}}-only templates are not allowed',
    },
    originallyFrom: {
      name: 'ember-template-lint',
      rule: 'lib/rules/no-yield-only.js',
      docs: 'docs/rule/no-yield-only.md',
      tests: 'test/unit/rules/no-yield-only-test.js',
    },
  },

  create(context) {
    let isOnlyYield = false;

    return {
      GlimmerTemplate(node) {
        const templateNodes =
          node.body[0] &&
          node.body[0].type === 'GlimmerElementNode' &&
          node.body[0].tag === 'template'
            ? node.body[0].children
            : node.body;

        const nonEmptyNodes = templateNodes.filter((n) => !isEmptyNode(n));
        if (nonEmptyNodes.length === 1 && isYieldOnly(nonEmptyNodes[0])) {
          isOnlyYield = true;
        }
      },

      GlimmerMustacheStatement(node) {
        if (isOnlyYield) {
          context.report({
            node,
            messageId: 'noYieldOnly',
            data: { yieldExpression: '{{yield}}' },
          });
        }
      },
    };
  },
};