umberto 2.4.0 → 2.5.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umberto",
-  "version": "2.4.0",
+  "version": "2.5.1",
   "description": "CKSource Documentation builder",
   "main": "src/index.js",
   "files": [
@@ -56,10 +56,10 @@
     "webpack": "^5.74.0"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-dev-bump-year": "^34.0.0",
-    "@ckeditor/ckeditor5-dev-ci": "^34.0.0",
-    "@ckeditor/ckeditor5-dev-docs": "^34.0.0",
-    "@ckeditor/ckeditor5-dev-release-tools": "^34.0.0",
+    "@ckeditor/ckeditor5-dev-bump-year": "^35.0.0",
+    "@ckeditor/ckeditor5-dev-ci": "^35.0.0",
+    "@ckeditor/ckeditor5-dev-docs": "^35.0.0",
+    "@ckeditor/ckeditor5-dev-release-tools": "^35.0.0",
     "browser-sync": "^2.27.10",
     "chai": "^4.3.6",
     "chokidar": "^3.5.3",

package/scripts/filter/after-post-render/fix-code-samples.js

@@ -7,10 +7,22 @@
 
 const { default: cheerio } = require( 'cheerio' );
 
+const regexp = /(?<=>)utf8_encoded_content:([0-9,]+)(?=<\/code><\/pre>)/g;
+const textDecoder = new TextDecoder();
+
 /**
  * Fixes some codeblocks issues.
  */
 hexo.extend.filter.register( 'after_post_render', page => {
+	// Decoding codeblocks inside infobox from UTF-8. See #1122.
+	if ( regexp.test( page.content ) ) {
+		page.content = page.content.replace( regexp, ( match, encodedContent ) => {
+			const decodedContent = textDecoder.decode( new Uint8Array( encodedContent.split( ',' ) ) );
+
+			return decodedContent.replace( /^\n/, '' );
+		} );
+	}
+
 	const $ = cheerio.load( page.content, null, false );
 
 	// This is an attempt to automatically discover code blocks of HTML and add 'html' class if needed.

package/scripts/utils/transforminfobox.js

@@ -7,6 +7,9 @@
 
 const INFO_BOX_REGEXP = /<info-box[^>]*>([\s\S]*?)<\/info-box>/g;
 const INFO_BOX_TYPE_REGEXP = /<info-box\s*(\w*)[^>]*>/;
+const CODEBLOCK_REGEXP_STRING = /```(\S+)?(\n[\s\S]*?)```/g;
+
+const textEncoder = new TextEncoder();
 
 /**
  * Replaces the `<info-box>` element with the HTML `div` element. E.g.:
@@ -61,6 +64,15 @@ function processInfobox( content, hexo ) {
 		content = content.replace( /^\n/, '' );
 		content = content.replace( /\n$/, '' );
 
+		// Encoding codeblocks inside infobox into UTF-8. See #1122.
+		content = content.replace( CODEBLOCK_REGEXP_STRING, ( match, language, content ) => {
+			const encodedContent = textEncoder.encode( content );
+
+			return language ?
+				`<pre class="highlight"><code class="${ language }">utf8_encoded_content:${ encodedContent }</code></pre>` :
+				`<pre class="highlight"><code>utf8_encoded_content:${ encodedContent }</code></pre>`;
+		} );
+
 		let markdownOutput = hexo.render.renderSync( { text: content, engine: 'markdown' } );
 		markdownOutput = markdownOutput.replace( /<\/p>\n/g, '</p>' );
 		markdownOutput = markdownOutput.replace( /\n<p>/g, '<p>' );

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

@@ -47,7 +47,7 @@ module.exports = class AccessorParser extends AbstractParser {
 
 			scope: this.getScope( item ),
 			readonly: this.isReadonly( item ),
-			access: this.getVisibility( item ),
+			access: this.getVisibilityIncludingSignature( item ),
 			kind: this.getKind( item ),
 			extraId: this.getExtraId( item ),
 			description: this.getComment( getSignature || setSignature ),
@@ -61,4 +61,21 @@ module.exports = class AccessorParser extends AbstractParser {
 			params: null
 		};
 	}
+
+	/**
+	 * Returns the access type for the item based on its signatures.
+	 *
+	 * @param {TypedocReflection<Accessor>} item
+	 * @returns {'public'|'internal'|'protected'|'private'}
+	 */
+	getVisibilityIncludingSignature( item ) {
+		if ( item.setSignature ) {
+			return this.getVisibility( item.setSignature );
+		}
+
+		if ( item.getSignature ) {
+			return this.getVisibility( item.getSignature );
+		}
+		return this.getVisibility( item );
+	}
 };

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

@@ -33,7 +33,7 @@ module.exports = class MethodParser extends AbstractParser {
 
 				scope: this.getScope( item ),
 				kind: this.getKind( item ),
-				access: this.getVisibility( item ),
+				access: this.getVisibilityIncludingSignature( item, index ),
 				extraId: this.getExtraId( item ),
 				fires: this.getFiredEvents( signature, parentName ),
 				description: this.getComment( signature ),
@@ -60,4 +60,21 @@ module.exports = class MethodParser extends AbstractParser {
 			return doclet;
 		} );
 	}
+
+	/**
+	 * Returns the access type for the item based on its signatures.
+	 *
+	 * @param {TypedocReflection<ConstructorOrMethod>} item
+	 * @param {Number} sourceIndex
+	 * @returns {'public'|'internal'|'protected'|'private'}
+	 */
+	getVisibilityIncludingSignature( item, sourceIndex ) {
+		const signatureVisibility = this.getVisibility( item.signatures[ sourceIndex ] );
+
+		if ( signatureVisibility !== 'public' ) {
+			return signatureVisibility;
+		}
+
+		return this.getVisibility( item );
+	}
 };

