Alphabetize imports within groups #1105

duncanbeevers · 2018-05-17T23:48:03Z

In order to provide absolute ordering, rather than just group-wise ordering, this PR offers an alphabetize option that enforces locale-aware alphabetical intra-group ordering.

It makes no effort to provide a more robust fix experience, so multiple passes may be necessary to bring a set of imports into a stable configuration, though since an absolute ordering is available, a single-pass fix probably isn't unreasonable.

Fixes #1406.

…n groups Fixes import-js#1406. Fixes import-js#389. Closes import-js#629. Closes import-js#1105. Closes import-js#1360. Co-Authored-By: dannysindra <[email protected]> Co-Authored-By: Radim Svoboda <[email protected]> Co-Authored-By: Soma Lucz <[email protected]> Co-Authored-By: Randall Reed, Jr <[email protected]> Co-Authored-By: Jordan Harband <[email protected]>

coveralls · 2018-05-18T00:00:03Z

Coverage decreased (-0.2%) to 96.216% when pulling 8224e51 on duncanbeevers:alphabetize into f12ae59 on benmosher:master.

ljharb · 2018-05-18T06:08:59Z

docs/rules/order.md

@@ -1,7 +1,7 @@
 # import/order: Enforce a convention in module import order

 Enforce a convention in the order of `require()` / `import` statements.
-+(fixable) The `--fix` option on the [command line] automatically fixes problems reported by this rule.
+(fixable) The `--fix` option on the [command line] automatically fixes problems reported by this rule. When the `alphabetize` option is used, multiple fix passes may be required.


I think it's pretty important to try to avoid multiple passes.

ljharb · 2018-05-18T06:09:53Z

docs/rules/order.md

