umberto 9.4.0 → 10.0.0

package/src/data-converter/converters/typedoc/classparser.js

@@ -3,12 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import { AbstractParser } from './abstractparser.js';
+import * as ReflectionKind from './reflectionkind.js';
 
-const AbstractParser = require( './abstractparser' );
-const ReflectionKind = require( './reflectionkind' );
-
-module.exports = class ClassParser extends AbstractParser {
+export class ClassParser extends AbstractParser {
 	/**
 	 * @param {BaseReflection} item
 	 * @returns {Boolean}

package/src/data-converter/converters/typedoc/computedpropertyparser.js

@@ -3,12 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import { PropertyParser } from './propertyparser.js';
+import * as ReflectionKind from './reflectionkind.js';
 
-const PropertyParser = require( './propertyparser' );
-const ReflectionKind = require( './reflectionkind' );
-
-module.exports = class ComputedPropertyParser extends PropertyParser {
+export class ComputedPropertyParser extends PropertyParser {
 	/**
 	 * @param {BaseReflection} item
 	 * @returns {Boolean}

package/src/data-converter/converters/typedoc/constantparser.js

@@ -3,12 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import { AbstractParser } from './abstractparser.js';
+import * as ReflectionKind from './reflectionkind.js';
 
-const AbstractParser = require( './abstractparser' );
-const ReflectionKind = require( './reflectionkind' );
-
-module.exports = class ConstantParser extends AbstractParser {
+export class ConstantParser extends AbstractParser {
 	/**
 	 * @param {BaseReflection} item
 	 * @returns {Boolean}

package/src/data-converter/converters/typedoc/constructorparser.js

@@ -3,12 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import { MethodParser } from './methodparser.js';
+import * as ReflectionKind from './reflectionkind.js';
 
-const MethodParser = require( './methodparser' );
-const ReflectionKind = require( './reflectionkind' );
-
-module.exports = class ConstructorParser extends MethodParser {
+export class ConstructorParser extends MethodParser {
 	/**
 	 * @param {BaseReflection} item
 	 * @returns {Boolean}

package/src/data-converter/converters/typedoc/errorparser.js

@@ -3,11 +3,9 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import { AbstractParser } from './abstractparser.js';
 
-const AbstractParser = require( './abstractparser' );
-
-module.exports = class ErrorParser extends AbstractParser {
+export class ErrorParser extends AbstractParser {
 	/**
 	 * @param {BaseReflection} item
 	 * @returns {Boolean}

package/src/data-converter/converters/typedoc/eventparser.js

@@ -3,11 +3,9 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import { AbstractParser } from './abstractparser.js';
 
-const AbstractParser = require( './abstractparser' );
-
-module.exports = class EventParser extends AbstractParser {
+export class EventParser extends AbstractParser {
 	/**
 	 * @param {BaseReflection} item
 	 * @returns {Boolean}

package/src/data-converter/converters/typedoc/functionparser.js

@@ -3,12 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import { AbstractParser } from './abstractparser.js';
+import * as ReflectionKind from './reflectionkind.js';
 
-const AbstractParser = require( './abstractparser' );
-const ReflectionKind = require( './reflectionkind' );
-
-module.exports = class FunctionParser extends AbstractParser {
+export class FunctionParser extends AbstractParser {
 	/**
 	 * @param {BaseReflection} item
 	 * @returns {Boolean}

package/src/data-converter/converters/typedoc/interfaceparser.js

@@ -3,12 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import { AbstractParser } from './abstractparser.js';
+import * as ReflectionKind from './reflectionkind.js';
 
-const AbstractParser = require( './abstractparser' );
-const ReflectionKind = require( './reflectionkind' );
-
-module.exports = class InterfaceParser extends AbstractParser {
+export class InterfaceParser extends AbstractParser {
 	/**
 	 * @param {BaseReflection} item
 	 * @returns {Boolean}

package/src/data-converter/converters/typedoc/methodparser.js

@@ -3,12 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import { AbstractParser } from './abstractparser.js';
+import * as ReflectionKind from './reflectionkind.js';
 
-const AbstractParser = require( './abstractparser' );
-const ReflectionKind = require( './reflectionkind' );
-
-module.exports = class MethodParser extends AbstractParser {
+export class MethodParser extends AbstractParser {
 	/**
 	 * @param {BaseReflection} item
 	 * @returns {Boolean}

package/src/data-converter/converters/typedoc/moduleparser.js

@@ -3,12 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import { AbstractParser } from './abstractparser.js';
+import * as ReflectionKind from './reflectionkind.js';
 
-const AbstractParser = require( './abstractparser' );
-const ReflectionKind = require( './reflectionkind' );
-
-module.exports = class ModuleParser extends AbstractParser {
+export class ModuleParser extends AbstractParser {
 	/**
 	 * @param {BaseReflection} item
 	 * @returns {Boolean}

package/src/data-converter/converters/typedoc/propertyparser.js

@@ -3,12 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import { AbstractParser } from './abstractparser.js';
+import * as ReflectionKind from './reflectionkind.js';
 
-const AbstractParser = require( './abstractparser' );
-const ReflectionKind = require( './reflectionkind' );
-
-module.exports = class PropertyParser extends AbstractParser {
+export class PropertyParser extends AbstractParser {
 	/**
 	 * @param {BaseReflection} item
 	 * @returns {Boolean}

package/src/data-converter/converters/typedoc/referenceparser.js

@@ -3,12 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import { AbstractParser } from './abstractparser.js';
+import * as ReflectionKind from './reflectionkind.js';
 
-const AbstractParser = require( './abstractparser' );
-const ReflectionKind = require( './reflectionkind' );
-
-module.exports = class ReferenceParser extends AbstractParser {
+export class ReferenceParser extends AbstractParser {
 	/**
 	 * @param {BaseReflection} item
 	 * @returns {Boolean}

package/src/data-converter/converters/typedoc/reflectionkind.js

@@ -3,32 +3,30 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
 // To avoid linking Umberto and Typedoc, let's keep this file in sync with the `ReflectionKind` enum.
 // See: https://typedoc.org/api/enums/Models.ReflectionKind.html
 
-module.exports.Accessor = 262144;
-module.exports.CallSignature = 4096;
-module.exports.Class = 128;
-module.exports.Constructor = 512;
-module.exports.ConstructorSignature = 16384;
-module.exports.Document = 8388608;
-module.exports.Enum = 8;
-module.exports.EnumMember = 16;
-module.exports.Function = 64;
-module.exports.GetSignature = 524288;
-module.exports.IndexSignature = 8192;
-module.exports.Interface = 256;
-module.exports.Method = 2048;
-module.exports.Module = 2;
-module.exports.Namespace = 4;
-module.exports.Parameter = 32768;
-module.exports.Project = 1;
-module.exports.Property = 1024;
-module.exports.Reference = 4194304;
-module.exports.SetSignature = 1048576;
-module.exports.TypeAlias = 2097152;
-module.exports.TypeLiteral = 65536;
-module.exports.TypeParameter = 131072;
-module.exports.Variable = 32;
+export const Accessor = 262144;
+export const CallSignature = 4096;
+export const Class = 128;
+export const Constructor = 512;
+export const ConstructorSignature = 16384;
+export const Document = 8388608;
+export const Enum = 8;
+export const EnumMember = 16;
+export const Function = 64;
+export const GetSignature = 524288;
+export const IndexSignature = 8192;
+export const Interface = 256;
+export const Method = 2048;
+export const Module = 2;
+export const Namespace = 4;
+export const Parameter = 32768;
+export const Project = 1;
+export const Property = 1024;
+export const Reference = 4194304;
+export const SetSignature = 1048576;
+export const TypeAlias = 2097152;
+export const TypeLiteral = 65536;
+export const TypeParameter = 131072;
+export const Variable = 32;

package/src/data-converter/converters/typedoc/typedocconverter.js

@@ -3,10 +3,8 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const MarkdownIt = require( 'markdown-it' );
-const ReflectionKind = require( './reflectionkind' );
+import MarkdownIt from 'markdown-it';
+import * as ReflectionKind from './reflectionkind.js';
 const markdown = new MarkdownIt( {
 	html: true
 } );
@@ -14,7 +12,7 @@ const markdown = new MarkdownIt( {
 const ISSUE_URL = 'https://github.com/cksource/umberto/issues/new?assignees=&labels=type:feature,squad:platform';
 const MODULE_INDEX_PATTERN = /^module:(?!icons\b)[\w-]+\/index/;
 
-class TypedocConverter {
+export class TypedocConverter {
 	/**
 	 * @param {Array.<AbstractParser>} parsers
 	 */
@@ -866,8 +864,6 @@ class TypeConverter {
 	}
 }
 
-module.exports = TypedocConverter;
-
 /**
  * @param {TypeConverter} converter
  * @returns {Function}

package/src/data-converter/converters/typedoc/typeparser.js

@@ -3,12 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import { AbstractParser } from './abstractparser.js';
+import * as ReflectionKind from './reflectionkind.js';
 
-const AbstractParser = require( './abstractparser' );
-const ReflectionKind = require( './reflectionkind' );
-
-module.exports = class TypeParser extends AbstractParser {
+export class TypeParser extends AbstractParser {
 	/**
 	 * @param {BaseReflection} item
 	 * @returns {Boolean}

package/src/data-converter/converters/typedoc2umberto.js

@@ -3,25 +3,23 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const TypedocConverter = require( './typedoc/typedocconverter' );
-const ModuleParser = require( './typedoc/moduleparser' );
-const ClassParser = require( './typedoc/classparser' );
-const AccessorParser = require( './typedoc/accessorparser' );
-const InterfaceParser = require( './typedoc/interfaceparser' );
-const ConstantParser = require( './typedoc/constantparser' );
-const TypeParser = require( './typedoc/typeparser' );
-const FunctionParser = require( './typedoc/functionparser' );
-const PropertyParser = require( './typedoc/propertyparser' );
-const ComputedPropertyParser = require( './typedoc/computedpropertyparser' );
-const MethodParser = require( './typedoc/methodparser' );
-const ConstructorParser = require( './typedoc/constructorparser' );
-const ErrorParser = require( './typedoc/errorparser' );
-const EventParser = require( './typedoc/eventparser' );
-const ReferenceParser = require( './typedoc/referenceparser' );
-
-module.exports = data => {
+import { TypedocConverter } from './typedoc/typedocconverter.js';
+import { ModuleParser } from './typedoc/moduleparser.js';
+import { ClassParser } from './typedoc/classparser.js';
+import { AccessorParser } from './typedoc/accessorparser.js';
+import { InterfaceParser } from './typedoc/interfaceparser.js';
+import { ConstantParser } from './typedoc/constantparser.js';
+import { TypeParser } from './typedoc/typeparser.js';
+import { FunctionParser } from './typedoc/functionparser.js';
+import { PropertyParser } from './typedoc/propertyparser.js';
+import { ComputedPropertyParser } from './typedoc/computedpropertyparser.js';
+import { MethodParser } from './typedoc/methodparser.js';
+import { ConstructorParser } from './typedoc/constructorparser.js';
+import { ErrorParser } from './typedoc/errorparser.js';
+import { EventParser } from './typedoc/eventparser.js';
+import { ReferenceParser } from './typedoc/referenceparser.js';
+
+export const typedoc2umberto = data => {
 	const projectReflection = JSON.parse( data );
 
 	if ( !projectReflection.children ) {

package/src/data-converter/data-collection.js

@@ -3,14 +3,12 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const DocletCollection = require( './doclet-collection' );
+import { DocletCollection } from './doclet-collection.js';
 
 /**
  * Collection of DocletCollections as <String, DocletCollection> pairs. Also stores all doclets in an array.
  */
-class DataCollection {
+export class DataCollection {
 	/**
 	 * Creates collection of DocletCollections.
 	 */
@@ -55,4 +53,3 @@ class DataCollection {
 	}
 }
 
-module.exports = DataCollection;

package/src/data-converter/data-provider.js

@@ -3,13 +3,11 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const DataCollection = require( './data-collection' );
-const jsdoc2umberto = require( './converters/jsdoc2umberto' );
-const jsduck2umberto = require( './converters/jsduck2umberto' );
-const typedoc2umberto = require( './converters/typedoc2umberto' );
-const relationFixer = require( './middlewares/relation-fixer' );
+import { DataCollection } from './data-collection.js';
+import { jsdoc2umberto } from './converters/jsdoc2umberto.js';
+import { jsduck2umberto } from './converters/jsduck2umberto.js';
+import { typedoc2umberto } from './converters/typedoc2umberto.js';
+import { relationFixer } from './middlewares/relation-fixer.js';
 const converters = new Map( [
 	[ 'jsdoc', jsdoc2umberto ],
 	[ 'jsduck', jsduck2umberto ],
@@ -20,7 +18,7 @@ const converters = new Map( [
  * Converts API data generated by various documentation tools into umberto-source-format.
  * umberto-source-format is pretty much equal to JSDoc format.
  */
-module.exports = class DataProvider {
+export class DataProvider {
 	/**
 	 * Converts data to umberto-source-format.
 	 *

package/src/data-converter/doclet-collection.js

@@ -3,12 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
 /**
  * Collection of doclets as <String, Doclet[]> pairs. Also stores all doclets and their longnames as arrays.
  */
-class DocletCollection {
+export class DocletCollection {
 	/**
 	 * Creates collection of doclets.
 	 */
@@ -115,4 +113,3 @@ function sortByName( a, b ) {
 	return 0;
 }
 
-module.exports = DocletCollection;

package/src/data-converter/middlewares/relation-fixer.js

@@ -3,10 +3,8 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const buildRelations = require( '@ckeditor/jsdoc-plugins/lib/relation-fixer/buildrelations' );
-const addMissingDoclets = require( '@ckeditor/jsdoc-plugins/lib/relation-fixer/addmissingdoclets' );
+import buildRelations from '@ckeditor/jsdoc-plugins/lib/relation-fixer/buildrelations.js';
+import addMissingDoclets from '@ckeditor/jsdoc-plugins/lib/relation-fixer/addmissingdoclets.js';
 
 /**
  * Builds relation chains between doclets and adds missing derived doclets.
@@ -15,6 +13,6 @@ const addMissingDoclets = require( '@ckeditor/jsdoc-plugins/lib/relation-fixer/a
  * @param doclets
  * @returns {Array.<Doclet>}
  */
-module.exports = doclets => {
+export const relationFixer = doclets => {
 	return addMissingDoclets( buildRelations( doclets ) );
 };

package/src/helpers/capitalize.js

@@ -3,8 +3,6 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-module.exports = ( str = '' ) => {
+export const capitalize = ( str = '' ) => {
 	return str.charAt( 0 ).toUpperCase() + str.slice( 1 );
 };

package/src/helpers/create-filtering-data-attribs.js

@@ -3,13 +3,11 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
 /**
  * Creates an object with atributes data to be used in template.
  * @param {Object} item
  */
-module.exports = item => {
+export const createFilteringDataAttribs = item => {
 	const attrData = {};
 
 	if ( item.access ) {

package/src/helpers/doc-formats.js

@@ -3,9 +3,7 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-module.exports = {
+export const docFormats = {
 	jsdoc: 'json',
 	jsduck: 'json',
 	typedoc: 'json'

package/src/helpers/escape-longname.js

@@ -3,15 +3,13 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
 /**
  * Replaces characters in a string. Mainly used to prepare a long-name to be used as a filename.
  *
  * @param {String} text
  * @returns {String}
  */
-module.exports = text => {
+export const escapeLongname = text => {
 	const str = text || '';
 
 	return str.replace( /\([\s\S]*\)$/, '' )

package/src/helpers/extract-longname.js

@@ -3,8 +3,6 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
 /**
  * Extracts longname from strings like 'Array.<module:ui...>'.
  * @param {String} str
@@ -13,7 +11,7 @@
  * @returns {Object} result.prefix
  * @returns {Object} result.suffix
  */
-module.exports = str => {
+export const extractLongname = str => {
 	if ( typeof str !== 'string' ) {
 		return {
 			longnames: [ '' ]

package/src/helpers/get-api-infobox-tooltip.js

@@ -3,12 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import { getShortModulePath } from './get-short-module-path.js';
+import { splitLongname } from './split-longname.js';
 
-const getShortModulePath = require( './get-short-module-path' );
-const splitLongname = require( './split-longname' );
-
-module.exports = ( longname, transformFn ) => {
+export const getApiInfoboxTooltip = ( longname, transformFn ) => {
 	const className = splitLongname( longname ).className;
 	const str = className ? `${ getShortModulePath( longname ) }~${ className }` : getShortModulePath( longname );
 

package/src/helpers/get-docsearch-config.js

@@ -3,18 +3,20 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import lodash from 'lodash';
+import { stringify } from 'javascript-stringify';
+import fs from 'node:fs';
+import upath from 'upath';
 
-const { cloneDeep } = require( 'lodash' );
-const { stringify } = require( 'javascript-stringify' );
-const fs = require( 'node:fs' );
-const upath = require( 'upath' );
+const __dirname = import.meta.dirname;
+
+const { cloneDeep } = lodash;
 
 const defaultScriptTemplate = fs.readFileSync( upath.join( __dirname, 'templates', 'scripts', 'default.js' ), 'utf-8' );
 const groupScriptTemplate = fs.readFileSync( upath.join( __dirname, 'templates', 'scripts', 'group.js' ), 'utf-8' );
 const rootScriptTemplate = fs.readFileSync( upath.join( __dirname, 'templates', 'scripts', 'root.js' ), 'utf-8' );
 
-module.exports = ( searchConfig, {
+export const getDocsearchConfig = ( searchConfig, {
 	groups = [],
 	slug = '',
 	customRanking = []

package/src/helpers/get-file-patterns-to-process.js

@@ -3,8 +3,6 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
 /**
  * Returns an array containing files to process by Umberto based on the configuration passed to the building task.
  *
@@ -18,7 +16,7 @@
  * @param {Boolean} skipGuides
  * @return {nArray.<String>|null}
  */
-module.exports = function getFilePatternsToProcess( { guides, skipGuides } ) {
+export function getFilePatternsToProcess( { guides, skipGuides } ) {
 	// When called with `--skip-guides`.
 	if ( skipGuides ) {
 		return [

package/src/helpers/get-short-module-path.js

@@ -3,11 +3,9 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import { splitLongname } from './split-longname.js';
 
-const splitLongname = require( './split-longname' );
-
-module.exports = longname => {
+export const getShortModulePath = longname => {
 	if ( !longname ) {
 		return '';
 	}