@ckeditor/ckeditor5-dev-docs 32.0.1 → 32.1.0

package/lib/build.js

@@ -5,98 +5,60 @@
 
 'use strict';
 
-const fs = require( 'fs-extra' );
-const tmp = require( 'tmp' );
-const glob = require( 'fast-glob' );
-const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
-
 /**
  * Builds CKEditor 5 documentation.
  *
- * @param {Object} config
- * @param {Array.<String>} config.sourceFiles Glob pattern with source files.
- * @param {String} config.readmePath Path to `README.md`.
- * @param {Boolean} [config.validateOnly=false] Whether JSDoc should only validate the documentation and finish
- * with error code `1`. If not passed, the errors will be printed to the console but the task will finish with `0`.
- * @param {Boolean} [config.strict=false] If `true`, errors found during the validation will finish the process
- * and exit code will be changed to `1`.
- * @param {String} [config.outputPath] A path to the place where extracted doclets will be saved.
- * @param {String} [config.extraPlugins] An array of path to extra plugins that will be added to JSDoc.
- *
+ * @param {JSDocConfig|TypedocConfig} config
  * @returns {Promise}
  */
 module.exports = async function build( config ) {
-	const sourceFilePatterns = [
-		config.readmePath,
-		...config.sourceFiles
-	];
-
-	const extraPlugins = config.extraPlugins || [];
-	const outputPath = config.outputPath || 'docs/api/output.json';
-	const validateOnly = config.validateOnly || false;
-	const strictCheck = config.strict || false;
-
-	// Pass options to plugins via env variables.
-	// Since plugins are added using `require` calls other forms are currently impossible.
-	process.env.JSDOC_OUTPUT_PATH = outputPath;
-
-	if ( validateOnly ) {
-		process.env.JSDOC_VALIDATE_ONLY = 'true';
+	const type = config.type || 'jsdoc';
+
+	if ( type === 'jsdoc' ) {
+		return require( './buildjsdoc' )( config );
+	} else if ( type === 'typedoc' ) {
+		return require( './buildtypedoc' )( config );
+	} else {
+		throw new Error( `Unknown documentation tool (${ type }).` );
 	}
+};
 
-	if ( strictCheck ) {
-		process.env.JSDOC_STRICT_CHECK = 'true';
-	}
-
-	const files = await glob( sourceFilePatterns );
-
-	const jsDocConfig = {
-		plugins: [
-			require.resolve( 'jsdoc/plugins/markdown' ),
-			require.resolve( '@ckeditor/jsdoc-plugins/lib/purge-private-api-docs' ),
-			require.resolve( '@ckeditor/jsdoc-plugins/lib/export-fixer/export-fixer' ),
-			require.resolve( '@ckeditor/jsdoc-plugins/lib/custom-tags/error' ),
-			require.resolve( '@ckeditor/jsdoc-plugins/lib/custom-tags/observable' ),
-			require.resolve( '@ckeditor/jsdoc-plugins/lib/observable-event-provider' ),
-			require.resolve( '@ckeditor/jsdoc-plugins/lib/longname-fixer/longname-fixer' ),
-			require.resolve( '@ckeditor/jsdoc-plugins/lib/fix-code-snippets' ),
-			require.resolve( '@ckeditor/jsdoc-plugins/lib/relation-fixer' ),
-			require.resolve( '@ckeditor/jsdoc-plugins/lib/event-extender/event-extender' ),
-			require.resolve( '@ckeditor/jsdoc-plugins/lib/cleanup' ),
-			require.resolve( '@ckeditor/jsdoc-plugins/lib/validator/validator' ),
-			require.resolve( '@ckeditor/jsdoc-plugins/lib/utils/doclet-logger' ),
-			...extraPlugins
-		],
-		source: {
-			include: files
-		},
-		opts: {
-			encoding: 'utf8',
-			recurse: true,
-			access: 'all',
-			template: 'templates/silent'
-		}
-	};
-
-	const tmpConfig = tmp.fileSync();
-
-	await fs.writeFile( tmpConfig.name, JSON.stringify( jsDocConfig ) );
-
-	console.log( 'JSDoc started...' );
-
-	try {
-		// Not so beautiful API as for 2020...
-		// See more in https://github.com/jsdoc/jsdoc/issues/938.
-		const cmd = require.resolve( 'jsdoc/jsdoc.js' );
-
-		// The `node` command is used for explicitly needed for Windows.
-		// See https://github.com/ckeditor/ckeditor5/issues/7212.
-		tools.shExec( `node ${ cmd } -c ${ tmpConfig.name }`, { verbosity: 'info' } );
-	} catch ( error ) {
-		console.error( 'An error was thrown by JSDoc:' );
-
-		throw error;
-	}
+/**
+ * @typedef {Object} JSDocConfig
+ *
+ * @property {'jsdoc'} type
+ *
+ * @property {Array.<String>} sourceFiles Glob pattern with source files.
+ *
+ * @property {String} readmePath Path to `README.md`.
+ *
+ * @property {Boolean} [validateOnly=false] Whether JSDoc should only validate the documentation and finish
+ * with error code `1`. If not passed, the errors will be printed to the console but the task will finish with `0`.
+ *
+ * @property {Boolean} [strict=false] If `true`, errors found during the validation will finish the process
+ * and exit code will be changed to `1`.
+ *
+ * @property {String} [outputPath='docs/api/output.json'] A path to the place where extracted doclets will be saved.
+ *
+ * @property {String} [extraPlugins=[]] An array of path to extra plugins that will be added to JSDoc.
+ */
 
-	console.log( `Documented ${ files.length } files!` );
-};
+/**
+ * @typedef {Object} TypedocConfig
+ *
+ * @property {'typedoc'} type
+ *
+ * @property {Object} config
+ *
+ * @property {String} cwd
+ *
+ * @property {String} tsconfig
+ *
+ * @property {Array.<String>} sourceFiles Glob pattern with source files.
+ *
+ * @property {Boolean} [strict=false] If `true`, errors found during the validation will finish the process
+ * and exit code will be changed to `1`.
+ * @property {String} [outputPath] A path to the place where extracted doclets will be saved. Is an optional value due to tests.
+ *
+ * @property {String} [extraPlugins=[]] An array of path to extra plugins that will be added to Typedoc.
+ */