@@ -164,6 +163,26 @@ import index from './';
 import sibling from './foo';
 ```

+### `alphabetize`: boolean
+
+By default, no ordering within groups is enforced. When `alphabetize: true` is used, imports must be alphabetically ordered within their groups.


This seems a bit restrictive; will people always want a-z? what about z-a? What about capital letters? Should it be a, A, b, c, D, or A, a, b, c, D, or a, b, c, A, D?

Great questions. When I took a run at this in the past, I got some pushback around finding a balance between flexibility and simplicity.

Today's approach was more conservative, and the results aren't perfect. For example, we'd love to be able to differentiate webpack aliases from external node modules, and to sort asset-type resources such as .css separately from ordinary modules.

will people always want a-z? what about z-a?

People don't seem to care much about absolute ordering at all today; I'd be a little bit surprised if many people wanted z-a. My real fear is people wanting an arbitrary comparator. It's not difficult to add, but it's difficult to express declaratively, like in an .eslintrc.json file.

Basically, I want a completely stable sort, and alphabetical is pretty politically-neutral.

What about capital letters?

localeCompare accepts some options that it would be straightforward to thread through declaratively from the eslint config, if that's something users want.

Basically, I want a completely stable sort, and alphabetical is pretty politically-neutral.

I, as a person who's interested in using this lint, second this.

@ljharb what's your thought on @duncanbeevers response to your comment here? I am thinking a-z ordering should be good enough for majority of users.

I think a-z and z-a is a minimum, as well as an option that chooses between “z comes before/after A” and “z is right next to Z”. I definitely don’t want an arbitrary comparator.

duncanbeevers · 2018-05-22T19:33:37Z

We ended up writing a custom eslint plugin that we could tune to support our specific ordering rules. I closed this issue since I no longer need the functionality myself.

If someone wants to take this to completion feel free, but I'm setting it aside.

robwierzbowski · 2019-01-08T15:36:24Z

@duncanbeevers Can you show your custom plugin in a gist?

Recently my team has run into the shared chunk warning in the mini-css-extract-plugin documented here:

webpack-contrib/mini-css-extract-plugin#246
webpack-contrib/mini-css-extract-plugin#250

Alphabetizing and grouping (creating a deterministic, consistent order of imports across modules) may fix the shared chunk CSS import problem. Interested in this PR, and might be interested in contributing if my company will give me time to.

stefanmaric · 2019-01-16T22:16:41Z

@duncanbeevers Can you show your custom plugin in a gist?

I second the motion. 😄

dannysindra · 2019-01-31T07:54:32Z

@ljharb Hi, I am interested to use the ordering here. Do you think @duncanbeevers 's PR is close to completion? What else would be necessary in order to get this PR merged? I probably can help if anyone can give me a direction

ljharb · 2019-01-31T15:41:34Z

@dannysindra there’s a few open comments; it needs a rebase.

If you’d like to help, please don’t open another PR, but please do post a link to your branch here (with these rebased commits, and any new ones) and I’ll be happy to update the PR with them. Thanks!

dannysindra · 2019-02-04T04:12:01Z

@ljharb I finished making the changes in my repo: https://github.com/dannysindra/eslint-plugin-import/tree/alphabetize.

So I made the following configs for the alphabetize option:

order: [string] - either ignore (do not use alphabetize), asc, or desc
ignoreCase: [boolean] - if false put upper before lowercase (normal js sort), if true put upper and lowercase together (localeCompare)

Please let me know if you have any feedback / questions. This is my first contribution btw, so I apologize in advance if I made beginner mistakes here and there

ljharb · 2019-02-04T06:28:42Z

@dannysindra i was hoping for a rebase, not a merge (no merge commits) but i've gone ahead and updated this branch with a rebased version of its, and your, commits. I'll give it a review once tests are passing.

dannysindra · 2019-02-04T08:03:42Z

@ljharb thanks for the quick response! My bad, I tried to rebase and somehow must have pulled and merged. I am trying to understand what causes the tests to fail here.. it passes locally and on some env in the AppVeyor; but failed on others? Also, is there a way to run the coveralls locally? I cannot tell which lines / files decreased the coverage..

ljharb · 2019-02-04T08:07:46Z

@dannysindra make sure you're checking out the rebased version; the travis tests are failing too.

dannysindra · 2019-02-04T09:00:14Z

@ljharb alright, I have rebased, and pushed again with the fix 7fa20f0

ljharb · 2019-02-04T23:03:51Z

@dannysindra thanks, updated (next time, please delete your local branch, and re-check it out from 3db6bd7)

VincentLanglet · 2019-04-19T14:25:08Z

@dannysindra There are conflicts, so you can start by rebasing the branch.
The tests will re-run with the new push.

ljharb · 2019-05-05T20:51:17Z

This still needs a rebase.

kg-currenxie · 2019-05-07T09:26:29Z

Definitely want this! :D

tayler-king · 2019-05-13T21:08:03Z

Any progress on getting this merged?

stropho · 2019-05-15T13:20:42Z

rebased : ~~https://github.com/stropho/eslint-plugin-import-1/commit/b80dc108280b638229a6f148e1fe10795f1c3c5~~

--> https://github.com/stropho/eslint-plugin-import-1/commit/e6a5ac36c0c6024ae6f9f2629c96830d17ef586a
Well obviously it wasn't only about rebasing the existing code :-D I'm willing to do max. 1 more change. So please, if you have any more suggestions for improvement, give it all to me at once

lext-7 · 2019-05-17T17:04:46Z

Want it !

mgol · 2019-05-20T11:23:02Z

docs/rules/order.md

+```js
+import foo from 'foo';
+import bar from 'bar';
+import Baz from 'Baz';


These examples make it unclear whether the sorting happens by module names or by bindings names. Making them different would help (this applies to all new examples in this file).

And here I though the code is all good and I just need to rebase it.
Totally agree with you about this one

syashenkov · 2019-06-04T07:54:47Z

Any progress on this? I'm ready to contribute to this feature

stropho · 2019-06-04T14:21:08Z

Any progress on this? I'm ready to contribute to this feature

Good to hear. Right now, it's in a state of waiting for the maintainers to express themselves - and possibly merge it #1360

…n groups Fixes import-js#1406. Fixes import-js#389. Closes import-js#629. Closes import-js#1105. Closes import-js#1360. Co-Authored-By: dannysindra <[email protected]> Co-Authored-By: Radim Svoboda <[email protected]> Co-Authored-By: Soma Lucz <[email protected]> Co-Authored-By: Randall Reed, Jr <[email protected]> Co-Authored-By: Jordan Harband <[email protected]>

ljharb reviewed May 18, 2018

View reviewed changes

duncanbeevers closed this May 21, 2018

ljharb reopened this May 22, 2018

janpaul123 mentioned this pull request Jul 12, 2018

Fix #389: Allow secondary alphabetical sorting #629

Merged

ljharb added help wanted semver-minor import/export ordering labels Jan 8, 2019

ljharb force-pushed the alphabetize branch from 8c67d3b to 941435e Compare February 4, 2019 06:27

