Add a setting to configure skip common chunks behaviour globally #318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

fjsj merged 2 commits into django-webpack:master from hyshka:add-skip-common-chunks-setting

Jun 20, 2022

Merged

Add a setting to configure skip common chunks behaviour globally #318

fjsj merged 2 commits into django-webpack:master from hyshka:add-skip-common-chunks-setting

Jun 20, 2022

Conversation

@hyshka

Copy link

Contributor

@hyshka hyshka commented May 26, 2022 •

edited

Loading

(削除) This is untested code but I am wondering if there is an appetite for a feature like this which would allow you to set skip_common_chunks per config without having to add skip_common_chunks=True to all of your render_bundle template tags. I realize this is likely an edge case but it would be helpful to have it as a setting instead of solely a template tag option. (削除ここまで)

You can now specify a SKIP_COMMON_CHUNKS setting globally for each Webpack configuration. This will perform the same skip_common_chunks logic from the render_bundle template tag without having to add a parameter to every tag.

To maintain backwards compatibility we default to 'False' and allow common chunks to be rendered to the HTML document as script tags. In the future, it will be easy to change this default behaviour if desired.

I've added test coverage to ensure that the global setting can be overridden by the existing template tag parameter and that we maintain backward compatibility.

@fjsj

Copy link

Member

fjsj commented May 27, 2022

Thanks. Please feel free to add this global setting behavior with tests too. Please test if the skip_common_chunks arg properly overrides the settings in all cases.
In near future, we can make this the default behavior, as it is on Webpack's own html-webpack-plugin.

@hyshka

Copy link

Contributor Author

hyshka commented May 30, 2022

Ok, that sounds great, I will put something together!

@hyshka


 Add a setting to determine skip common chunks behaviour

4aa0ee3

@hyshka hyshka force-pushed the add-skip-common-chunks-setting branch from 7b4292c to 4aa0ee3 Compare

May 30, 2022 22:01

@hyshka hyshka changed the title ~~(削除) [RFC] Add a setting to determine skip common chunks behaviour (削除ここまで)~~ (追記) Add a setting to configure skip common chunks behaviour globally (追記ここまで)

May 31, 2022

@hyshka

Copy link

Contributor Author

hyshka commented May 31, 2022

@fjsj I've reworked this PR, let me know what you think of this approach.

@hyshka


 Add a setting to configure skip common chunks behaviour globally

7498eb6

You can now specify a 'SKIP_COMMON_CHUNKS' setting globally for each
Webpack configuration. This will perform the same 'skip_common_chunks'
logic from the 'render_bundle' template tag without having to add
a parameter to every tag.
To maintain backwards compatibility we default to 'False' and allow
common chunks to be rendered to the HTML document as script tags. In the
future, it will be easy to change this default behaviour if desired.
I've added test coverage to ensure that the global setting can be
override by the existing template tag parameter and that we maintain
backwards compatibility.