Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

messageId messages with placeholders fail during tests.

See original GitHub issue

Tell us about your environment

  • ESLint Version: 4.15+
  • Node Version: 8.9.3
  • npm Version: 5.5.1

What parser (default, Babel-ESLint, etc.) are you using? default

Please show your full configuration: N/A

What did you do? Please include the actual source code causing the issue, as well as the command that you used to run ESLint. Write a test where the message is a placeholder and the message is referred to via the new meta.messageId. Run the test runner against it with a messageId to match against.

module.exports = {
    meta: {
        messages: {
            avoidName: "Avoid using variables named '{{ name }}'"
    create(context) {
        return {
            Identifier(node) {
                if ( === 'foo') {
                        messageId: 'avoidName',
                        data: {
                            name: 'foo'
'use strict';
var rule = require('../../../lib/rules/no-foo');
var RuleTester = require('eslint').RuleTester;

var ruleTester = new RuleTester();'no-foo', rule, {
    valid: ['bar', 'baz'],
    invalid: [
            code: 'foo',
            errors: [
                    messageId: 'avoidName'
npm run test

What did you expect to happen? Tests pass.

What actually happened? Please include the actual, raw output from ESLint.

  1 failing

  1) no-foo invalid foo:

      AssertionError [ERR_ASSERTION]: 'Avoid using variables named \'foo\'' === 'Avoid using variables named \'{{ name }}\''
      + expected - actual

      -Avoid using variables named 'foo'
      +Avoid using variables named '{{ name }}'

      at assertMessageMatches (node_modules\eslint\lib\testers\rule-tester.js:442:24)
      at testInvalidTemplate (node_modules\eslint\lib\testers\rule-tester.js:517:29)
      at (node_modules\eslint\lib\testers\rule-tester.js:581:25)

So it looks like ruleTester is comparing the value of messageId’s pre-formatted template to the post-formatted runtime error.

It seems like the ideal behavior is:

  1. If your test needs to get the post-formatted runtime report message, use message in the ruleTester.
  2. If your test wants to know that a specific rule ID was used to generate the error message, use mesageId in the ruleTester.

My guess is that most use cases fall under the second category, but that the first category is worth supporting as well to give access to the direct output during testing if needed.

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Comments:30 (30 by maintainers)

github_iconTop GitHub Comments

betaorbustcommented, Feb 1, 2018

So, everybody good if I put a PR in that satisfies

not-an-aardvarkcommented, Jan 29, 2018

This seems like it complicates the expected use of the RuleTester API as the rest of the attributes are independent and direct-comparison

That’s a fair point. I think data is a bit different from other properties in that the “important” keys are dependent on the message/messageId anyway. For example, some rules provide an AST node as the data property and rely on ESLint to grab the appropriate properties from it:

With code like that, it probably wouldn’t make sense to match against every property of node, since there are a lot of unrelated properties and the data is functionally equivalent to { name: }. So either way, I think there is a coupling between message/messageId and data that doesn’t exist between other properties, so I’m fine with having the corresponding RuleTester options coupled.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Messages - SAP Community
Hi, Any information on messages or message types would be appreciated. ... If the specified message contains placeholders, you can supply them with...
Read more >
How to put error message inside Placeholder - Stack Overflow
Now I whant to do this: First you see input field with placeholder "Test". So if you put numbers, placeholder deletes, and you...
Read more >
eslint-plugin-eslint-plugin - npm
Start using eslint-plugin-eslint-plugin in your project by running `npm i ... disallow missing placeholders in rule report messages, ✓.
Read more >
SQL - Apache Camel
Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. true. boolean. backoffErrorThreshold (scheduler). The ...
Read more >
Working with Rules - ESLint - Pluggable JavaScript Linter
You can also use placeholders in the message and provide data : ... error: Avoid using variables named 'foo' // In your tests:...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found