ljharb force-pushed the alphabetize branch from 941435e to 3db6bd7 Compare February 4, 2019 23:03

This comment has been minimized.

Sign in to view

stropho mentioned this pull request May 14, 2019

Alphabetize imports within groups #1360

Merged

mgol reviewed May 20, 2019

View reviewed changes

ljharb mentioned this pull request Nov 26, 2019

[import/order] sort order within groups #389

Closed

Joozty mentioned this pull request Nov 29, 2019

Fix react props oacore/configs#14

Merged

ljharb force-pushed the alphabetize branch 2 times, most recently from aae9da7 to 8224e51 Compare December 7, 2019 00:29

ljharb closed this in 8224e51 Dec 7, 2019

ljharb merged commit 8224e51 into import-js:master Dec 7, 2019

duncanbeevers deleted the alphabetize branch December 7, 2019 02:38

ljharb mentioned this pull request Dec 9, 2019

import/order: alphabetize doesn't work correctly with group & newlines-between #1561

Closed

spong mentioned this pull request Dec 18, 2019

[SIEM] Adds actions and selection to Signals Table elastic/kibana#53101

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Alphabetize imports within groups #1105

Alphabetize imports within groups #1105

duncanbeevers commented May 17, 2018 •

edited by ljharb

Loading

coveralls commented May 18, 2018 •

edited

Loading

ljharb May 18, 2018

ljharb May 18, 2018

duncanbeevers May 18, 2018 •

edited

Loading

robwierzbowski Jan 8, 2019

dannysindra Feb 1, 2019

ljharb Feb 2, 2019

duncanbeevers commented May 22, 2018

robwierzbowski commented Jan 8, 2019

stefanmaric commented Jan 16, 2019

dannysindra commented Jan 31, 2019

ljharb commented Jan 31, 2019

dannysindra commented Feb 4, 2019 •

edited

Loading

ljharb commented Feb 4, 2019

dannysindra commented Feb 4, 2019 •

edited

Loading

ljharb commented Feb 4, 2019

dannysindra commented Feb 4, 2019

ljharb commented Feb 4, 2019

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

VincentLanglet commented Apr 19, 2019

ljharb commented May 5, 2019

kg-currenxie commented May 7, 2019

tayler-king commented May 13, 2019

stropho commented May 15, 2019 •

edited

Loading

lext-7 commented May 17, 2019

mgol May 20, 2019

stropho May 21, 2019

syashenkov commented Jun 4, 2019

stropho commented Jun 4, 2019

Alphabetize imports within groups #1105

Alphabetize imports within groups #1105

Conversation

duncanbeevers commented May 17, 2018 • edited by ljharb Loading

coveralls commented May 18, 2018 • edited Loading

ljharb May 18, 2018

Choose a reason for hiding this comment

ljharb May 18, 2018

Choose a reason for hiding this comment

duncanbeevers May 18, 2018 • edited Loading

Choose a reason for hiding this comment

robwierzbowski Jan 8, 2019

Choose a reason for hiding this comment

dannysindra Feb 1, 2019

Choose a reason for hiding this comment

ljharb Feb 2, 2019

Choose a reason for hiding this comment

duncanbeevers commented May 22, 2018

robwierzbowski commented Jan 8, 2019

stefanmaric commented Jan 16, 2019

dannysindra commented Jan 31, 2019

ljharb commented Jan 31, 2019

dannysindra commented Feb 4, 2019 • edited Loading

ljharb commented Feb 4, 2019

dannysindra commented Feb 4, 2019 • edited Loading

ljharb commented Feb 4, 2019

dannysindra commented Feb 4, 2019

ljharb commented Feb 4, 2019

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

VincentLanglet commented Apr 19, 2019

ljharb commented May 5, 2019

kg-currenxie commented May 7, 2019

tayler-king commented May 13, 2019

stropho commented May 15, 2019 • edited Loading

lext-7 commented May 17, 2019

mgol May 20, 2019

Choose a reason for hiding this comment

stropho May 21, 2019

Choose a reason for hiding this comment

syashenkov commented Jun 4, 2019

stropho commented Jun 4, 2019

duncanbeevers commented May 17, 2018 •

edited by ljharb

Loading

coveralls commented May 18, 2018 •

edited

Loading

duncanbeevers May 18, 2018 •

edited

Loading

dannysindra commented Feb 4, 2019 •

edited

Loading

dannysindra commented Feb 4, 2019 •

edited

Loading

stropho commented May 15, 2019 •

edited

Loading