package/lib/buildjsdoc.js

@@ -0,0 +1,93 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const fs = require( 'fs-extra' );
+const tmp = require( 'tmp' );
+const glob = require( 'fast-glob' );
+const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
+
+/**
+ * Builds CKEditor 5 documentation using `jsdoc`.
+ *
+ * @param {JSDocConfig} config
+ * @returns {Promise}
+ */
+module.exports = async function build( config ) {
+	const sourceFilePatterns = [
+		config.readmePath,
+		...config.sourceFiles
+	];
+
+	const extraPlugins = config.extraPlugins || [];
+	const outputPath = config.outputPath || 'docs/api/output.json';
+	const validateOnly = config.validateOnly || false;
+	const strictCheck = config.strict || false;
+
+	// Pass options to plugins via env variables.
+	// Since plugins are added using `require` calls other forms are currently impossible.
+	process.env.JSDOC_OUTPUT_PATH = outputPath;
+
+	if ( validateOnly ) {
+		process.env.JSDOC_VALIDATE_ONLY = 'true';
+	}
+
+	if ( strictCheck ) {
+		process.env.JSDOC_STRICT_CHECK = 'true';
+	}
+
+	const files = await glob( sourceFilePatterns );
+
+	const jsDocConfig = {
+		plugins: [
+			require.resolve( 'jsdoc/plugins/markdown' ),
+			require.resolve( '@ckeditor/jsdoc-plugins/lib/purge-private-api-docs' ),
+			require.resolve( '@ckeditor/jsdoc-plugins/lib/export-fixer/export-fixer' ),
+			require.resolve( '@ckeditor/jsdoc-plugins/lib/custom-tags/error' ),
+			require.resolve( '@ckeditor/jsdoc-plugins/lib/custom-tags/observable' ),
+			require.resolve( '@ckeditor/jsdoc-plugins/lib/observable-event-provider' ),
+			require.resolve( '@ckeditor/jsdoc-plugins/lib/longname-fixer/longname-fixer' ),
+			require.resolve( '@ckeditor/jsdoc-plugins/lib/fix-code-snippets' ),
+			require.resolve( '@ckeditor/jsdoc-plugins/lib/relation-fixer' ),
+			require.resolve( '@ckeditor/jsdoc-plugins/lib/event-extender/event-extender' ),
+			require.resolve( '@ckeditor/jsdoc-plugins/lib/cleanup' ),
+			require.resolve( '@ckeditor/jsdoc-plugins/lib/validator/validator' ),
+			require.resolve( '@ckeditor/jsdoc-plugins/lib/utils/doclet-logger' ),
+			...extraPlugins
+		],
+		source: {
+			include: files
+		},
+		opts: {
+			encoding: 'utf8',
+			recurse: true,
+			access: 'all',
+			template: 'templates/silent'
+		}
+	};
+
+	const tmpConfig = tmp.fileSync();
+
+	await fs.writeFile( tmpConfig.name, JSON.stringify( jsDocConfig ) );
+
+	console.log( 'JSDoc started...' );
+
+	try {
+		// Not so beautiful API as for 2020...
+		// See more in https://github.com/jsdoc/jsdoc/issues/938.
+		const cmd = require.resolve( 'jsdoc/jsdoc.js' );
+
+		// The `node` command is used for explicitly needed for Windows.
+		// See https://github.com/ckeditor/ckeditor5/issues/7212.
+		tools.shExec( `node ${ cmd } -c ${ tmpConfig.name }`, { verbosity: 'info' } );
+	} catch ( error ) {
+		console.error( 'An error was thrown by JSDoc:' );
+
+		throw error;
+	}
+
+	console.log( `Documented ${ files.length } files!` );
+};

