New: ES Module Compatibility #43

evanplaice · 2019-10-06T01:38:12Z

On Hold: This RFC is on hold until Node unflags ES modules

Summary

JS-based ESLint configurations break when used in an ESM-based package. This RFC documents the specifics outlining the cause of the break as well as a forward-compatible fix.

Related Issues

~~ERR_REQUIRE_ESM when requiring .eslintrc.js eslint#12319 - ERR_REQUIRE_ESM when requiring .eslintrc.js~~
Update: support .eslintrc.cjs (refs eslint/rfcs#43) eslint#12321 - Fix: ES module compatibility
Fix: Load CommonJS .eslintrc.js files within a "type": "module" package scope (fixes #12319) eslint#12333 - Fix: Load CommonJS .eslintrc.js files within a "type": "module" package scope (fixes #12319)
Transition Path Problems For Tooling nodejs/modules#388 - Transition Path Problems For Tooling

mysticatea

Thank you for your contribution!

I have some suggestions.

And, ESLint doesn't support experimental stuff basically. I believe that we must wait for the stable release of ES modules in Node in order to accept this RFC.

designs/2019-esm-compatibilty/README.md

mysticatea · 2019-10-06T06:28:47Z

designs/2019-esm-compatibilty/README.md

+*/lib/cli-engine/config-array-factory.js*
+
+```diff
+function loadConfigFile(filePath) {


This function doesn't affect how ESLint finds config files. We should update the finding logic.

I could use some help w/ this, I'm not very familiar w/ the core internals other than what I've been able to find so far.

Actually, RFCs don't need to include implementation :)

For a reference, this array is the order to find config files. ESLint checks files in the array one by one then adopts the first found one.

Therefore the current priority is:

.eslintrc.js

.eslintrc.yaml

.eslintrc.yml

.eslintrc.json

.eslintrc

package.json

This RFC should include how it changes this priority because it's a user-facing change.

And the priority is documented in the "Configuration File Formats" section. The "Documentation" section in this RFC should include it.

The required change would put .eslintrc.cjs at priority 1. In short, it's an 'escape hatch' that will primarily impact users who use "type": "module" and .eslintrc style configs.

I'll see if I can clarify the descriptions and reserve implementation specifics for the related PR.

In this case it'll become:

.eslintrc.cjs

.eslintrc.js

.eslintrc.yaml

.eslintrc.yml

.eslintrc.json

.eslintrc

package.json

The implementation specifics have been removed in the RFC, this change will be added to the PR instead.

Would you include the priority change in this RFC? And would you add about we need to update the "Configuration File Formats" section to the Documentation section of this RFC?

Done. See Revision 5.

designs/2019-esm-compatibilty/README.md

evanplaice · 2019-10-10T22:56:38Z

And, ESLint doesn't support experimental stuff basically. I believe that we must wait for the stable release of ES modules in Node in order to accept this RFC.

I assumed as much. If all goes well, ESM support should roll out later this month. Can this RFC be tagged as 'onhold' until then?

- fix RFC ref - rewrite summary, less fluff more substance - use the correct config filenames - remove alternative 3 (NA) - add a ref to the issue that spawned this RFC

jkrems · 2019-10-14T15:46:51Z

And, ESLint doesn't support experimental stuff basically. I believe that we must wait for the stable release of ES modules in Node in order to accept this RFC.

Please note that the error already had landed in a stable version of node (not behind a flag). We rolled that change back because of issues in ESLint and babel. So if not for eslint, it would still be in a stable version. We're currently counting on ESLint to add the necessary fixes so we can ship the feature again.

mysticatea · 2019-10-15T01:42:45Z

@jkrems That has been reverted in 12.11.1.

jkrems · 2019-10-15T01:49:44Z

That has been reverted in 12.11.1.

Not sure I’m following. In case there’s a misunderstanding: when I said “rolled back”, I think I meant the same thing as you mean by “reverted”. Unless you were trying to add more details about the affected versions. :)

…

On Mon, Oct 14, 2019 at 6:42 PM Toru Nagashima ***@***.***> wrote: @jkrems <https://github.com/jkrems> That has been reverted in 12.11.1. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#43?email_source=notifications&email_token=AAEKR5A2NYWNX2W5EGTRV2DQOUNZPA5CNFSM4I52B3YKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEBHD2JI#issuecomment-541998373>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAEKR5G3WIFIUV3P4Y733C3QOUNZPANCNFSM4I52B3YA> .

mysticatea · 2019-10-15T02:00:30Z

Oh, sorry, I had misunderstood you.

I had thought that the change has been reverted because it's a breaking change and to wait for ES modules gets stable. But in fact, the change has been reverted to wait for tools are fixed?

jkrems · 2019-10-15T14:34:42Z

I had thought that the change has been reverted because it's a breaking change and to wait for ES modules gets stable. But in fact, the change has been reverted to wait for tools are fixed?

The change is in that gray area of "is this breaking?" that comes with new features that people have tried polyfilling already. People used polyfills (e.g. via the esm package or babel transforms) to already use type: module today but those aren't actually behaving like the real thing. So when we tried to roll out the first piece of the real thing, those people ran into issues (like the eslint config files). The rollback was mostly meant to give people a second chance to prepare. But .cjs is here to stay or rather already de-facto exists[1] and we are working from the assumption that it will be supported by tools.

[1] "Already de-facto exists" because using any random file extension for CommonJS always worked... :D

platinumazure · 2019-10-15T15:50:47Z

@jkrems Could you please explain what exactly would need to change in ESLint to support this (under the assumption that Node is actually trying to release this now)? If that's already covered somewhere, please feel free to link. Thanks!

jkrems · 2019-10-15T15:58:07Z

@platinumazure I think this proposal ("support .eslintrc.cjs") would be sufficient to unblock users. Right now they don't have a way to provide a CommonJS config to eslint from within a type:module package because the only extension eslint recognizes (.js) isn't valid for CommonJS in that context. We're softening invalid CommonJS requires to a warning (nodejs/node#29909) to provide some visibility before bringing back the exception. The warning is nudging users towards .cjs if they have the choice.

There is the separate question if eslint wants to recognize config files written as modules but I don't think that has to be addressed with the same urgency.

platinumazure

I've identified only 1-2 real issues/questions that need to be addressed here.

That said, I also put on my editor hat and made a number of minor suggestions which you can accept or ignore as you please. 😄

Let me know if you need clarification on which changes are "blocking" vs "non-blocking" in my view. Thanks!

designs/2019-esm-compatibilty/README.md

platinumazure · 2019-10-15T16:13:19Z

Thanks @jkrems for the explanation, it was really helpful.

I've reviewed this RFC based on my current understanding of the proposal and background. It is possible I am misunderstanding something-- if so, I greatly appreciate your patience as we work through this process together. (I also made some minor suggestions which I think might improve readability.)

jkrems · 2019-10-15T17:00:41Z

Thanks for taking your time to help review this proposal, it's much appreciated. :) I can definitely understand reservations about jumping the gun on experimental features. This situation would've been less painful and we could've saved a rollback if people didn't start using type:module before node started shipping it (so 👍 to being a bit conservative).

Happy to help work this out! I think there were also people from the nodejs/modules side eager to help with implementation once the RFC has stabilized.

evanplaice · 2019-10-15T20:49:52Z

There is the separate question if eslint wants to recognize config files written as modules but I don't think that has to be addressed with the same urgency.

Just to be clear. This RFC does not address defining the configuration as an ES module. This only addresses making existing ESLint configurations compatible with the new module format.

I'll add a mention in the RFC to address this.

@platinumazure Thank you for reviewing this. Feel free to nit as much as you feel necessary. I'll try my best to dilute the minutiae as much as possible so it's palatable to a more general audience.

- fix nits and spelling errors - rewite the intro again for clarity - change future to present tense - rewrite 'Motivation' to be more concise - remove implementation specifics - add FAQ covering ESM-based configs - add reference to the implementation PR

designs/2019-esm-compatibilty/README.md

- fix more nits - correct the name/link to the related issue

designs/2019-esm-compatibilty/README.md

- fix grammatical mistake

platinumazure

Looks good from my perspective. Thanks!

Mention configuration loader priority

ljharb · 2019-10-25T22:34:56Z

designs/2019-esm-compatibilty/README.md

+6. .eslintrc
+7. package.json
+
+`.cjs` is placed higher than `.js` because -- unlike the latter -- `.cjs` does not allow for ambiguity. A `.cjs` file is always interpreted as CommonJS regardless of context.


to be clear, .js is always and by default unambiguously CJS, unless in a package.json boundary with "type": "module", when it's unambiguously ESM.

to be clear, .js is always and by default unambiguously CJS, unless in a package.json boundary with "type": "module", when it's unambiguously ESM.

I think that's adding an assumption to the sentence it didn't contain before: That we know anything but "this one file has the extension .cjs". With only that information, it is ambiguous in exactly the way you describe. :)

(It may be confusing that in other contexts we have used "ambiguous" to describe the problem of files being ambiguous even given all metadata we could possibly look at.)

Removed explanation in Revision 6

@jkrems a node tool always has the additional default context "based on node's resolution algorithm" :-)

Publishing `@guardian/cdk` in ESM format is tricky as additional tooling required by consumers such as [ts-node](TypeStrong/ts-node#1007) (see also [this](TypeStrong/ts-node#935)), [ESLint](eslint/rfcs#43) and [Jest](https://jestjs.io/docs/ecmascript-modules) have varying support. It is easiest to stay on CommonJS. We'll have to stay on v7.0.1 of `read-pkg-up` to achieve this; v8.0.0 doesn't bring any new features or fixes, so this is safe.

New: ES Module Compatibility

e224c34

eslint-deprecated bot added the triage label Oct 6, 2019

mysticatea added Initial Commenting This RFC is in the initial feedback stage and removed triage labels Oct 6, 2019

mysticatea suggested changes Oct 6, 2019

View reviewed changes

Revision 1

44cc3ad

- fix RFC ref - rewrite summary, less fluff more substance - use the correct config filenames - remove alternative 3 (NA) - add a ref to the issue that spawned this RFC

mysticatea added the on hold This RFC is awaiting upstream updates. label Oct 13, 2019

platinumazure suggested changes Oct 15, 2019

View reviewed changes

evanplaice mentioned this pull request Oct 15, 2019

Update: support .eslintrc.cjs (refs eslint/rfcs#43) eslint/eslint#12321

Merged

Revision 2

27f69f4

- fix nits and spelling errors - rewite the intro again for clarity - change future to present tense - rewrite 'Motivation' to be more concise - remove implementation specifics - add FAQ covering ESM-based configs - add reference to the implementation PR

evanplaice force-pushed the 2019-esm-compatibility branch from 421aa8e to 27f69f4 Compare October 15, 2019 23:05

platinumazure suggested changes Oct 16, 2019

View reviewed changes

designs/2019-esm-compatibilty/README.md Outdated Show resolved Hide resolved

Revision 3

028bbd8

- fix more nits - correct the name/link to the related issue

ljharb reviewed Oct 16, 2019

View reviewed changes

designs/2019-esm-compatibilty/README.md Outdated Show resolved Hide resolved

Revision 4

d8e3f12

- fix grammatical mistake

platinumazure approved these changes Oct 18, 2019

View reviewed changes

Revision 5

77eef25

Mention configuration loader priority

platinumazure approved these changes Oct 25, 2019

View reviewed changes

ljharb reviewed Oct 25, 2019

View reviewed changes

snyk-bot mentioned this pull request Jun 27, 2020

[Snyk] Upgrade eslint from 6.6.0 to 6.8.0 WealthWizardsEngineering/service-registry#20

Merged

snyk-bot mentioned this pull request Jul 7, 2020

[Snyk] Upgrade eslint from 6.6.0 to 6.8.0 rlodhiya2502/generator-angular-fullstack#3

Open

This was referenced Aug 12, 2020

[Snyk] Upgrade eslint from 6.2.0 to 6.8.0 turkdevops/lodash#4

Open

[Snyk] Upgrade eslint from 6.4.0 to 6.8.0 intelligogroup/eslint-config#4

Open

This was referenced Sep 3, 2020

[Snyk] Upgrade eslint from 6.7.1 to 6.8.0 EvangelosKolimitras/budget-app#9

Open

[Snyk] Upgrade eslint from 6.6.0 to 6.8.0 jeffn12/jeffn12#10

Merged

snyk-bot mentioned this pull request Oct 8, 2020

[Snyk] Upgrade eslint from 6.1.0 to 6.8.0 Jankyboy/levee#1

Open

snyk-bot mentioned this pull request Oct 25, 2020

[Snyk] Upgrade eslint from 6.0.1 to 6.8.0 josebrusa/PlatziVideo#2

Open

snyk-bot mentioned this pull request Nov 17, 2020

[Snyk] Upgrade eslint from 6.0.0 to 6.8.0 18F/identity-monitor#98

Open

mdjermanovic mentioned this pull request Nov 18, 2020

Docs: Reorganize Configuration Documentation eslint/eslint#13837

Merged

This was referenced Dec 2, 2020

[Snyk] Upgrade eslint from 6.3.0 to 6.8.0 WealthWizardsEngineering/version-service#22

Merged

[Snyk] Upgrade eslint from 6.2.2 to 6.8.0 tromgy/swagger-yaml-to-json-schema#23

Merged

mdjermanovic mentioned this pull request Dec 11, 2020

Cannot load CJS custom rules with rulesdir when project is "type": "module" eslint/eslint#13921

Closed

This was referenced Jan 4, 2021

[Snyk] Upgrade eslint from 6.6.0 to 6.8.0 aahutsal/ts-aws-tracking-pixel#15

Merged

[Snyk] Upgrade eslint from 6.7.2 to 6.8.0 Yrkki/cv-generator-life-map#15

Closed

akash1810 mentioned this pull request Mar 31, 2021

fix: compile to commonjs guardian/cdk#369

Merged

snyk-bot mentioned this pull request Jun 2, 2021

[Snyk] Upgrade eslint from 6.2.1 to 6.8.0 cloudability/javascript-style-guide#15

Open

snyk-bot mentioned this pull request Aug 11, 2021

[Snyk] Upgrade eslint from 6.0.1 to 6.8.0 aguirrejuanse/PlatziVideo-SSR#3

Open

snyk-bot mentioned this pull request Apr 13, 2022

[Snyk] Upgrade eslint from 6.5.1 to 6.8.0 newrelic/labeler#4

Open

cleancoindev mentioned this pull request May 14, 2022

[Snyk] Upgrade eslint from 6.0.1 to 6.8.0 cleancoindev/rcn-oracle#1

Open

RoshanRajapakse mentioned this pull request Feb 16, 2023

[Snyk] Upgrade eslint from 6.6.0 to 6.8.0 RoshanRajapakse/katello#2

Open

JozGonzalez mentioned this pull request Aug 21, 2023

[Snyk] Upgrade eslint from 6.3.0 to 6.8.0 JozGonzalez/earthengine-community#6

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New: ES Module Compatibility #43

New: ES Module Compatibility #43

evanplaice commented Oct 6, 2019 •

edited

mysticatea left a comment

mysticatea Oct 6, 2019

evanplaice Oct 10, 2019

mysticatea Oct 11, 2019

mysticatea Oct 11, 2019

evanplaice Oct 15, 2019

evanplaice Oct 15, 2019

mysticatea Oct 18, 2019

evanplaice Oct 25, 2019

evanplaice commented Oct 10, 2019

jkrems commented Oct 14, 2019 •

edited

mysticatea commented Oct 15, 2019

jkrems commented Oct 15, 2019 via email

mysticatea commented Oct 15, 2019

jkrems commented Oct 15, 2019

platinumazure commented Oct 15, 2019

jkrems commented Oct 15, 2019

platinumazure left a comment

platinumazure commented Oct 15, 2019

jkrems commented Oct 15, 2019

evanplaice commented Oct 15, 2019

platinumazure left a comment

ljharb Oct 25, 2019

jkrems Oct 25, 2019

jkrems Oct 25, 2019

evanplaice Oct 25, 2019

ljharb Oct 25, 2019

New: ES Module Compatibility #43

New: ES Module Compatibility #43

Conversation

evanplaice commented Oct 6, 2019 • edited

Summary

Related Issues

mysticatea left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

evanplaice commented Oct 10, 2019

jkrems commented Oct 14, 2019 • edited

mysticatea commented Oct 15, 2019

jkrems commented Oct 15, 2019 via email

mysticatea commented Oct 15, 2019

jkrems commented Oct 15, 2019

platinumazure commented Oct 15, 2019

jkrems commented Oct 15, 2019

platinumazure left a comment

Choose a reason for hiding this comment

platinumazure commented Oct 15, 2019

jkrems commented Oct 15, 2019

evanplaice commented Oct 15, 2019

platinumazure left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

evanplaice commented Oct 6, 2019 •

edited

jkrems commented Oct 14, 2019 •

edited