@ckeditor/ckeditor5-dev-utils

function getDllPluginWebpackConfig

getDllPluginWebpackConfig: (
    webpack: WebpackOptions,
    options: GetDllPluginWebpackConfigOptions
) => Promise<DllWebpackConfig>;

• Returns a webpack configuration that creates a bundle file for the specified package. Thanks to that, plugins exported by the package can be added to DLL builds.

  Returns

  {object}

function getLicenseBanner

getLicenseBanner: () => string;

• Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved. For licensing, see LICENSE.md.

function getCoverageLoader

getCoverageLoader: ({
    files,
}: {
    files: Array<Array<string>>;
}) => CoverageLoaderConfig;

function getDebugLoader

getDebugLoader: (debugFlags: Array<string>) => DebugLoaderOptions;

• Parameter debugFlags

  Returns

  {object}

function getFormattedTextLoader

getFormattedTextLoader: () => { test: RegExp; use: Array<string> };

• Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved. For licensing, see LICENSE.md.

function getIconsLoader

getIconsLoader: ({ matchExtensionOnly }?: { matchExtensionOnly?: boolean }) => {
    test: RegExp;
    use: Array<string>;
};

• Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved. For licensing, see LICENSE.md.

function getJavaScriptLoader

getJavaScriptLoader: ({
    debugFlags,
}: {
    debugFlags: Array<string>;
}) => JavaScriptLoaderOptions;

function getStylesLoader

getStylesLoader: (options: GetStylesLoaderOptions) => StylesLoader;

function getTypeScriptLoader

getTypeScriptLoader: (options?: TypeScriptLoaderOptions) => TypeScriptLoader;

function checkVersionAvailability

checkVersionAvailability: (
    version: string,
    packageName: string
) => Promise<boolean>;

• Checks if a specific version of a package is available in the npm registry.

function manifest

manifest: (
    spec: string,
    opts?: pacote.Options | undefined
) => Promise<pacote.AbbreviatedManifest & pacote.ManifestResult>;

function packument

packument: (
    spec: string,
    opts?: pacote.Options | undefined
) => Promise<
    { versions: Record<string, pacote.AbbreviatedManifest> } & Pick<
        pacote.Packument,
        'name' | 'dist-tags'
    > &
        pacote.PackumentResult
>;

function noop

noop: (callback?: (chunk: unknown) => unknown | Promise<unknown>) => Transform;

function getPostCssConfig

getPostCssConfig: (options?: GetPostCssConfigOptions) => PostCssConfig;

• Returns a PostCSS configuration to build the editor styles (e.g., used by postcss-loader).

function themeImporter

themeImporter: typeof themeImporter;

• A PostCSS plugin that loads a theme files from specified path.

  For any CSS file processed by the PostCSS, this plugin tries to find a complementary theme file and load it (knowing the path to the theme). Theme files must be organized to reflect the structure of the CSS files in editor packages,

  E.g., if the path to the theme is: /foo/bar/ckeditor5-theme-foo/theme/theme.css

  and the CSS to be themed is: /baz/qux/ckeditor5-qux/theme/components/button.css

  the theme file for button.css should be located under: /foo/bar/ckeditor5-theme-foo/ckeditor5-qux/theme/components/button.css

  See the ThemeImporterOptions to learn about importer options.

  To learn more about PostCSS plugins, please refer to the API [documentation](http://api.postcss.org/postcss.html#.plugin) of the project.

variable postcss

var postcss: boolean;

function commit

commit: ({
    cwd,
    message,
    files,
    dryRun,
}: {
    cwd: string;
    message: string;
    files: Array<string>;
    dryRun?: boolean;
}) => Promise<void>;

• Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved. For licensing, see LICENSE.md.

function createSpinner

createSpinner: (
    title: string,
    options?: CreateSpinnerOptions
) => CKEditor5Spinner;

• A factory function that creates an instance of a CLI spinner. It supports both a spinner CLI and a spinner with a counter.

  The spinner improves UX when processing a time-consuming task. A developer does not have to consider whether the process hanged on.

  Parameter title

  Description of the current processed task.

  Parameter options

function getDirectories

getDirectories: (directoryPath: string) => Array<string>;

• Returns array with all directories under the specified path.

function shExec

shExec: {
    (command: string, options: { async: true } & ShExecOptions): Promise<string>;
    (command: string, options?: { async?: false } & ShExecOptions): string;
};

function updateJSONFile

updateJSONFile: (
    filePath: string,
    updateFunction: (json: object) => object
) => void;

• Updates JSON file under a specified path.

  Parameter filePath

  Path to a file on disk.

  Parameter updateFunction

  Function that will be called with a parsed JSON object. It should return the modified JSON object to save.

function findPathsToPackages

findPathsToPackages: (
    cwd: string,
    packagesDirectory: string | null,
    options?: Options
) => Promise<Array<string>>;

• This function locates package.json files for all packages located in packagesDirectory in the repository structure.

function getPackageJson

getPackageJson: {
    (cwd: string, options: { async: true }): Promise<PackageJson>;
    (cwd: string, options?: { async?: false }): PackageJson;
};

function getRepositoryUrl

getRepositoryUrl: {
    (cwd: string, options: { async: true }): Promise<string>;
    (cwd: string, options?: { async?: false }): string;
};

• Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved. For licensing, see LICENSE.md.