no-restricted-imports with custom messages is throwing a validation error

[yvele]

Node 10.15.3 and latest ESLint version.

When configuring the rule with a custom message exactly how it is done in the example page https://eslint.org/docs/rules/no-restricted-imports

"no-restricted-imports": ["error", [{
  "name": "import-foo",
  "message": "Please use import-bar instead."
}]]

I get an ESLint rule validation error

Error: /Users/me/project/my-rules.js:
Configuration for rule "no-restricted-imports" is invalid:
Value [{"name":"import-foo","message":"Please use import-bar instead."}] should be string.
Value [{"name":"import-foo","message":"Please use import-bar instead."}] should be object.
Value [{"name":"import-foo","message":"Please use import-bar instead."}] should match some schema in anyOf.
Value [{"name":"import-foo","message":"Please use import-bar instead."}] should be object.
Value [[{"name":"import-foo","message":"Please use import-bar instead."}]] should match some schema in anyOf.

I don't think the documentation is wrong because the rule should accept custom messages as stated here #8400

[yvele]

Looks like the ONLY syntax from the examples that works is

"no-restricted-imports": ["error", "import1", "import2"]

[g-plane]

Hi @yvele , thanks for this issue.

It seems that documentation has something wrong.

You can try this:

"no-restricted-imports": ["error", [{
  "paths": [{
    "name": "import-foo",
    "message": "Please use import-bar instead."
  }]
}]]

[yvele]

@g-plane I've copy/pasted your config and it's not working either

Configuration for rule "no-restricted-imports" is invalid:
Value [{"paths":[{"name":"import-foo","message":"Please use import-bar instead."}]}] should be string.
Value [{"paths":[{"name":"import-foo","message":"Please use import-bar instead."}]}] should be object.
Value [{"paths":[{"name":"import-foo","message":"Please use import-bar instead."}]}] should match some schema in anyOf.
Value [{"paths":[{"name":"import-foo","message":"Please use import-bar instead."}]}] should be object.
Value [[{"paths":[{"name":"import-foo","message":"Please use import-bar instead."}]}]] should match some schema in anyOf.

[platinumazure]

I think the issue is that the severity and options should all be a flat array:

{
    "no-restricted-imports": [
        "error",
        {
            "name": "import-foo",
            "message": "Please use import-bar instead."
        }
    ]
}

@yvele Could you please give that a try? And if it works, please advise (or submit a PR) where the documentation needs to be corrected... Thanks!

[eslint-deprecated]

Unfortunately, it looks like there wasn't enough interest from the team
or community to implement this change. While we wish we'd be able to
accommodate everyone's requests, we do need to prioritize. We've found
that issues failing to reach accepted status after 21 days tend to
never be accepted, and as such, we close those issues.
This doesn't mean the idea isn't interesting or useful, just that it's
not something the team can commit to.

Thanks for contributing to ESLint and we appreciate your understanding.

[kumarashwin]

Having the same issue. Tried all the different methods mentioned here to no avail.

[platinumazure]

@kumarashwin Please open a new issue and please fill in the information the new issue template asks for (including the configuration you're using). Thanks!

[mdjermanovic]

Example from the original post is indeed wrong in the documentation, it should be as in this comment

It seems that the other examples are correct.