package/lib/buildtypedoc.js

@@ -0,0 +1,87 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const glob = require( 'fast-glob' );
+const TypeDoc = require( 'typedoc' );
+const validators = require( './validators' );
+
+/**
+ * Builds CKEditor 5 documentation using `typedoc`.
+ *
+ * @param {TypedocConfig} config
+ * @returns {Promise}
+ */
+module.exports = async function build( config ) {
+	const sourceFilePatterns = config.sourceFiles.filter( Boolean );
+	const strictMode = config.strict || false;
+	const extraPlugins = config.extraPlugins || [];
+
+	const files = await glob( sourceFilePatterns );
+	const typeDoc = new TypeDoc.Application();
+
+	typeDoc.options.addReader( new TypeDoc.TSConfigReader() );
+	typeDoc.options.addReader( new TypeDoc.TypeDocReader() );
+
+	typeDoc.bootstrap( {
+		tsconfig: config.tsconfig,
+		excludeExternals: true,
+		entryPoints: files,
+		logLevel: 'Warn',
+		basePath: config.cwd,
+		blockTags: [
+			'@eventName'
+		],
+		inlineTags: [
+			'@link',
+			'@glink'
+		],
+		modifierTags: [
+			'@publicApi',
+			'@skipSource'
+		],
+		plugin: [
+			// Fixes `"name": 'default" in the output project.
+			'typedoc-plugin-rename-defaults',
+
+			require.resolve( '@ckeditor/typedoc-plugins/lib/module-fixer' ),
+			require.resolve( '@ckeditor/typedoc-plugins/lib/symbol-fixer' ),
+			require.resolve( '@ckeditor/typedoc-plugins/lib/interface-augmentation-fixer' ),
+			require.resolve( '@ckeditor/typedoc-plugins/lib/tag-error' ),
+			require.resolve( '@ckeditor/typedoc-plugins/lib/tag-event' ),
+			require.resolve( '@ckeditor/typedoc-plugins/lib/tag-observable' ),
+			require.resolve( '@ckeditor/typedoc-plugins/lib/purge-private-api-docs' ),
+
+			// The `event-inheritance-fixer` plugin must be loaded after `tag-event` plugin, as it depends on its output.
+			require.resolve( '@ckeditor/typedoc-plugins/lib/event-inheritance-fixer' ),
+
+			// The `event-param-fixer` plugin must be loaded after `tag-event` and `tag-observable` plugins, as it depends on their output.
+			require.resolve( '@ckeditor/typedoc-plugins/lib/event-param-fixer' ),
+
+			...extraPlugins
+		]
+	} );
+
+	console.log( 'Typedoc started...' );
+
+	const conversionResult = typeDoc.convert();
+
+	if ( !conversionResult ) {
+		throw 'Something went wrong with TypeDoc.';
+	}
+
+	const validationResult = validators.validate( conversionResult, typeDoc );
+
+	if ( !validationResult && strictMode ) {
+		throw 'Something went wrong with TypeDoc.';
+	}
+
+	if ( config.outputPath ) {
+		await typeDoc.generateJson( conversionResult, config.outputPath );
+	}
+
+	console.log( `Documented ${ files.length } files!` );
+};

