CKBUILDER(1)

✨ CKBUILDER ✨

okay bestie, so this is ckbuilder β€” the command line builder for CKEditor πŸŽ€ it lives in the ckbuilder section 1 of the manual (commands, iykyk).


πŸ’– NAME πŸ’–

ckbuilder β€” command line builder for CKEditor πŸ’…


🌸 DESCRIPTION 🌸

It creates a CKEditor build in the DST folder using the source files from the SRC folder πŸ¦‹

And listen, there's a lil prerequisite situation: the build configuration file (build-config.js) is required in order to create the build package, and it's the thing that holds the list of plugins to include πŸ“‹ no config file, no build, periodt.


🌈 SYNOPSIS 🌈

ckbuilder --build SRC DST (options...)

ckbuilder --build-skin SRC DST (options...)

ckbuilder --generate-build-config SRC (options...)

✨ OPTIONS ✨

  • --build β€” Creates a release version of a skin. (yes that's what it says, bestie, I'm just the messenger πŸ™ˆ)
  • --build-skin β€” Creates a release version of a skin.
  • --generate-build-config SRC (options...) β€” Creates build configuration file (default: build-config.js).
  • --build-config <FILE> β€” path to the file
  • --version <NUMBER> β€” version number
  • --revision <NUMBER> β€” revision number
  • --overwrite β€” overwrite target folder if exists
  • -s,--skip-omitted-in-build-config β€” exclude from release all plugins/skins that are not specified in build-config
  • --leave-js-unminified β€” leave javascript files as is: merge, but do not minify.
  • --leave-css-unminified β€” leave CSS files as is: merge, but do not minify.
  • --no-ie-checks β€” turn off warnings about syntax errors on Internet Explorer, like trailing commas.
  • --core β€” create only the core file (ckeditor.js)
  • --no-zip β€” do not create zip file
  • --no-tar β€” do not create tar.gz file (default)
  • --commercial β€” builds a package with commercial license
  • -d, --debug-level <LEVEL> β€” debug level (0, 1, 2).
  • --help β€” prints help information
  • --build-help β€” prints help information about build configuration
  • --full-help β€” prints help information about all advanced commands

🧚 EXAMPLES 🧚

like, literally copy-paste these, they ate πŸ”₯

ckbuilder --build ckeditor-dev release --version 4.0

ckbuilder --build-skin skins/myskin target_dir

ckbuilder --generate-build-config ckeditor-dev

ngl, --no-tar is the default, so if you're out here wanting a tar.gz you gotta do the extra thing πŸ’€ and --no-ie-checks is only about silencing those IE syntax warnings, not about magic-ing your code into being valid 🫢

that's the whole vibe check, bestie πŸ‘‘ ckbuilder 2.3.0, from February 2016 β€” go forth and build something iconic πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from