Group organized imports by distance

[arendjr]

Summary

This PR groups imports using a fixed order. This is similar to what is proposed in #42 although the exact groups is slightly different. I have tried to follow the suggestion in that discussion that the "philosophy in general is that code closer to the file is imported after code further away" and attempted to implement this in a way that does not require further config changes.

I have not yet updated any documentation, I'll be happy to do so if you think this approach is worthwhile to pursue.

Test Plan

I've added a test case for import groups.

[netlify]

✅ Deploy Preview for docs-rometools ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	90da7f5
🔍 Latest deploy log	https://app.netlify.com/sites/docs-rometools/deploys/64c76b619f88bf00086f339d
😎 Deploy Preview	https://deploy-preview-4725--docs-rometools.netlify.app/playground
📱 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.

[ematipico]

I don't really agree with the philosophy proposed in the discussion, which is really old btw, a lot of things have changed.

The reason why I don't agree with philosophy is because it doesn't take into consideration the possible side effects of external libraries.

If I had to suggest a change, I propose the exact opposite, where local imports are moved at the very end.

A real use case pops up in frontend applications, where CSS styles that belong to an external library must precede the local styles.

[arendjr]

The discussion may be old, but the prior art they reference (https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md and https://github.com/trivago/prettier-plugin-sort-imports) are still current and widely used as far as I know.

I understand libraries may have side-effects, but that's the same reason the current organizeImports action is already considered unsafe, no?

If I had to suggest a change, I propose the exact opposite, where local imports are moved at the very end.

Maybe I'm misunderstanding, but that's what my proposal is also doing, no? It moves external imports to the top, and local imports to the bottom.

[arendjr]

FWIW, I've updated the tests, so hopefully they'll be all green now. I suspect @ematipico and I are actually mostly in agreement on what it should do, since this change would indeed cause "CSS styles that belong to an external" to be imported before local styles, so I haven't given up on it yet :)

Another thing I would like to mention is that I think this PR might be a useful step towards a lint rule such as "noMixedImportGroups" (name TBD) that could be used to mandate newlines between import groups. This would basically support the "newlines-between": "always" usecase found in eslint-plugin-import.

[ematipico]

This is another fantastic contribution! Thank you!

[ematipico]

Happy to merge once the conflicts is solved

[arendjr]

Done!