Undocumented option "include"

[timbednar]

I noticed that the option "include" is not documented in the readme.md https://github.com/addyosmani/critical#options or am I missing something.

[timbednar]

critical.generate({ base: 'static/', src: url, css: [cssPath], dimensions: [{ width: 320, height: 480 },{ width: 768, height: 1024 },{ width: 1280, height: 960 }], dest: destPath, minify: true, extract: false, ignore: ['font-face'], include: [/listing-/gi,/footer.footer/gi] });

[bezoerb]

oh,... this is an old option kept for compatibility reasons. it's the same as using the penthouse forceInclude option:

critical.generate({ 
  ...
  penthouse: {
    forceInclude: [/listing-/gi,/footer.footer/gi]
  },
  ...
})

[timbednar]

Is that mentioned in the readme, I did see this in some blog posts. As this option is really useful, might I suggest that some documentation of how to force include rules be added . Otherwise this issue is closed. Thanks for the explanation. /Tim

…

On Wed, Jul 7, 2021, 5:47 PM Ben Zörb ***@***.***> wrote: oh,... this is an old option kept for compatibility reasons. it's the same as using the penthouse forceInclude option: critical.generate({ ... penthouse: { forceInclude: [/listing-/gi,/footer.footer/gi] }, ...}) — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#509 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAEGG3RAV52GU4QOSHIQYHTTWTDO7ANCNFSM477NEISA> .

[bezoerb]

Sure :)
Do you want to crate a PR adding this to the readme?

[timbednar]

I will. /Tim

…

On Fri, Jul 9, 2021, 4:01 AM Ben Zörb ***@***.***> wrote: Sure :) Do you want to crate a PR adding this to the readme? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#509 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAEGG3VSXAXE2DMA3PCB6T3TW2UFJANCNFSM477NEISA> .

[dsentker]

Any progress here? I encoutered the same problem and it would be useful to let the developer know about the penthouse option.

[bezoerb]

The penthouse option is documented in the readme:
https://github.com/addyosmani/critical#options