[feature] Add custom `data` into `LintMessage`

The version of ESLint you are using.

v7.21.0

The problem you want to solve.

I want to get custom data which reported with context.report({ data }) info in LintMessage in postprocess.

Your take on the correct solution to problem.

For now, we got no way to get the custom data, I have to hack to use the message property with JSON.stringify/parse instead.

Are you willing to submit a pull request to implement this change?

Yes

[nzakas]

Ah okay, thank you. I understand now. You’re looking for a way to pass data from the rules into the processor to determine how to represent the errors better.

That’s an interesting idea. I’m not sure if adding such data would be a breaking change, so I’ll run this by the team and see what they think.

@btmills as our resident processor expert, what do you think?

[saberduck]

hello,

I am working on https://github.com/SonarSource/SonarJS which is a static analyzer based on ESLint used in SonarQube/SonarCloud/SonarLint. We would be also interested in the API which would allow passing additional data when reporting the problem from the rule. In Sonar ecosystem we have the concept of additional locations in the source code which helps to understand more complex problems (imagine taint analysis). Here is one example which shows dataflow in SQL injection issue in juice shop https://sonarcloud.io/project/issues?id=saberduck_juice-shop&issues=AX6N9VGbKcvyCvHU0eOA&open=AX6N9VGbKcvyCvHU0eOA

Currently, we have implemented a similar hack, we encode JSON object in the rule message. However this is ugly and we can’t use messageIds properly, so I would like to migrate from this.

I will be more than happy to help with the implementation if we can agree together on the design.