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
|
# Disallow missing placeholders in rule report messages (no-missing-placeholders)
Report messages in rules can have placeholders surrounded by curly brackets.
```js
context.report({
node,
message: '{{disallowedNode}} nodes are not allowed.',
data: { disallowedNode: node.type }
});
// Resulting message: e.g. 'IfStatement nodes are not allowed.'
```
However, if no `data` argument is provided, or no matching replacement key exists in the `data` argument, the raw curly brackets will end up in the report message. This is usually a mistake.
## Rule Details
This rule aims to disallow missing placeholders in rule report messages.
Examples of **incorrect** code for this rule:
```js
/*eslint eslint-plugin/no-missing-placeholders: error*/
module.exports = {
create(context) {
context.report({
node,
message: '{{something}} is wrong.'
});
context.report({
node,
message: '{{something}} is wrong.',
data: { somethingElse: 'foo' }
});
context.report(node, '{{something}} is wrong.', { somethingElse: 'foo' });
}
};
```
Examples of **correct** code for this rule:
```js
/*eslint eslint-plugin/no-missing-placeholders: error*/
module.exports = {
create(context) {
context.report({
node,
message: 'something is wrong.'
});
context.report({
node,
message: '{{something}} is wrong.',
data: { something: 'foo' }
});
context.report(node, '{{something}} is wrong.', { something: 'foo' });
}
};
```
## When Not To Use It
If you want to use rule messages that actually contain double-curly bracket text, you should turn off this rule.
## Further Reading
* [context.report() API](http://eslint.org/docs/developer-guide/working-with-rules#contextreport)
|