package/src/tasks/build-documentation.js

@@ -22,7 +22,7 @@ const cacheFiles = require( './cache-files' );
 const overwriteApiGuides = require( './overwrite-api-guides' );
 const cacheDir = upath.join( __dirname, '../../temp/cache' );
 const validateLinks = require( './validate-links' );
-const createSitemamp = require( './create-sitemap' );
+const createSitemap = require( './create-sitemap' );
 const buildSnippets = require( './build-snippets' );
 const copyProjectIcons = require( './copy-project-icons' );
 const executeHooks = require( './execute-hooks' );
@@ -269,7 +269,7 @@ module.exports = options => {
 				}
 			}
 
-			return createSitemamp( 'build/docs', hostname, dst, {
+			return createSitemap( 'build/docs', hostname, dst, {
 				excluded: excludedUrls,
 				extraUrlSettings
 			} );
@@ -339,6 +339,17 @@ function buildProjects( rootPath, projectPaths, options = {} ) {
 		skipGuides: options.skipGuides
 	} );
 
+	if ( !projectConfigs.length ) {
+		hexoManager.hexo.extend.filter.register( 'template_locals', locals => {
+			// Most probably this if is always true. Locals same for all projects.
+			if ( !locals.projectsData ) {
+				locals.projectsData = [];
+			}
+			locals.umbertoVersion = umbertoVersion;
+			locals.pathJoin = upath.join;
+		} );
+	}
+
 	projectConfigs.forEach( config => {
 		const basePath = upath.join( config.slug, config.version );
 		const extraStyles = getExtraFiles(

package/themes/umberto/layout/_partial/head.pug

@@ -60,7 +60,8 @@ if projectLocals
 if page.isSnippetPage
 	//UMBERTO: SNIPPET: CSS
 
-include google-optimize 
+include google-optimize
 include google-tag-manager
 include google-analytics
 
+block projectVersion

package/themes/umberto/layout/api.pug

@@ -17,3 +17,7 @@ block navtree
 block append content
 	if page.reportIssueWidget
 		include _partial/report-issue-widget
+
+block projectVersion
+	if projectLocals
+		meta( name= 'project-version' content= projectLocals.projectVersion )

package/themes/umberto/layout/page.pug

@@ -19,3 +19,7 @@ block append content
 
 block navtree
 	include _partial/nav-tree
+
+block projectVersion
+	if projectLocals
+		meta( name= 'project-version' content= projectLocals.projectVersion )

package/themes/umberto/layout/sdk.pug

@@ -19,3 +19,7 @@ block navtree
 				nav.side-navigation__inner
 					ul.tree.sdk-tree
 						!= projectLocals.sdkNavTree
+
+block projectVersion
+	if projectLocals
+		meta( name= 'project-version' content= projectLocals.projectVersion )

package/themes/umberto/src/css/_notice.scss

@@ -57,6 +57,7 @@ p.tip {
 
 	&__feedback {
 	  	border-left: 3px solid u-color( 'hint-hint' );
+	  	background-color: rgba( u-color( 'hint-hint' ), .1 );
 	}
 
 	&__warning {
@@ -64,6 +65,11 @@ p.tip {
 		background-color: rgba( u-color( 'hint-warning' ), .1 );
 	}
 
+	&__error {
+		border-left: 3px solid u-color( 'hint-error' );
+		background-color: rgba( u-color( 'hint-error' ), .1 );
+	}
+
 	&_menu-like {
 		ul, ol {
 			list-style: none;

package/themes/umberto/src/css/_prism.scss

@@ -125,11 +125,6 @@ div.code-toolbar {
 	position: relative;
 
 	& > .toolbar {
-		/* The toolbar does not look well on mobiles. There's not enough space. */
-		@include u-responsive-mobile {
-			display: none;
-		}
-
 		position: absolute;
 		top: u-spacing( -2 );
 		right: u-spacing( -2 );

package/themes/umberto/src/css/helpers/_color.scss

@@ -30,7 +30,8 @@ $u-colors: (
 	// Hints
 	'hint-info': #64B5F6,
 	'hint-hint': #AB47BC,
-	'hint-warning': #FF1D00
+	'hint-warning': #FFE600,
+	'hint-error': #FF1D00
 );
 
 @function u-color( $name, $offset: 0% ) {

package/themes/umberto/src/js/_attachpermalinklistener.js

@@ -0,0 +1,38 @@
+/**
+ * @license Copyright (c) 2017-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+const latestRegexp = /(?<=\/)latest(?=\/)/;
+
+export default function attachPermalinkListener() {
+	const projectVersionElement = document.querySelector( 'meta[name=project-version]' );
+
+	if ( !projectVersionElement ) {
+		return;
+	}
+
+	const projectVersion = projectVersionElement.getAttribute( 'content' );
+
+	document.addEventListener( 'keypress', event => {
+		if ( event.metaKey ) {
+			return;
+		}
+
+		if ( event.shiftKey ) {
+			return;
+		}
+
+		if ( event.key.toUpperCase() !== 'Y' ) {
+			return;
+		}
+
+		if ( !latestRegexp.test( location.href ) ) {
+			return;
+		}
+
+		const newUrl = location.href.replace( latestRegexp, projectVersion );
+
+		history.replaceState( history.state, document.title, newUrl );
+	} );
+}

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

@@ -26,6 +26,7 @@ import { rwdButton } from './_rwdmenu';
 import imageModal from './_imageModal';
 import showWarningBanner from './_warningbanner';
 import { enableBadgeTooltips, createTooltip } from './_tooltips';
+import attachPermalinkListener from './_attachpermalinklistener';
 
 // Changing documentation theme. To enable, type in the console: `localStorage.setItem( 'theme', 'theme-dark' )`.
 if ( localStorage.getItem( 'theme' ) === 'theme-dark' ) {
@@ -54,6 +55,7 @@ $( document ).ready( () => {
 	scrollApiTree();
 	setUpFuse();
 	activateDevNames();
+	attachPermalinkListener();
 	sideNavigation();
 	rwdButton();
 	imageModal(); // lightbox for { @img } elements