umberto 7.0.0 → 7.0.2

package/CHANGELOG.md

@@ -1,6 +1,22 @@
 Changelog
 =========
 
+## [7.0.2](https://github.com/cksource/umberto/compare/v7.0.1...v7.0.2) (2025-05-20)
+
+### Bug fixes
+
+* Fixed an invalid protocol (should be `https://` instead of `https:/`) in the generated index sitemap file. Closes [#1277](https://github.com/cksource/umberto/issues/1277). ([commit](https://github.com/cksource/umberto/commit/6f59654e85b1230fbfe029efe68f708755ec6342))
+
+
+## [7.0.1](https://github.com/cksource/umberto/compare/v7.0.0...v7.0.1) (2025-05-14)
+
+### Other changes
+
+* Updated the project dependencies. Closes [#1253](https://github.com/cksource/umberto/issues/1253). ([commit](https://github.com/cksource/umberto/commit/28d74364207ab055ad76c2857d58cccb1866559b))
+* Removed dependencies that can be replaced with native APIs or other already used dependencies. ([commit](https://github.com/cksource/umberto/commit/28d74364207ab055ad76c2857d58cccb1866559b))
+* Sitemaps will be generated separately for each project. Closes [#1254](https://github.com/cksource/umberto/issues/1254). ([commit](https://github.com/cksource/umberto/commit/7968755b2a4b1c23768a9420292eb1d168b898b3))
+
+
 ## [7.0.0](https://github.com/cksource/umberto/compare/v6.1.2...v7.0.0) (2025-05-05)
 
 ### BREAKING CHANGES

package/hexo-config.json

@@ -15,16 +15,11 @@
 	"pug": {
 		"pretty": true
 	},
-  	"highlight": {
-	  	"enable": false
-	},
-	"prism": {
-		"enable": false
-	},
-  	"markdown_it_plus": {
-	  	"highlight": false,
-	  	"html": true,
-	  	"breaks": true,
+	"syntax_highlighter": "",
+	"markdown_it_plus": {
+		"highlight": false,
+		"html": true,
+		"breaks": true,
 		"linkify": false,
 		"plugins": [
 			{
@@ -42,19 +37,19 @@
 				"plugin": {
 					"name": "markdown-it-expand-tabs",
 					"enable": true,
-				  	"options": {
-					  	"tabWidth": 4
+					"options": {
+						"tabWidth": 4
 					}
 				}
 			}
 		]
 	},
-  	"skip_render": [
-	  	"**/*.css",
-	  	"**/*.scss",
-	  	"**/*.html",
-	  	"**/*.json",
-	  	"**/*.js",
-	  	"**/*.txt"
+	"skip_render": [
+		"**/*.css",
+		"**/*.scss",
+		"**/*.html",
+		"**/*.json",
+		"**/*.js",
+		"**/*.txt"
 	]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umberto",
-  "version": "7.0.0",
+  "version": "7.0.2",
   "description": "CKSource Documentation builder",
   "main": "src/index.js",
   "files": [
@@ -15,42 +15,36 @@
   ],
   "dependencies": {
     "@babel/core": "^7.18.10",
-    "@babel/polyfill": "^7.12.1",
     "@babel/preset-env": "^7.18.10",
     "@ckeditor/jsdoc-plugins": "^43.0.0",
-    "babel-loader": "^8.2.5",
-    "chalk": "^4.1.0",
+    "babel-loader": "^10.0.0",
     "cheerio": "^1.0.0",
-    "cpx": "^1.5.0",
-    "del": "^6.1.1",
-    "element-closest": "^3.0.2",
     "escape-string-regexp": "^4.0.0",
     "fs-extra": "^11.0.0",
-    "fuse.js": "^6.6.2",
-    "glob": "^7.2.3",
-    "hexo": "^6.2.0",
-    "hexo-generator-archive": "^1.0.0",
-    "hexo-generator-category": "^1.0.0",
-    "hexo-generator-index": "^1.0.0",
-    "hexo-generator-tag": "^1.0.0",
+    "fuse.js": "^7.1.0",
+    "glob": "^11.0.2",
+    "hexo": "^7.3.0",
+    "hexo-generator-archive": "^2.0.0",
+    "hexo-generator-category": "^2.0.0",
+    "hexo-generator-index": "^4.0.0",
+    "hexo-generator-tag": "^2.0.0",
     "hexo-render-pug": "^2.1.4",
     "hexo-renderer-markdown-it-plus": "^1.0.5",
     "htmlparser2": "^10.0.0",
     "javascript-stringify": "^2.1.0",
-    "jquery": "~3.6.0",
+    "jquery": "~3.7.1",
     "js-beautify": "^1.14.4",
     "lodash": "^4.17.21",
-    "markdown-it": "^13.0.1",
+    "markdown-it": "^14.1.0",
     "markdown-it-expand-tabs": "^1.0.13",
     "markdown-it-toc-and-anchor": "^4.2.0",
     "medium-zoom": "^1.0.6",
-    "minimatch": "^5.1.0",
-    "mkdirp": "^1.0.4",
+    "minimatch": "^10.0.1",
     "moment": "^2.29.4",
-    "nyc": "^15.1.0",
+    "nyc": "^17.1.0",
     "pug": "^3.0.2",
     "sass": "^1.54.0",
-    "sitemap": "^7.1.1",
+    "sitemap": "^8.0.0",
     "tippy.js": "^6.3.7",
     "tree-model": "^1.0.7",
     "upath": "^2.0.1",
@@ -79,6 +73,6 @@
     "packages/**"
   ],
   "hexo": {
-    "version": "6.3.0"
+    "version": "7.3.0"
   }
 }

package/scripts/filter/after-post-render/time-end.js

@@ -5,8 +5,7 @@
 
 'use strict';
 
-const util = require( 'util' );
-const chalk = require( 'chalk' );
+const { format, styleText } = require( 'util' );
 
 hexo.extend.filter.register( 'after_post_render', page => {
 	if ( !hexo.projectGlobals.common || !hexo.projectGlobals.common.verbose ) {
@@ -17,11 +16,11 @@ hexo.extend.filter.register( 'after_post_render', page => {
 	// Log only pages, which generates for longer than 1 second.
 	if ( time[ 0 ] > 1 ) {
 		console.log(
-			util.format(
+			format(
 				'Page: %s was processed in: %s.%ss.',
-				chalk.cyanBright( page.source ),
-				chalk.yellow( time[ 0 ] ),
-				chalk.yellow( time[ 1 ] )
+				styleText( 'cyanBright', page.source ),
+				styleText( 'yellow', time[ 0 ] ),
+				styleText( 'yellow', time[ 1 ] )
 			)
 		);
 	}

package/scripts/utils/getreportissuewidgeturl.js

@@ -5,7 +5,7 @@
 
 'use strict';
 
-const minimatch = require( 'minimatch' );
+const { minimatch } = require( 'minimatch' );
 
 /**
  * @param {Object} page A page object.

package/scripts/utils/logcrossprojectreference.js

@@ -5,7 +5,7 @@
 
 'use strict';
 
-const chalk = require( 'chalk' );
+const { styleText } = require( 'util' );
 
 /**
  * Logs an error message about a cross-project reference found in the parsed expression.
@@ -19,8 +19,8 @@ const chalk = require( 'chalk' );
 module.exports = function logCrossProjectReference( { expression, source } ) {
 	process.exitCode = 1;
 
-	const message = `${ chalk.red( 'Error:' ) } Failed while convert ${ chalk.cyanBright( expression ) } tag`;
-	const messageLocation = source ? ` in ${ chalk.magentaBright( source ) }.` : '.';
+	const message = `${ styleText( 'red', 'Error:' ) } Failed while convert ${ styleText( 'cyanBright', expression ) } tag`;
+	const messageLocation = source ? ` in ${ styleText( 'magentaBright', source ) }.` : '.';
 	const messageDescription = ' Cross-project references are not supported.';
 
 	console.log( message + messageLocation + messageDescription );

package/scripts/utils/parselinks.js

@@ -5,9 +5,9 @@
 
 'use strict';
 
+const { styleText } = require( 'util' );
 const upath = require( 'upath' );
 const splitLongname = require( '../../src/helpers/split-longname' );
-const chalk = require( 'chalk' );
 
 const LINK_REGEXP = /\\?{(?:@linkapi|@link|@linksdk|@linkexample)\s+[^{]+?({[^}]+})?[^{}]*\\?}/g;
 
@@ -127,7 +127,7 @@ function linkToApi( str, data, hexo, { relativeUrlHelper, isSilentError } ) {
 			value: str,
 			source: data.source,
 			isSilent: isSilentError,
-			description: `Project ${ chalk.redBright( data.projectName ) } is not defined.`
+			description: `Project ${ styleText( 'redBright', data.projectName ) } is not defined.`
 		} );
 	}
 
@@ -343,10 +343,16 @@ function onError( { value, source, isSilent, description } ) {
 	if ( !isSilent ) {
 		process.exitCode = 1;
 
-		console.log(
-			`${ chalk.red( 'Error: ' ) }Failed while convert ${ chalk.cyanBright( value ) } tag in ` +
-			`${ chalk.magentaBright( source ) }.${ description ? chalk.italic( ' ' + description ) : '' }`
-		);
+		const message = [
+			styleText( 'red', 'Error:' ),
+			`Failed to convert ${ styleText( 'cyanBright', value ) } tag`,
+			source && `in ${ styleText( 'magentaBright', source ) }`,
+			description && `because ${ styleText( 'italic', description ) }`
+		]
+			.filter( Boolean )
+			.join( ' ' );
+
+		console.log( message );
 	}
 
 	return value;

package/src/api-builder/classes/description-parser.js

@@ -5,9 +5,9 @@
 
 'use strict';
 
+const { styleText } = require( 'util' );
 const cheerio = require( 'cheerio' );
 const splitLongname = require( '../../helpers/split-longname' );
-const chalk = require( 'chalk' );
 const macroReplacer = require( '../../tasks/macro-replacer' );
 const findTargetDoclet = require( '../utils/findtargetdoclet' );
 const { hasDedicatedApiPages, LONG_NAME_LABEL_REGEXP, LONG_NAME_MEMBER_SEPARATOR_REGEXP } = require( '../utils/utils' );
@@ -283,7 +283,7 @@ module.exports = class DescriptionParser {
 				replaceToPhrase = `<a href="${ href }">${ linkContent }</a>`;
 			} else {
 				console.log(
-					`${ chalk.yellow( 'Warning:' ) } Invalid link in API docs: ${ chalk.gray( fullMatch ) }.`,
+					`${ styleText( 'yellow', 'Warning:' ) } Invalid link in API docs: ${ styleText( 'gray', fullMatch ) }.`,
 					'There is no doclet of the link target.'
 				);
 

package/src/helpers/snippets.js

@@ -6,7 +6,7 @@
 'use strict';
 
 const upath = require( 'upath' );
-const glob = require( 'glob' );
+const { globSync } = require( 'glob' );
 
 const utils = {
 	/**
@@ -36,14 +36,15 @@ const utils = {
 	 * @returns {SnippetSource}
 	 */
 	getSnippetSourcePaths( basePath, snippetName ) {
-		const snippetPaths = glob.sync( upath.join( basePath, snippetName + '.*' ) );
 		const files = {};
 
-		snippetPaths.forEach( singlePath => {
-			const fileExtension = upath.extname( singlePath ).slice( 1 );
+		globSync( upath.join( basePath, snippetName + '.*' ) )
+			.map( path => upath.normalize( path ) )
+			.forEach( singlePath => {
+				const fileExtension = upath.extname( singlePath ).slice( 1 );
 
-			files[ fileExtension ] = singlePath;
-		} );
+				files[ fileExtension ] = singlePath;
+			} );
 
 		return files;
 	},

package/src/hexo/get-repo-urls.js

@@ -6,7 +6,7 @@
 'use strict';
 
 const upath = require( 'upath' );
-const glob = require( 'glob' );
+const { globSync } = require( 'glob' );
 
 module.exports = ( {
 	rootPath,
@@ -18,10 +18,9 @@ module.exports = ( {
 
 	for ( const item of packages ) {
 		const packageRepoUrl = getRepoUrl( upath.join( rootPath, item.path ) );
-		glob.sync( upath.join( rootPath, item.path, 'docs', '**', '*.md' ) )
-			.map( p => {
-				return p.replace( upath.join( rootPath, item.path, 'docs' ), '' );
-			} )
+		globSync( upath.join( rootPath, item.path, 'docs', '**', '*.md' ) )
+			.map( p => upath.normalize( p ) )
+			.map( p => p.replace( upath.join( rootPath, item.path, 'docs' ), '' ) )
 			.forEach( p => {
 				guidesToRepos[ p ] = packageRepoUrl;
 			} );

package/src/hexo-manager.js

@@ -5,13 +5,13 @@
 
 'use strict';
 
+const { styleText } = require( 'util' );
 const upath = require( 'upath' );
 const fs = require( 'fs-extra' );
-const getHexoConfig = require( './tasks/get-hexo-config' );
+const { globSync } = require( 'glob' );
 const Hexo = require( '../hexo-shim' );
+const getHexoConfig = require( './tasks/get-hexo-config' );
 const extendConfig = require( './hexo/filter/extend-config' );
-const chalk = require( 'chalk' );
-const glob = require( 'glob' );
 
 /**
  * Class used to initialize and control hexo.
@@ -106,7 +106,9 @@ class HexoManager {
 				return this.hexo.exit();
 			} )
 			.catch( err => {
-				console.log( `${ chalk.red( 'Error:' ) } ${ chalk.redBright( 'There was something wrong during hexo generation.' ) }` );
+				console.log(
+					`${ styleText( 'red', 'Error:' ) } ${ styleText( 'redBright', 'There was something wrong during hexo generation.' ) }`
+				);
 				this.hexo.exit( err );
 
 				throw err;
@@ -132,14 +134,16 @@ class HexoManager {
 
 	cleanSymLinks() {
 		const rootPath = this.config.public_dir;
-		const pathsToCheck = glob.sync( upath.join( rootPath, '**', 'latest' ) ).concat( glob.sync( upath.join( rootPath, 'latest' ) ) );
-		pathsToCheck.forEach( p => {
-			const stat = fs.lstatSync( p );
-
-			if ( stat.isSymbolicLink() ) {
-				fs.unlinkSync( p );
-			}
-		} );
+		globSync( upath.join( rootPath, '**', 'latest' ) )
+			.concat( globSync( upath.join( rootPath, 'latest' ) ) )
+			.map( p => upath.normalize( p ) )
+			.forEach( p => {
+				const stat = fs.lstatSync( p );
+
+				if ( stat.isSymbolicLink() ) {
+					fs.unlinkSync( p );
+				}
+			} );
 	}
 
 	/**

package/src/index.js

@@ -5,8 +5,8 @@
 
 'use strict';
 
+const { styleText } = require( 'util' );
 const path = require( 'path' );
-const chalk = require( 'chalk' );
 const compileSass = require( './tasks/compile-sass' );
 const runWebpack = require( './tasks/run-webpack' );
 const copyAssets = require( './tasks/copy-assets' );
@@ -38,7 +38,7 @@ module.exports = {
 
 			await buildAndWatch( options );
 		} catch ( err ) {
-			console.error( chalk.redBright( `Building documentation failed: ${ err.stack }` ) );
+			console.error( styleText( 'redBright', `Building documentation failed: ${ err.stack }` ) );
 			process.exitCode = 1;
 
 			throw err;
@@ -55,7 +55,7 @@ module.exports = {
 		try {
 			await buildAndWatch( options );
 		} catch ( err ) {
-			console.error( chalk.redBright( `Building documentation failed: ${ err.stack }` ) );
+			console.error( styleText( 'redBright', `Building documentation failed: ${ err.stack }` ) );
 			process.exitCode = 1;
 
 			throw err;
@@ -93,7 +93,7 @@ async function buildAndWatch( options ) {
 
 	const [ time ] = process.hrtime( timer );
 
-	console.log( chalk.greenBright( `Building documentation complete in ${ Math.floor( time / 60 ) }m ${ time % 60 }s.` ) );
+	console.log( styleText( 'greenBright', `Building documentation complete in ${ Math.floor( time / 60 ) }m ${ time % 60 }s.` ) );
 
 	if ( options.watch ) {
 		return watcher( hexoManager );

package/src/sdk-builder/get-sdk-sources.js

@@ -7,14 +7,15 @@
 
 const fs = require( 'fs' );
 const upath = require( 'upath' );
-const glob = require( 'glob' );
+const { globSync } = require( 'glob' );
 const cheerio = require( 'cheerio' );
 
 const SDK_SELECTOR = 'meta[name="sdk-samples"]';
 
 module.exports = sourcePath => {
 	const files = [];
-	const filePaths = glob.sync( upath.join( sourcePath, '*.html' ) );
+	const filePaths = globSync( upath.join( sourcePath, '*.html' ) ).map( path => upath.normalize( path ) );
+
 	for ( const filePath of filePaths ) {
 		const content = fs.readFileSync( filePath, { encoding: 'utf8' } );
 		const $ = cheerio.load( content, null, false );

package/src/tasks/build-documentation.js

@@ -22,11 +22,10 @@ const cacheFiles = require( './cache-files' );
 const overwriteApiGuides = require( './overwrite-api-guides' );
 const cacheDir = upath.join( __dirname, '../../temp/cache' );
 const validateLinks = require( './validate-links' );
-const createSitemap = require( './create-sitemap' );
+const createSitemapStep = require( './create-sitemap-step' );
 const buildSnippets = require( './build-snippets' );
 const copyProjectIcons = require( './copy-project-icons' );
 const executeHooks = require( './execute-hooks' );
-const chalk = require( 'chalk' );
 const umbertoVersion = require( '../../package.json' ).version;
 
 const parseLink = require( '../../scripts/utils/parselinks' );
@@ -56,7 +55,6 @@ const getFilePatternsToProcess = require( '../helpers/get-file-patterns-to-proce
  * @param {Object} options.snippetOptions Additional options passed to snippetAdapter.
  * @param {Boolean} options.skipValidation Skip validating links.
  * @param {Boolean} options.skipGuides Skip processing guides. Useful for checking the layout changes.
- * @param {Boolean} options.skipSitemap Skip generating sitemap file. Useful when doing partial build.
  * @param {Boolean} options.verbose Provide more details during building documentation.
  * @param {Boolean} [options.watch] Flag which indicates that hexo should watch files.
  * @param {Array.<String>} [options.guides] An array containing names of guides that will be processed by Umberto. Useful when building
@@ -77,7 +75,6 @@ module.exports = options => {
 		snippetOptions = {},
 		skipValidation = false,
 		skipGuides = false,
-		skipSitemap = false,
 		watch = false,
 		verbose = false,
 		guides = []
@@ -224,68 +221,11 @@ module.exports = options => {
 				publicDir: hexoManager.getPublicDir()
 			} );
 		} )
-		// Create sitemap.xml file.
 		.then( async () => {
-			let hostname;
-			let dst = '';
 			const projectConfigs = await getProjectConfigs( rootPath, projectPaths );
-			const config = mainConfig.isSingleProject && projectConfigs && projectConfigs.length > 0 ?
-				projectConfigs[ 0 ] : {};
-			const sitemapConfig = mainConfig.sitemap ? mainConfig.sitemap : config.sitemap;
-
-			// If available, use sitemap config from umberto-main.json.
-			// Use sitemap config from umberto.json otherwise.
-			if ( sitemapConfig && mainConfig.isSingleProject ) {
-				hostname = sitemapConfig.hostname;
-				dst = upath.join( config.slug, config.version );
-			} else if ( sitemapConfig ) {
-				hostname = sitemapConfig.hostname;
-			} else {
-				if ( verbose ) {
-					console.log( chalk.yellow( 'Warning: ' ), 'Not enough data to create a sitemap.xml file.' );
-				}
-
-				return Promise.resolve();
-			}
-
-			// Get urls to be excluded from the sitemap.
-			// Use excluded urls both from umberto-main.json and umberto.json.
-			const excludedUrls = [];
-
-			if ( mainConfig.sitemap && mainConfig.sitemap.excluded ) {
-				excludedUrls.push( ...mainConfig.sitemap.excluded );
-			}
-
-			for ( const currentConfig of projectConfigs ) {
-				if ( currentConfig.sitemap && currentConfig.sitemap.excluded ) {
-					excludedUrls.push( ...currentConfig.sitemap.excluded );
-				}
-			}
 
-			// Get extra sitemap settings per url. At the moment it's just custom priority for urls.
-			// Use both umberto-main.json and umberto.json.
-			const extraUrlSettings = [];
-
-			if ( mainConfig.sitemap && mainConfig.sitemap.extraUrlSettings ) {
-				extraUrlSettings.push( ...mainConfig.sitemap.extraUrlSettings );
-			}
-
-			for ( const currentConfig of projectConfigs ) {
-				if ( currentConfig.sitemap && currentConfig.sitemap.extraUrlSettings ) {
-					extraUrlSettings.push( ...currentConfig.sitemap.extraUrlSettings );
-				}
-			}
-
-			if ( skipSitemap ) {
-				return Promise.resolve();
-			}
-
-			return createSitemap( 'build/docs', hostname, dst, {
-				excluded: excludedUrls,
-				extraUrlSettings
-			} );
+			return createSitemapStep( { projectConfigs, verbose, mainConfig } );
 		} )
-
 		.then( async () => {
 			const configs = await getProjectConfigs( rootPath, projectPaths );
 

package/src/tasks/cache-files.js

@@ -6,7 +6,7 @@
 'use strict';
 
 const upath = require( 'upath' );
-const glob = require( 'glob' );
+const { globSync } = require( 'glob' );
 const fs = require( 'fs-extra' );
 
 /**
@@ -17,7 +17,7 @@ const fs = require( 'fs-extra' );
  * @returns {boolean}
  */
 module.exports = ( src, dst ) => {
-	const sourcePaths = glob.sync( upath.join( src, '**', '*' ) );
+	const sourcePaths = globSync( upath.join( src, '**', '*' ) ).map( path => upath.normalize( path ) );
 	let result = false;
 
 	for ( const p of sourcePaths ) {

package/src/tasks/copy-files.js

@@ -7,7 +7,7 @@
 
 const upath = require( 'upath' );
 const fs = require( 'fs-extra' );
-const glob = require( 'glob' );
+const { globSync } = require( 'glob' );
 const globToRegexp = require( '../helpers/glob-to-regexp' );
 
 /**
@@ -64,10 +64,11 @@ module.exports = ( src, dst, options = {} ) => {
 	// If the `src` is a path to a directory, copy files from the directory.
 	const sourceGlobPath = upath.join( src, '**/*' );
 
-	let sourceFilePaths = glob.sync( sourceGlobPath, {
+	let sourceFilePaths = globSync( sourceGlobPath, {
 		ignore: ignored.map( ignoredPath => upath.join( src, ignoredPath ) ),
 		nodir: true
-	} );
+	} )
+		.map( path => upath.normalize( path ) );
 
 	// If the `match` is an array, remove files that should not be processed.
 	if ( match ) {

package/src/tasks/copy-project-icons.js

@@ -6,37 +6,29 @@
 'use strict';
 
 const upath = require( 'upath' );
-const mkdirp = require( 'mkdirp' );
-const copyFile = require( '../helpers/copy-file' );
+const fs = require( 'fs-extra' );
 
 /**
- * @returns {Promise}
+ * @returns {Promise<void>}
  */
-module.exports = function copyProjectIcons( projectGlobals, buildDirectory ) {
+module.exports = async function copyProjectIcons( projectGlobals, buildDirectory ) {
 	const availableProjects = Object.keys( projectGlobals ).filter( projectName => projectName !== 'common' );
 
-	let promise = Promise.resolve();
-
 	for ( const project of availableProjects ) {
 		const projectDetails = projectGlobals[ project ];
 		const destinationIconsPath = upath.join( buildDirectory, projectDetails.BASE_PATH, 'assets', 'icons' );
 
-		promise = promise.then( () => mkdirp( destinationIconsPath ) );
-
 		for ( const [ sourceFile, destinationName ] of projectDetails._icons ) {
 			const fullSourcePath = upath.join( projectDetails.config.projectRootPath, 'node_modules', sourceFile );
 			const fullDestinationPath = upath.join( destinationIconsPath, destinationName );
 
-			promise = promise.then( () => {
-				return copyFile( fullSourcePath, fullDestinationPath )
-					.catch( () => {
-						console.warn(
-							`⚠️ The "${ sourceFile }" icon cannot be copied because it does not exist in "${ fullSourcePath }".`
-						);
-					} );
-			} );
+			try {
+				await fs.copy( fullSourcePath, fullDestinationPath );
+			} catch ( error ) {
+				console.warn(
+					`⚠️ The "${ sourceFile }" icon cannot be copied because it does not exist in "${ fullSourcePath }".`
+				);
+			}
 		}
 	}
-
-	return promise;
 };

package/src/tasks/create-sitemap-index.js

@@ -0,0 +1,47 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+const upath = require( 'upath' );
+const fs = require( 'fs/promises' );
+
+const XMLNS_STRINGS = [
+	'xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"',
+	'xmlns:news="http://www.google.com/schemas/sitemap-news/0.9"',
+	'xmlns:xhtml="http://www.w3.org/1999/xhtml"',
+	'xmlns:image="http://www.google.com/schemas/sitemap-image/1.1"',
+	'xmlns:video="http://www.google.com/schemas/sitemap-video/1.1"'
+];
+
+/**
+ * Creates a sitemap.xml file and saves it to build directory.
+ *
+ * @param {Object} options
+ * @param {String} options.buildPath Path to the build directory.
+ * @param {String} options.hostname Hostname of the website where the documentation will be hosted.
+ * @param {Array.<string>} options.sitemapPaths Paths to generated sitemap files.
+ * @returns {Promise}
+ */
+module.exports = ( { buildPath, hostname, sitemapPaths } ) => {
+	const sitemapPath = upath.resolve( upath.join( buildPath, 'sitemap.xml' ) );
+	const sitemapIndexContent = [
+		'<?xml version="1.0" encoding="UTF-8"?>',
+		`<sitemapindex ${ XMLNS_STRINGS.join( ' ' ) }>`,
+
+		...sitemapPaths.map( sitemapPath => {
+			const relativePath = sitemapPath.split( buildPath ).pop().replace( /^\/+/, '' );
+			const fullUrl = new URL( relativePath, hostname.endsWith( '/' ) ? hostname : hostname + '/' );
+
+			return [
+				'<sitemap>',
+				`<loc>${ fullUrl.toString() }</loc>`,
+				'</sitemap>'
+			];
+		} ),
+
+		'</sitemapindex>'
+	].flat().join( '' );
+
+	return fs.writeFile( sitemapPath, sitemapIndexContent, 'utf8' );
+};

package/src/tasks/create-sitemap-step.js

@@ -0,0 +1,106 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+const { styleText } = require( 'util' );
+const createSitemap = require( './create-sitemap' );
+const createSitemapIndex = require( './create-sitemap-index' );
+
+const BUILD_PATH = 'build/docs';
+
+/**
+ * This build step handles sitemap building.
+ *
+ * @param {Object} options
+ * @param {Object} options.mainConfig
+ * @param {Object} options.projectConfigs
+ * @param {Object} options.verbose
+ */
+module.exports = async function createSitemapStep( { mainConfig, projectConfigs, verbose } ) {
+	if ( mainConfig.isSingleProject ) {
+		// If available, use sitemap config from umberto-main.json.
+		// Use sitemap config from umberto.json otherwise.
+		const config = projectConfigs && projectConfigs.length > 0 ? projectConfigs[ 0 ] : {};
+		const sitemapConfig = mainConfig.sitemap ? mainConfig.sitemap : config.sitemap;
+
+		if ( !sitemapConfig ) {
+			return missingSitemapWarning( verbose );
+		}
+
+		if ( !sitemapConfig.enabled ) {
+			if ( verbose ) {
+				console.log(
+					styleText( 'yellow', 'Warning: ' ),
+					'To enable generating a sitemap.xml file, add the "enabled: true" property to "sitemap" configuration.'
+				);
+			}
+
+			return;
+		}
+
+		return createSitemap( {
+			buildPath: BUILD_PATH,
+			projectSlug: config.slug,
+			projectVersion: config.version,
+			hostname: sitemapConfig.hostname,
+			excluded: sitemapConfig.excluded || []
+		} );
+	}
+
+	if ( !mainConfig.sitemap ) {
+		return missingSitemapWarning( verbose );
+	}
+
+	const { hostname } = mainConfig.sitemap;
+
+	const promises = projectConfigs.map( projectConfig => {
+		const excluded = [];
+
+		if ( mainConfig.sitemap?.excluded ) {
+			excluded.push( ...mainConfig.sitemap.excluded );
+		}
+
+		if ( projectConfig.sitemap?.excluded ) {
+			excluded.push( ...projectConfig.sitemap.excluded );
+		}
+
+		return createSitemap( {
+			hostname,
+			projectSlug: projectConfig.slug,
+			projectVersion: projectConfig.version,
+			buildPath: BUILD_PATH,
+			excluded
+		} );
+	} );
+
+	const sitemapPaths = await Promise.all( promises );
+
+	// Generate the sitemap index only if all projects are being built.
+	if ( !mainConfig.ignoredProjects.length ) {
+		// To collect the HTML files from the build root directory.
+		const rootSitemap = await createSitemap( {
+			buildPath: BUILD_PATH,
+			hostname,
+			excluded: mainConfig.sitemap?.excluded || [],
+			fileName: 'sitemap-root.xml'
+		} );
+
+		await createSitemapIndex( {
+			buildPath: BUILD_PATH,
+			hostname,
+			sitemapPaths: [
+				rootSitemap,
+				...sitemapPaths
+			]
+		} );
+	}
+};
+
+function missingSitemapWarning( verbose ) {
+	if ( !verbose ) {
+		return;
+	}
+
+	console.log( styleText( 'yellow', 'Warning: ' ), 'Not enough data to create a sitemap.xml file.' );
+}

package/src/tasks/create-sitemap.js

@@ -5,53 +5,64 @@
 
 'use strict';
 
+const fs = require( 'fs' );
+const { globSync } = require( 'glob' );
 const upath = require( 'upath' );
-const glob = require( 'glob' );
+const { URL } = require( 'url' );
 const { SitemapStream, streamToPromise } = require( 'sitemap' );
-const fs = require( 'fs' );
 
 /**
  * Creates a sitemap.xml file and saves it to build directory.
  *
- * @param {String} buildPath Path to the build directory.
- * @param {String} hostname Hostname of the website where the documentation will be hosted.
- * @param {String} dst Additional path in the build directory where to save the sitemap.xml.
- * @param {Object} options Additional options.
- * @param {Array.<String>} options.excludedUrls An array of urls to be excluded from the sitemap.
- * @param {Array.<Object>} options.extraUrlSettings An array of config objects per url. Currently used to set custom priority per url.
- * @returns {Promise}
+ * @param {Object} options
+ * @param {String} options.fileName
+ * @param {String} options.projectSlug
+ * @param {String} options.projectVersion
+ * @param {String} options.buildPath Path to the build directory.
+ * @param {String} options.hostname Hostname of the website where the documentation will be hosted.
+ * @param {Array.<String>} options.excluded An array of urls to be excluded from the sitemap.
+ * @returns {Promise.<string>} Path to the generated sitemap.
  */
-module.exports = ( buildPath, hostname, dst = '', options = {} ) => {
-	const pattern = upath.join( buildPath, '**', '*.html' );
-	const pathsToFiles = glob.sync( pattern );
-	const sitemap = new SitemapStream( {
+module.exports = options => {
+	const {
+		fileName = 'sitemap.xml',
+		projectSlug,
+		projectVersion,
+		buildPath,
 		hostname,
+		excluded = []
+	} = options;
+
+	// The `sitemap` package expects that `hostname` will not include subdirectories.
+	// Let's split it and glue the destination URL manually.
+	const { origin, pathname } = new URL( hostname );
+
+	const { pattern, sitemapPath } = getSitemapData( { buildPath, projectSlug, fileName } );
+	const sitemap = new SitemapStream( {
+		hostname: origin,
 		cacheTime: 600000
 	} );
 
-	for ( const filePath of pathsToFiles ) {
-		const urlForSitemap = filePath.replace( buildPath, 'docs' ).replace( /(\/[^/]+\/)[^/]+\//, '$1latest/' );
-		const excludedUrls = options.excluded || [];
-		const extraUrlSettings = options.extraUrlSettings || [];
+	const pathToFiles = globSync( pattern ).map( path => upath.normalize( path ) );
+
+	for ( const filePath of pathToFiles ) {
+		let urlForSitemap = filePath.replace( buildPath, upath.normalizeTrim( pathname ) );
+
+		if ( projectVersion ) {
+			urlForSitemap = urlForSitemap.replace( `/${ projectVersion }/`, '/latest/' );
+		}
 
 		if ( filePath.endsWith( '404.html' ) ) {
 			continue;
 		}
 
-		if ( excludedUrls.find( excluded => filePath.includes( excluded ) ) ) {
+		if ( excluded.find( excluded => filePath.includes( excluded ) ) ) {
 			continue;
 		}
 
-		const extraUrlSetting = extraUrlSettings.find( setting => filePath.includes( setting.url ) );
-		const sitemapItem = {
+		sitemap.write( {
 			url: urlForSitemap
-		};
-
-		if ( extraUrlSetting && extraUrlSetting.priority ) {
-			sitemapItem.priority = Math.min( extraUrlSetting.priority, 1.0 );
-		}
-
-		sitemap.write( sitemapItem );
+		} );
 	}
 
 	sitemap.end();
@@ -59,13 +70,23 @@ module.exports = ( buildPath, hostname, dst = '', options = {} ) => {
 	return streamToPromise( sitemap )
 		.then( data => {
 			return new Promise( ( resolve, reject ) => {
-				fs.writeFile( upath.resolve( upath.join( buildPath, dst, 'sitemap.xml' ) ), data.toString(), err => {
+				fs.writeFile( sitemapPath, data.toString(), err => {
 					if ( err ) {
 						return reject( err );
 					}
 
-					return resolve();
+					return resolve( sitemapPath );
 				} );
 			} );
 		} );
 };
+
+function getSitemapData( { buildPath, projectSlug, fileName } ) {
+	return {
+		pattern: projectSlug ? upath.join( buildPath, projectSlug, '**', '*.html' ) : upath.join( buildPath, '*.html' ),
+
+		sitemapPath: upath.resolve(
+			projectSlug ? upath.join( buildPath, projectSlug, fileName ) : upath.join( buildPath, fileName )
+		)
+	};
+}

package/src/tasks/create-sym-links.js

@@ -5,10 +5,10 @@
 
 'use strict';
 
-const getProjectConfig = require( './get-project-config' );
-const upath = require( 'upath' );
+const { styleText } = require( 'util' );
 const fs = require( 'fs' );
-const chalk = require( 'chalk' );
+const upath = require( 'upath' );
+const getProjectConfig = require( './get-project-config' );
 
 module.exports = async ( {
 	mainConfig,
@@ -34,16 +34,16 @@ module.exports = async ( {
 
 	return Promise.resolve();
 
-	function createSymbolicLink( config ) {
-		const destinationPath = upath.join( rootPath, 'build', 'docs', config.slug, 'latest' );
+	function createSymbolicLink( { slug, name, version } ) {
+		const destinationPath = upath.join( rootPath, 'build', 'docs', slug, 'latest' );
 
 		if ( !fs.existsSync( destinationPath ) ) {
 			// The 3rd argument to the fs.symlinkSync() method is the link type and it is only available
 			// on Windows (it is ignored on other platforms). Creating a symlink to a directory with link
 			// type = 'dir' requires admin privileges on Windows. The only way to create a directory symlink
 			// without admin privileges on Windows is to use the 'junction' link type.
-			fs.symlinkSync( config.version, destinationPath, 'junction' );
-			console.log( `Symlink for ${ chalk.cyanBright( config.name ) } ${ chalk.magentaBright( './' + config.version ) } - created. ` );
+			fs.symlinkSync( version, destinationPath, 'junction' );
+			console.log( `Symlink for ${ styleText( 'cyanBright', name ) } ${ styleText( 'magentaBright', './' + version ) } - created.` );
 		}
 	}
 };

package/src/tasks/get-project-config.js

@@ -7,7 +7,7 @@
 
 const upath = require( 'upath' );
 const fs = require( 'fs' );
-const glob = require( 'glob' );
+const { globSync } = require( 'glob' );
 const importModule = require( '../helpers/import-module' );
 
 const cache = new Map();
@@ -369,7 +369,8 @@ function getPackagesPathsInfo( rootPath, slug, directory ) {
 	// CKEditor 5 can have packages that do not start with `ckeditor5-` prefix.
 	const slugOrRegExp = slug === 'ckeditor5' ? /ckeditor5?-/ : `${ slug }-`;
 
-	return glob.sync( upath.resolve( rootPath, directory ) )
+	return globSync( upath.resolve( rootPath, directory ) )
+		.map( p => upath.normalize( p ) )
 		.map( p => {
 			const relativePath = p.replace( rootPath + '/', '' );
 

package/src/tasks/overwrite-api-guides.js

@@ -6,7 +6,7 @@
 'use strict';
 
 const upath = require( 'upath' );
-const glob = require( 'glob' );
+const { globSync } = require( 'glob' );
 const fs = require( 'fs-extra' );
 
 /**
@@ -17,7 +17,7 @@ const fs = require( 'fs-extra' );
  * @param dst
  */
 module.exports = ( src, dst ) => {
-	const sourcePaths = glob.sync( upath.join( src, '**', '*' ) );
+	const sourcePaths = globSync( upath.join( src, '**', '*' ) ).map( path => upath.normalize( path ) );
 
 	for ( const p of sourcePaths ) {
 		const strippedPath = p.replace( src, '' );

package/src/tasks/read-doc-sources.js

@@ -7,7 +7,7 @@
 
 const upath = require( 'upath' );
 const fs = require( 'fs' );
-const glob = require( 'glob' );
+const { globSync } = require( 'glob' );
 const DOC_FORMATS = require( '../helpers/doc-formats' );
 
 /**
@@ -18,7 +18,7 @@ const DOC_FORMATS = require( '../helpers/doc-formats' );
  * @returns {Array}
  */
 module.exports = ( sourcePath, type ) => {
-	const fileNames = glob.sync( upath.join( sourcePath, `**/*.${ DOC_FORMATS[ type ] }` ) );
+	const fileNames = globSync( upath.join( sourcePath, `**/*.${ DOC_FORMATS[ type ] }` ) ).map( path => upath.normalize( path ) );
 	const files = [];
 
 	for ( const fileName of fileNames ) {

package/src/tasks/validate-links.js

@@ -5,15 +5,15 @@
 
 'use strict';
 
+const { styleText } = require( 'util' );
 const upath = require( 'upath' );
 const fs = require( 'fs-extra' );
-const glob = require( 'glob' );
-const chalk = require( 'chalk' );
+const { globSync } = require( 'glob' );
 const { parseDocument } = require( 'htmlparser2' );
 
 module.exports = ( buildPath, options = {} ) => {
 	const pattern = upath.join( buildPath, '**', '*' );
-	let pathsToFiles = glob.sync( pattern );
+	let pathsToFiles = globSync( pattern ).map( path => upath.normalize( path ) );
 
 	const links = new Set();
 
@@ -108,10 +108,13 @@ module.exports = ( buildPath, options = {} ) => {
 
 		if ( invalidHrefs.size ) {
 			process.exitCode = 1;
-			console.log( `${ chalk.red( 'Error: ' ) }Invalid internal links in ${ chalk.magenta( filePath.replace( buildPath, '' ) ) }:` );
+			console.log(
+				styleText( 'red', 'Error: ' ) +
+				`Invalid internal links in ${ styleText( 'magenta', filePath.replace( buildPath, '' ) ) }:`
+			);
 
 			for ( const url of invalidHrefs ) {
-				console.log( chalk.gray( `  * '${ url.href }' - ${ url.text.replace( /\s+/g, ' ' ) }` ) );
+				console.log( styleText( 'gray', `  * '${ url.href }' - ${ url.text.replace( /\s+/g, ' ' ) }` ) );
 			}
 		}
 	}

package/src/tasks/watcher.js

@@ -5,24 +5,27 @@
 
 'use strict';
 
+const { styleText } = require( 'util' );
 const upath = require( 'upath' );
-const cpx = require( 'cpx' );
-const chalk = require( 'chalk' );
+const chokidar = require( 'chokidar' );
+const { copy } = require( 'fs-extra' );
 
-module.exports = hexoManager => new Promise( resolve => {
-	console.log( chalk.yellow( 'Umberto is in watch mode press CTRL+C to exit.' ) );
-	const originPaths = hexoManager.getOriginPaths();
+module.exports = function watchMd( hexoManager ) {
+	console.log( styleText( 'yellow', 'Umberto is in watch mode – press CTRL+C to exit.' ) );
 
-	for ( const item of originPaths ) {
-		const path1 = upath.join( item.originPath, '*.md' );
-		const path2 = upath.join( item.originPath, '**', '*.md' );
-
-		cpx.watch( path1, item.dstPath, { initialCopy: false } );
-		cpx.watch( path2, item.dstPath, { initialCopy: false } );
+	for ( const { originPath, dstPath } of hexoManager.getOriginPaths() ) {
+		chokidar
+			.watch( originPath, {
+				ignoreInitial: true,
+				ignored: ( path, stats ) => stats?.isFile() && !path.endsWith( '.md' )
+			} )
+			.on( 'add', file => copyFile( originPath, dstPath, file ) )
+			.on( 'change', file => copyFile( originPath, dstPath, file ) );
 	}
+};
+
+function copyFile( originPath, dstPath, file ) {
+	const dest = upath.join( dstPath, upath.relative( originPath, file ) );
 
-	process.on( 'SIGINT', function() {
-		resolve();
-		process.exit();
-	} );
-} );
+	return copy( file, dest );
+}

package/src/tasks/write-html-files.js

@@ -5,8 +5,7 @@
 
 'use strict';
 
-const fs = require( 'fs' );
-const mkdirp = require( 'mkdirp' );
+const fs = require( 'fs-extra' );
 const upath = require( 'upath' );
 
 /**
@@ -14,29 +13,15 @@ const upath = require( 'upath' );
  *
  * @param {Array.<HtmlFile>} files HtmlFile objects containing content to be written to .html files to file system.
  * @param {String} destinationDir Additional destination path. Additional because files already have its own path.
- * @returns {Promise}
+ * @returns {Promise<void>}
  */
-module.exports = ( files, destinationDir = '.' ) => {
-	const promises = [];
-
-	for ( const file of files ) {
-		const fileDir = upath.join( destinationDir, file.dirname );
-
-		const promise = mkdirp( upath.resolve( fileDir ) )
-			.then( () => {
-				return new Promise( ( resolve, reject ) => {
-					fs.writeFile( upath.join( fileDir, file.basename ), file.content, err => {
-						if ( err ) {
-							return reject( err );
-						}
-
-						return resolve();
-					} );
-				} );
-			} );
-
-		promises.push( promise );
-	}
-
-	return Promise.all( promises );
+module.exports = async ( files, destinationDir = '.' ) => {
+	const writePromises = files.map( file =>
+		fs.outputFile(
+			upath.join( destinationDir, file.dirname, file.basename ),
+			file.content
+		)
+	);
+
+	return Promise.all( writePromises );
 };

package/src/template/template-collection.js

@@ -15,7 +15,7 @@ const splitLongname = require( '../helpers/split-longname' );
 const extractLongname = require( '../helpers/extract-longname' );
 const getApiInfoboxTooltip = require( '../helpers/get-api-infobox-tooltip' );
 const capitalize = require( '../helpers/capitalize' );
-const relative_url = require( 'hexo/lib/plugins/helper/relative_url' ); // eslint-disable-line camelcase
+const relative_url = require( 'hexo/dist/plugins/helper/relative_url' ); // eslint-disable-line camelcase
 
 /**
  * Provides pug templates and adds various helpers to them.

package/themes/umberto/src/gloria/js/app.js

@@ -3,11 +3,6 @@
  * For licensing, see LICENSE.md.
  */
 
-// Polyfill for `window.Symbol`.
-import '@babel/polyfill';
-// Polyfill for `Element.closest()`.
-import 'element-closest/browser';
-
 import $ from 'jquery';
 import { setupPrism } from './_prism';
 import { enableCollapsables, hideTogglers } from './_collapsables';

package/themes/umberto/src/umberto/js/app.js

@@ -3,11 +3,6 @@
  * For licensing, see LICENSE.md.
  */
 
-// Polyfill for `window.Symbol`.
-import '@babel/polyfill';
-// Polyfill for `Element.closest()`.
-import 'element-closest/browser';
-
 import $ from 'jquery';
 import { setupPrism } from './_prism';
 import { enableCollapsables, hideTogglers } from './_collapsables';

package/src/helpers/copy-file.js

@@ -1,34 +0,0 @@
-/**
- * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-'use strict';
-
-const fs = require( 'fs' );
-
-/**
- * Copies a specified file from the `source` path to the `destination` path.
- *
- * @param {String} source
- * @param {String} destination
- * @return {Promise}
- */
-module.exports = function copyFile( source, destination ) {
-	return new Promise( ( resolve, reject ) => {
-		const readStream = fs.createReadStream( source );
-
-		// In order to catch an error if `source` points to non-existing file, we need to wait for
-		// the `#open` event emitted by the read readStream.
-		readStream.on( 'open', () => {
-			const writeStream = fs.createWriteStream( destination );
-
-			readStream.pipe( writeStream );
-
-			writeStream.on( 'error', reject );
-			writeStream.on( 'finish', resolve );
-		} );
-
-		readStream.on( 'error', reject );
-	} );
-};