package/lib/validators/fires-validator/index.js

@@ -0,0 +1,55 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const { ReflectionKind } = require( 'typedoc' );
+const { isReflectionValid, isIdentifierValid, isAbsoluteIdentifier } = require( '../utils' );
+
+/**
+ * Validates the output produced by TypeDoc.
+ *
+ * It checks if the event in the "@fires" tag exists.
+ *
+ * @param {Object} project Generated output from TypeDoc to validate.
+ * @param {Function} onError A callback that is executed when a validation error is detected.
+ */
+module.exports = function validate( project, onError ) {
+	const reflections = project.getReflectionsByKind( ReflectionKind.Class | ReflectionKind.CallSignature ).filter( isReflectionValid );
+
+	for ( const reflection of reflections ) {
+		const identifiers = getIdentifiersFromFiresTag( reflection );
+
+		if ( !identifiers.length ) {
+			continue;
+		}
+
+		for ( const identifier of identifiers ) {
+			const isValid = isIdentifierValid( reflection, identifier );
+
+			if ( !isValid ) {
+				const eventName = identifier.replace( /^#event:/, '' );
+
+				onError( `Incorrect event name: "${ eventName }" in the @fires tag`, reflection );
+			}
+		}
+	}
+};
+
+function getIdentifiersFromFiresTag( reflection ) {
+	if ( !reflection.comment ) {
+		return [];
+	}
+
+	return reflection.comment.getTags( '@fires' )
+		.flatMap( tag => tag.content.map( item => item.text.trim() ) )
+		.map( identifier => {
+			if ( isAbsoluteIdentifier( identifier ) ) {
+				return identifier;
+			}
+
+			return '#event:' + identifier;
+		} );
+}

package/lib/validators/index.js

@@ -0,0 +1,54 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const seeValidator = require( './see-validator' );
+const linkValidator = require( './link-validator' );
+const firesValidator = require( './fires-validator' );
+const overloadsValidator = require( './overloads-validator' );
+const moduleValidator = require( './module-validator' );
+const { getNode } = require( './utils' );
+
+/**
+ * Validates the CKEditor 5 documentation.
+ *
+ * @param {Object} project Generated output from TypeDoc to validate.
+ * @param {Object} typeDoc A TypeDoc application instance.
+ * @returns {Boolean}
+ */
+module.exports = {
+	validate( project, typeDoc ) {
+		const validators = [
+			seeValidator,
+			linkValidator,
+			firesValidator,
+			overloadsValidator,
+			moduleValidator
+		];
+
+		typeDoc.logger.info( 'Starting validation...' );
+
+		// The same error can be reported twice:
+		//
+		// 1. When processing types and events (comments are copied from a type to an event).
+		// 2. When a parent class defines an invalid link, inherited members link to the invalid link too.
+		const errors = new Map();
+
+		for ( const validator of validators ) {
+			validator( project, ( error, reflection ) => {
+				const node = getNode( reflection );
+
+				errors.set( node, { error, node } );
+			} );
+		}
+
+		errors.forEach( ( { error, node } ) => typeDoc.logger.warn( error, node ) );
+
+		typeDoc.logger.info( 'Validation completed.' );
+
+		return !errors.size;
+	}
+};

package/lib/validators/link-validator/index.js

@@ -0,0 +1,59 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const { ReflectionKind } = require( 'typedoc' );
+const { isReflectionValid, isIdentifierValid } = require( '../utils' );
+
+/**
+ * Validates the output produced by TypeDoc.
+ *
+ * It checks if the identifier in the "@link" tag points to an existing doclet.
+ *
+ * @param {Object} project Generated output from TypeDoc to validate.
+ * @param {Function} onError A callback that is executed when a validation error is detected.
+ */
+module.exports = function validate( project, onError ) {
+	const reflections = project.getReflectionsByKind( ReflectionKind.All ).filter( isReflectionValid );
+
+	for ( const reflection of reflections ) {
+		const identifiers = getIdentifiersFromLinkTag( reflection );
+
+		if ( !identifiers.length ) {
+			continue;
+		}
+
+		for ( const identifier of identifiers ) {
+			const isValid = isIdentifierValid( reflection, identifier );
+
+			if ( !isValid ) {
+				onError( `Incorrect link: "${ identifier }"`, reflection );
+			}
+		}
+	}
+};
+
+function getIdentifiersFromLinkTag( reflection ) {
+	if ( !reflection.comment ) {
+		return [];
+	}
+
+	// The "@link" tag can be located in the comment summary or it can be nested in other block tags.
+	const parts = [
+		...reflection.comment.summary,
+		...reflection.comment.blockTags.flatMap( tag => tag.content )
+	];
+
+	return parts
+		.filter( part => part.kind === 'inline-tag' && part.tag === '@link' )
+		.map( part => {
+			// The "@link" tag may contain the actual identifier and the display name after a space.
+			// Split by space to extract only the identifier from the whole tag.
+			const [ identifier ] = part.text.split( ' ' );
+
+			return identifier;
+		} );
+}

package/lib/validators/module-validator/index.js

@@ -0,0 +1,37 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const { ReflectionKind } = require( 'typedoc' );
+const { getNode } = require( '../utils' );
+
+/**
+ * Validates the output produced by TypeDoc.
+ *
+ * It checks if the module name matches the path to the file where the module is defined.
+ *
+ * @param {Object} project Generated output from TypeDoc to validate.
+ * @param {Function} onError A callback that is executed when a validation error is detected.
+ */
+module.exports = function validate( project, onError ) {
+	const reflections = project.getReflectionsByKind( ReflectionKind.Module );
+
+	for ( const reflection of reflections ) {
+		const [ packageName, ...moduleName ] = reflection.name.split( '/' );
+
+		// If there is no module name after the package name, skip it.
+		if ( !moduleName.length ) {
+			continue;
+		}
+
+		const filePath = getNode( reflection ).fileName;
+		const expectedFilePath = `ckeditor5-${ packageName }/src/${ moduleName.join( '/' ) }.ts`;
+
+		if ( !filePath.endsWith( expectedFilePath ) ) {
+			onError( `Invalid module name: "${ reflection.name }"`, reflection );
+		}
+	}
+};

package/lib/validators/overloads-validator/index.js

@@ -0,0 +1,52 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const { ReflectionKind } = require( 'typedoc' );
+const { isReflectionValid } = require( '../utils' );
+
+/**
+ * Validates the output produced by TypeDoc.
+ *
+ * It checks if overloaded methods and functions are described with the mandatory "@label" tag.
+ *
+ * Also, it prevents using the same name twice for overloaded structures.
+ *
+ * @param {Object} project Generated output from TypeDoc to validate.
+ * @param {Function} onError A callback that is executed when a validation error is detected.
+ */
+module.exports = function validate( project, onError ) {
+	const kinds = ReflectionKind.Method | ReflectionKind.Constructor | ReflectionKind.Function;
+	const reflections = project.getReflectionsByKind( kinds ).filter( isReflectionValid );
+
+	for ( const reflection of reflections ) {
+		// Omit non-overloaded structures.
+		if ( reflection.signatures.length === 1 ) {
+			continue;
+		}
+
+		const uniqueValues = new Set();
+
+		const isInherited = !!reflection.inheritedFrom;
+		const errorMessageSuffix = isInherited ? ' due the inherited structure' : '';
+
+		for ( const signature of reflection.signatures ) {
+			// Check if a signature has a label...
+			if ( signature.comment && signature.comment.getTag( '@label' ) ) {
+				const [ { text: label } ] = signature.comment.getTag( '@label' ).content;
+
+				// ...and whether it is a unique value.
+				if ( uniqueValues.has( label ) ) {
+					onError( `Duplicated name: "${ label }" in the @label tag` + errorMessageSuffix, signature );
+				} else {
+					uniqueValues.add( label );
+				}
+			} else {
+				onError( 'Overloaded signature misses the @label tag' + errorMessageSuffix, signature );
+			}
+		}
+	}
+};

package/lib/validators/see-validator/index.js

@@ -0,0 +1,59 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const { ReflectionKind } = require( 'typedoc' );
+const { isReflectionValid, isIdentifierValid } = require( '../utils' );
+
+/**
+ * Validates the output produced by TypeDoc.
+ *
+ * It checks if the identifier in the "@see" tag points to an existing doclet.
+ *
+ * @param {Object} project Generated output from TypeDoc to validate.
+ * @param {Function} onError A callback that is executed when a validation error is detected.
+ */
+module.exports = function validate( project, onError ) {
+	const reflections = project.getReflectionsByKind( ReflectionKind.All ).filter( isReflectionValid );
+
+	for ( const reflection of reflections ) {
+		const identifiers = getIdentifiersFromSeeTag( reflection );
+
+		if ( !identifiers.length ) {
+			continue;
+		}
+
+		for ( const identifier of identifiers ) {
+			const isValid = isIdentifierValid( reflection, identifier );
+
+			if ( !isValid ) {
+				onError( `Incorrect link: "${ identifier }"`, reflection );
+			}
+		}
+	}
+};
+
+function getIdentifiersFromSeeTag( reflection ) {
+	if ( !reflection.comment ) {
+		return [];
+	}
+
+	return reflection.comment.getTags( '@see' )
+		.flatMap( tag => tag.content.map( item => item.text.trim() ) )
+		.filter( text => {
+			// Remove list markers (e.g. "-").
+			if ( text.length <= 1 ) {
+				return false;
+			}
+
+			// Remove external links.
+			if ( /^https?:\/\//.test( text ) ) {
+				return false;
+			}
+
+			return true;
+		} );
+}

package/lib/validators/utils/index.js

@@ -0,0 +1,199 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+/**
+ * Common utils for TypeDoc validators.
+ */
+module.exports = {
+	isReflectionValid,
+	isIdentifierValid,
+	isAbsoluteIdentifier,
+	getNode
+};
+
+/**
+ * Checks if the reflection can be considered as "valid" (supported). Only reflections that are not nested inside a type are supported.
+ *
+ * @param {require('typedoc').Reflection} reflection The reflection to check if it is valid.
+ * @returns {Boolean}
+ */
+function isReflectionValid( reflection ) {
+	if ( reflection.name === '__type' ) {
+		return false;
+	}
+
+	if ( reflection.parent ) {
+		return isReflectionValid( reflection.parent );
+	}
+
+	return true;
+}
+
+/**
+ * Checks if the name (identifier) that is provided for a tag, points to an existing reflection in the whole project.
+ * The identifier can be either a relative or an absolute one.
+ *
+ * @param {require('typedoc').Reflection} reflection The reflection that contain given identifier.
+ * @param {String} identifier An identifier to check.
+ * @returns {Boolean}
+ */
+function isIdentifierValid( reflection, identifier ) {
+	const absoluteIdentifier = isAbsoluteIdentifier( identifier ) ?
+		identifier :
+		toAbsoluteIdentifier( reflection, identifier );
+
+	return hasTarget( reflection.project, absoluteIdentifier );
+}
+
+/**
+ * Checks if the identifier is an absolute one.
+ *
+ * @param {String} identifier An identifier to check.
+ * @returns {Boolean}
+ */
+function isAbsoluteIdentifier( identifier ) {
+	return identifier.startsWith( 'module:' );
+}
+
+/**
+ * Converts a relative identifier into an absolute one.
+ *
+ * @param {require('typedoc').Reflection} reflection The reflection that contain given identifier.
+ * @param {String} identifier An identifier to convert.
+ * @returns {String}
+ */
+function toAbsoluteIdentifier( reflection, identifier ) {
+	const separator = identifier[ 0 ];
+	const parts = getLongNameParts( reflection );
+
+	return separator === '~' ?
+		'module:' + parts[ 0 ] + identifier :
+		'module:' + parts[ 0 ] + '~' + parts[ 1 ] + identifier;
+}
+
+/**
+ * Returns a longname for a reflection, divided into separate parts.
+ *
+ * @param {require('typedoc').Reflection} reflection A reflection for which we want to get its longname.
+ * @returns {Array.<String>}
+ */
+function getLongNameParts( reflection ) {
+	// Kinds of reflection that affect the longname format.
+	const kinds = [
+		'Module',
+		'Class',
+		'Function',
+		'Interface',
+		'Type alias',
+		'Accessor',
+		'Variable',
+		'Method',
+		'Property',
+		'Event'
+	];
+
+	const parts = [];
+
+	while ( reflection ) {
+		if ( kinds.includes( reflection.kindString ) ) {
+			parts.unshift( reflection.name );
+		}
+
+		reflection = reflection.parent;
+	}
+
+	return parts;
+}
+
+/**
+ * Returns the TypeScript node from the reflection.
+ *
+ * @param {require('typedoc').Reflection} reflection A reflection for which we want to get its TypeScript node.
+ * @returns {Object}
+ */
+function getNode( reflection ) {
+	let symbol = reflection.project.getSymbolFromReflection( reflection );
+	let declarationIndex = 0;
+
+	if ( !symbol ) {
+		// The TypeDoc project does not store symbols for signatures. To get the TypeScript node from a signature, we need to get the
+		// symbol from its parent, which contains all nodes for each signature.
+		symbol = reflection.project.getSymbolFromReflection( reflection.parent );
+		declarationIndex = reflection.parent.signatures ? reflection.parent.signatures.indexOf( reflection ) : 0;
+	}
+
+	return symbol.declarations[ declarationIndex ];
+}
+
+/**
+ * Checks if the provided identifier targets an existing reflection within the whole project.
+ *
+ * @param {require('typedoc').ProjectReflection} project The project reflection.
+ * @param {String} identifier The absolute identifier to locate the target reflection.
+ * @returns {Boolean}
+ */
+function hasTarget( project, identifier ) {
+	const parts = identifier
+		// Remove leading "module:" prefix from the doclet longname.
+		.substring( 'module:'.length )
+		// Then, split the rest of the longname into separate parts.
+		.split( /#|~|\./ );
+
+	// The last part of the longname may contain a colon, which can be either a part of the event name, or it indicates that the name
+	// targets a labeled signature.
+	const lastPart = parts.pop();
+	const [ lastPartName, lastPartLabel ] = lastPart.split( ':' );
+
+	const isIdentifierEvent = lastPart.startsWith( 'event:' );
+	const isIdentifierLabeledSignature = !isIdentifierEvent && lastPart.includes( ':' );
+
+	if ( isIdentifierLabeledSignature ) {
+		// If the identifier is a labeled signature, just use the method/function name and the labeled signature will be searched later.
+		parts.push( lastPartName );
+	} else {
+		// Otherwise, restore the original identifier part.
+		parts.push( lastPart );
+	}
+
+	const targetReflection = project.getChildByName( parts );
+
+	if ( !targetReflection ) {
+		return false;
+	}
+
+	// Now, when the target reflection is found, do some checks whether it matches the identifier.
+	// (1) Check if the labeled signature targets an existing signature.
+	if ( isIdentifierLabeledSignature ) {
+		if ( !targetReflection.signatures ) {
+			return false;
+		}
+
+		return targetReflection.signatures.some( signature => {
+			if ( !signature.comment ) {
+				return false;
+			}
+
+			const labelTag = signature.comment.getTag( '@label' );
+
+			if ( !labelTag ) {
+				return false;
+			}
+
+			return labelTag.content[ 0 ].text === lastPartLabel;
+		} );
+	}
+
+	const isIdentifierStatic = identifier.includes( '.' );
+	const isTargetReflectionStatic = Boolean( targetReflection.flags && targetReflection.flags.isStatic );
+
+	// (2) Check if the static/non-static reflection flag matches the separator used in the identifier.
+	if ( isIdentifierStatic !== isTargetReflectionStatic ) {
+		return false;
+	}
+
+	return true;
+}

package/package.json

@@ -1,16 +1,24 @@
 {
   "name": "@ckeditor/ckeditor5-dev-docs",
-  "version": "32.0.1",
+  "version": "32.1.0",
   "description": "Tasks used to build and verify the documentation for CKEditor 5.",
   "keywords": [],
   "main": "lib/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-dev-utils": "^32.0.1",
-    "@ckeditor/jsdoc-plugins": "^32.0.1",
+    "@ckeditor/ckeditor5-dev-utils": "^32.1.0",
+    "@ckeditor/jsdoc-plugins": "^32.1.0",
+    "@ckeditor/typedoc-plugins": "^32.1.0",
     "fast-glob": "^3.2.4",
     "fs-extra": "^9.0.0",
     "jsdoc": "ckeditor/jsdoc#fixed-trailing-comment-doclets",
-    "tmp": "^0.2.1"
+    "tmp": "^0.2.1",
+    "typedoc": "^0.23.15",
+    "typedoc-plugin-rename-defaults": "^0.6.4"
+  },
+  "devDependencies": {
+    "chai": "^4.2.0",
+    "proxyquire": "^2.1.3",
+    "sinon": "^9.2.4"
   },
   "engines": {
     "node": ">=14.0.0",