Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Fix configuration example in no-restricted-imports (fixes #11717) #12638

Merged
merged 1 commit into from Dec 4, 2019

Conversation

mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Dec 4, 2019

What is the purpose of this pull request? (put an "X" next to item)

[X] Documentation update #11717

The following example from the no-restricted-imports documentation is an incorrect configuration:

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

Online Demo Link

Configuration should be either flat ["error", {}, {}, ...] or ["error", { paths: [{}, {}, ...] }].

It can't be ["error", [{}, {}, ...]], although this might a better choice than the flat array which looks a bit confusing.

What changes did you make? (Give an overview)

Fixed the example.

Is there anything you'd like reviewers to focus on?

The second example was correct, it's changed just for consistency.

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Dec 4, 2019
@mdjermanovic mdjermanovic added accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon labels Dec 4, 2019
Copy link
Member

@kaicataldo kaicataldo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@kaicataldo kaicataldo merged commit e707453 into master Dec 4, 2019
@kaicataldo kaicataldo deleted the issue11717 branch December 4, 2019 23:32
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Jun 3, 2020
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Jun 3, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants