search

webpack-contrib / file-loader

File Loader
MIT License
1.86k stars 255 forks source link

Breaking change desc in 5.0.0 can be improved #391

Closed tomaszs closed 3 years ago

tomaszs commented 3 years ago

Documentation Is:

Please Explain in Detail...

Currently it states:

https://github.com/webpack-contrib/file-loader/releases/tag/v5.0.0

switch to ES modules by default (the option esModule is true by default)

It does not say what is the impact (change from CommonJS to ES modules), and how to switch it back.

Your Proposal for Changes

Above description could be changed to:

switch from CommonJS to ES modules. You can go back to CommonJS with:

options: {
              esModule: false
            },
alexander-akait commented 3 years ago

What is confusing? We describe what was and what became

tomaszs commented 3 years ago

Was:

Is:

alexander-akait commented 3 years ago

the option esModule is true by default

instruction how to revert the breaking change (switch back to CommonJS)

Set it to false?

there is information what it means: change from CommonJS to ES modules

Sorry describing what is commonjs and es modules is out of scope our repo

Feel free to send a PR to docs if you want, sorry we don't have time on this, also we have 6.1.1, most of developers already migrate on this and no one have the problem, sorry again

tomaszs commented 3 years ago

You mean only I reported it. It does not mean no one has the problem. But I agree it is minor especially since it is about a release one year old. Anyways, it'd still take much less time than what we both have invested in this report

alexander-akait commented 3 years ago

@tomaszs feel free to send a PR