Add the ability to override default position of "3rd party" imports

[risen228]

The problem

I am the author of ESLint Kit.

There, I wanted to migrate from the buggy import/sort ESLint rule to something better and easier.
And I found your library pretty good in this.

But my case is not as simple as the examples in the README - I need to get the following order:

// the nodejs stdlib
import path from 'path'
import fs from 'fs'

// 3rd party modules
import YAML from 'yamljs'
import chalk from 'chalk'

// my aliases
import { foo } from '@app/foo'

// the relative imports
import { bar } from '../../bar'
import { baz } from '../baz'
import { moo } from './moo'

I found that it's very hard to do in the current version of sort-imports plugin.
The reason is that 3rd party modules are always moved to the top.
So, to get this behavior I have to write a really complicated RegExps.
After that, the prettier config may become very hard to extend and support.

The solution

I offer you the special word <3RD_PARTY>.

It can be placed in the importOrder rule, just like the RegExps.

<3RD_PARTY> "collects" the imports that are not matching to any RegEx specified in importOrder.

The bonuses

• This change is not breaking
• It's covered with tests
• I think the algorhythm became a much simpler and faster 😊

[risen228]

@ayusharma Can you check it please?

[ayusharma]

Hi @risenforces, Sorry for the delayed response. We are looking into it. 👍

[ernusBothma]

I was about to add a feature request for this.
Eagerly awaiting V3

[byara]

Looks really good to me, I left a few comments.
Could you please add another snapshot test case for imports all being third-party?
I also changed the base branch to v3.x so we can release this in the upcoming version.

[byara]

I think it might be better if we extract these kinds of functions and abstract them to a separate file + unit tests so they are more maintainable. What do you think?

[byara]

Please extract the types outside and import them on top.

[byara]

Hey @risenforces, as we want to release the v3 very soon, I'll take over and apply the changes.

[ayusharma]

Hi @risenforces , thanks for the PR ❤️ What do you mean by "REST" terminology in your PR ?

[risen228]

Hi @risenforces , thanks for the PR ❤️ What do you mean by "REST" terminology in your PR ?

I meant this. But as I remember, I replaced these things everywhere.. Did I forgot to do it in some place?

[ayusharma]

Hi @risenforces, There were some breaking changes from the other PR. I took some freedom to modify some parts of the code and make it mergeable. I hope you would not mind my interfering. Thank you so much for the amazing contribution. 🎉

[ayusharma]

Hi @risenforces , Thank you so much for your PR. Please respond to the notification here. #118