Builder Ignores Plugin

[bmulholland]

Hi, I have a build-config.js that includes plugins like autogrow and sourcearea. However, when I run build.sh (locally or via the website) those plugins are not included.

Here's a filtered git diff after the update:

deleted: vendor/assets/javascripts/ckeditor/plugins/autogrow/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/contextmenu/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/floatpanel/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/font/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/format/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/indent/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/indentblock/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/indentlist/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/justify/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/lineutils/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/listblock/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/magicline/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/menu/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/panel/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/pastefromword/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/removeformat/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/richcombo/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/sourcearea/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/table/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/tabletools/plugin.js deleted: vendor/assets/javascripts/ckeditor/plugins/widget/plugin.js

[bmulholland]

build config

[Piotrek Koszuliński]

Those plugins are merged into ckeditor.js. If plugin has no other files than plugin.js, then entire directory is removed. That's what building means - it combines as much files together.

[bmulholland]

Oh cool! Does that mean that I don't need to include them in extraPlugins anymore? Do I need to include them in extraPlugins if there are extra files (and hence a directory)? Where could I find more information on this subject?

Thanks Reinmar!

[Piotrek Koszuliński]

All plugins that are specified in build config are enabled by default, so you don't need to specify them in extraPlugins. I cannot find it explained clearly in the documentation, perhaps because it's easily verifiable. However, you may find some information here ​http://docs.ckeditor.com/#!/guide/dev_build

[bmulholland]

Turns out that autogrow was NOT included in the ckeditor.js. Unfortunately it took a production deploy before we figured that out, and functionality that required it stopped working.

All other plugins were included but autogrow certainly was not. Any idea why this might have happened?

[Piotrek Koszuliński]

Do you mean that you built a CKEditor package from the build config which you attached using command line builder and there's no autogrow plugin included in the package? How do you verify whether autogrow is included? Did you use ​https://github.com/ckeditor/ckeditor-dev repo or ​https://github.com/ckeditor/ckeditor-presets?

[bmulholland]

Hi Reinmar,

Thanks for replying.

I used ckeditor-dev, release/4.3.x branch.

My build config was as attached to this ticket, which includes autogrow.

I know autogrow wasn't included because the editor did not autogrow. It started as a fixed size and did not expand past that initial fixed size. Downloading autogrow as a separate plugin and adding it to extraPlugins corrected the behaviour so that the editor expanded to the appropriate height, as expected.

I also tried searching the generated ckeditor.js for the string "autogrow" with no results.

Thanks again, Brendan

[Piotrek Koszuliński]

I downloaded your build config into the dev/builder/build-config.js, built package, opened first sample and autogrow was enabled and was working. Without extraPlugins usage, without downloading plugin.

[bmulholland]

Okay, I have figured it out. To reproduce this issue, *specify the -s flag*.

Although the documentation says the following:

-s,--skip-omitted-in-build-config

exclude from release all plugins/skins that are not specified in build-config

It appears to NOT include the autogrow plugin even if it's specified in the build-config.

[Piotrek Koszuliński]

I'm sorry, but no luck. I used this flag and still autogrow is included. Are you sure that builder loads correct build config? Maybe it loads the build-config.js file, as build.sh does by default, and your has a different name? Note that passing --build-config to build.sh will not work, because build.sh always uses build-config.js.

[Jakub Ś]

I have also test this and got same results as @Reinmar.

[bmulholland]

Reinmar, that was it! It was using the build-config.js in the directory and completely ignoring my passed in build-config argument.

That seems like a bug in the documentation to me, and a very frustrating one at that. The help message should not reflect an argument that has no effect! I don't know how on earth I would have figured it out without you mentioning it as an aside.

[Piotrek Koszuliński]

Yes, I agree. It's confusing why the same flags which --help shows do not work with build.sh.

[Artur Delura]

Fixed on ​git:a8fe468.

Now, when running build.sh you can parametrize options like build-config. We also open-sourced CKBuilder: ​https://github.com/ckeditor/ckbuilder