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.

Copy link
Member

@kaicataldo kaicataldo left a comment

LGTM, thanks!

@kaicataldo kaicataldo merged commit e707453 into master Dec 4, 2019
18 checks passed
18 checks passed
@github-actions
Verify Files
Details
@github-actions
Test (ubuntu-latest, 13.x)
Details
@github-actions
Test (ubuntu-latest, 12.x)
Details
@github-actions
Test (ubuntu-latest, 10.x)
Details
@github-actions
Test (ubuntu-latest, 8.x)
Details
@github-actions
Test (ubuntu-latest, 8.10.0)
Details
@github-actions
Test (windows-latest, 12.x)
Details
@github-actions
Test (macOS-latest, 12.x)
Details
@github-actions
Browser Test
Details
@eslint-deprecated
commit-message Commit message follows guidelines
Details
@azure-pipelines
continuous-integration Build #20191204.1 succeeded
Details
@azure-pipelines
continuous-integration (Test on Node.js 10 (Linux)) Test on Node.js 10 (Linux) succeeded
Details
@azure-pipelines
continuous-integration (Test on Node.js 12 (Linux)) Test on Node.js 12 (Linux) succeeded
Details
@azure-pipelines
continuous-integration (Test on Node.js 12 (Windows)) Test on Node.js 12 (Windows) succeeded
Details
@azure-pipelines
continuous-integration (Test on Node.js 12 (macOS)) Test on Node.js 12 (macOS) succeeded
Details
@azure-pipelines
continuous-integration (Test on Node.js 8 (Linux)) Test on Node.js 8 (Linux) succeeded
Details
licence/cla Contributor License Agreement is signed.
Details
@eslint-deprecated
release-monitor No patch release is pending
Details
@kaicataldo kaicataldo deleted the issue11717 branch Dec 4, 2019
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Jun 3, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants