cdbaf6a4-9078-48d2-be37-d8185abc2a83

Committed 05 May 2025 12:01PM UTC coverage: 89.432% (+0.5%) from 88.905%

Build # cdbaf6a4-9078-48d2-be37-d8185abc2a83

Build Type

push

circleci

Committed by

web-flow

Commit Message

Merge pull request #1091 from ckeditor/ck/epic/15619-typedoc-28

Other (typedoc-plugins): Introduced the `validate()` function that checks if the converted documentation is error-free.

The following cases are verified:

* An event in the `@fires` tag exists.
* An identifier in the `@link` tag points to an existing doclet.
* A module name matches the path to the file where the module is defined.
* Overloaded methods and functions are described with the mandatory and unique `@label` tag.
* An identifier in the `@see` tag points to an existing doclet.

Feature (docs): Support for `typedoc@0.28`. The package uses the latest (`0.28.4`) TypeDoc release when introducing this change.

Other (typedoc-plugins): Improved processing parameters of the CKEditor 5 error definitions.

MAJOR BREAKING CHANGE (docs): The API docs builder requires `typedoc` in version 0.28 or higher.

MAJOR BREAKING CHANGE (typedoc-plugins): The TypeDoc plugins require the `typedoc` dependency in a version `0.28` or higher.

MAJOR BREAKING CHANGE (typedoc-plugins): CKEditor 5 events are stored in the `#ckeditor5Events` property on a class or interface declaration.

MAJOR BREAKING CHANGE (typedoc-plugins): CKEditor 5 errors can be recognized by the `#isCKEditor5Error` flag on a declaration.

MINOR BREAKING CHANGE (docs): The `strict` option passed as a modifier to the `build()` function should be wrapped into the `validatorOptions` object.

MINOR BREAKING CHANGE (typedoc-plugins): Parameters of CKEditor 5 events and errors are now stored in the `#parameters` property (instead of `#typeParameters`).

Run Details

1880 of 1955 branches covered (96.16%)

Branch coverage included in aggregate %.

998 of 1043 new or added lines in 34 files covered. (95.69%)

10712 of 12125 relevant lines covered (88.35%)

27.2 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

78.57

/packages/typedoc-plugins/src/utils/isreflectionvalid.ts

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

import type { Reflection } from 'typedoc';

/**
 * Checks if the reflection can be considered as "valid" (supported). Only reflections that are not nested inside a type are supported.
 */
export function isReflectionValid( reflection: Reflection ): boolean {
        if ( reflection.name === '__type' ) {
                return false;
        }

        if ( reflection.parent ) {
                return isReflectionValid( reflection.parent );
        }

        return true;
}

1	/**	1✔
2	* @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
3	* For licensing, see LICENSE.md.
4	*/
5
6	import type { Reflection } from 'typedoc';
7
8	/**
9	* Checks if the reflection can be considered as "valid" (supported). Only reflections that are not nested inside a type are supported.
10	*/
11	export function isReflectionValid( reflection: Reflection ): boolean {	1✔
12	if ( reflection.name === '__type' ) {	298!
NEW 13	return false;	×
NEW 14	}	×
15
16	if ( reflection.parent ) {	298✔
17	return isReflectionValid( reflection.parent );	219✔
18	}	219✔
19
20	return true;	79✔
21	}	79✔

ckeditor / ckeditor5-dev / cdbaf6a4-9078-48d2-be37-d8185abc2a83

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous