docs: Clarify the description of sort-imports options

[gwBear1]

Prerequisites checklist

• I have read the contributing guidelines.

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

• Documentation update

What changes did you make? (Give an overview)

---

Made 4 test cases of the below. It could be more straightforward.

incorrect with default option ignore false
correct   with default option ignore false
correct   with ignore true
incorrect with ignore true

• ignoreCase
• ignoreDeclarationSort
• ignoreMemberSort

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

• Should be checked whether test cases are correct.

[eslint-github-bot]

Hi @gwBear1!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

• The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
• There should be a space following the initial tag and colon, for example 'feat: Message'.
• The first letter of the tag should be in lowercase

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: gwBear1 / name: gyeongwoo park (58006f3, dbb7a88, 321c992, f6c294b, d28b4b1, d287318, 9ff7893, f5ee4b3, 7cdc966)

[netlify]

✅ Deploy Preview for docs-eslint ready!

Name	Link
🔨 Latest commit	d287318
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/65fbfeb9fa95430008037bb4
😎 Deploy Preview	https://deploy-preview-18198--docs-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[eslint-github-bot]

Hi @gwBear1!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

• The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
• There should be a space following the initial tag and colon, for example 'feat: Message'.
• The first letter of the tag should be in lowercase

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

[Tanujkanti4441]

Hi @gwBear1, thanks for the PR, but the docs are correct because it shows both incorrect and correct examples when
{ "ignoreCase": true } as you can see the examples written under the incorrect section by opening them in playground.

[Tanujkanti4441]

sorry for closing too early.
after looking around a bit i found

/*eslint sort-imports: "error"*/

import A from 'foo.js';
import b from 'bar.js';

by default rule doesn't report this arrangement of import names.

/*eslint sort-imports: "error"*/

import a from 'foo.js';
import B from 'bar.js';

but report this

@mdjermanovic is it intended?

if yes then we need to show this in docs too

[gwBear1]

@Tanujkanti4441 Yeah I was confused too. You right, fixing test case would be better choice. I'll rewrite test cases.

[gwBear1]

I added test cases more straightforward. Each options has 3 test cases

• incorrect with default option ignore false
• correct with default option ignore false
• correct with ignore true

"+" updated PR description

[gwBear1]

@Tanujkanti4441 Can you check my PR again?

[mdjermanovic]

/*eslint sort-imports: "error"*/

import A from 'foo.js';
import b from 'bar.js';

by default rule doesn't report this arrangement of import names.

/*eslint sort-imports: "error"*/

import a from 'foo.js';
import B from 'bar.js';

but report this
@mdjermanovic is it intended?

This is intended because: any uppercase letter < any lowercase letter. A < b, B < a.

[mdjermanovic]

I'm confused by the PR title. "Fixed incorrect doc description" sounds like the docs were incorrect, but it looks like the docs were correct and we just want to add more examples to further clarify options?

[mdjermanovic]

If we want to describe both, I think the default behavior should be first.

When `false` (default), uppercase letters of the alphabet must always precede lowercase letters.

When `true`, the rule ignores the case-sensitivity of the imports local name.

[gwBear1]

I'm confused by the PR title. "Fixed incorrect doc description" sounds like the docs were incorrect, but it looks like the docs were correct and we just want to add more examples to further clarify options?

I changed the PR title and description

[gwBear1]

@Tanujkanti4441 @mdjermanovic Followed your comments. Could you check this PR again?

[Tanujkanti4441]

everything looks good just a last thing.

[gwBear1]

@Tanujkanti4441 I hope this would be the last request 😅 Thanks for reviewing be thorough

[Tanujkanti4441]

LGTM! thanks.

[mdjermanovic]

LGTM, thanks!