umberto 2.1.7 → 2.2.0

package/README.md

@@ -108,6 +108,7 @@ You can also have a look at [CKEditor5](https://github.com/ckeditor/ckeditor5/tr
 | `path` | Path where to look for documentation source files (Markdown files, images etc.). The path is relative to the location of `umberto.json`. |
 | `startPage` | Path to page linked in drop down menu. If there is nothing provided, then `index.html` (from main project directory) is used. |
 | `redirects` | Object where as a key is stored string representing `old-url` and as a value is stored string representing `new-url`. (_Currently redirects are used only in deployment scripts of big-bang docs._) |
+| `googleoptimize` | `domains` - Array of whitelisted domains from which GO can be used; `id` - container ID |
 | `googletagmanager` | `domains` - Array of whitelisted domains from which GA can be used; `gtm` - container ID |
 | `googleanalytics` | `domains` - Array of whitelisted domains from which GA can be used; `config` - options passed to ga('create') method |
 | `feedbackWidget` | `domains` - Array of whitelisted domains from which feedback widget can be used; `apiKey` - unique key for widget |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umberto",
-  "version": "2.1.7",
+  "version": "2.2.0",
   "description": "CKSource Documentation builder",
   "main": "src/index.js",
   "files": [
@@ -10,13 +10,14 @@
     ".editorconfig",
     ".eslintrc.js",
     "hexo-config.json",
-    "hexo-shim.js"
+    "hexo-shim.js",
+    "scripts-dev/postinstall.js"
   ],
   "dependencies": {
     "@babel/core": "^7.18.10",
     "@babel/polyfill": "^7.12.1",
     "@babel/preset-env": "^7.18.10",
-    "@ckeditor/jsdoc-plugins": "^30.3.5",
+    "@ckeditor/jsdoc-plugins": "^32.0.1",
     "babel-loader": "^8.2.5",
     "chalk": "^4.1.0",
     "cheerio": "^1.0.0-rc.12",
@@ -54,13 +55,15 @@
     "webpack": "^5.74.0"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-dev-env": "^30.3.5",
+    "@ckeditor/ckeditor5-dev-bump-year": "^32.0.1",
+    "@ckeditor/ckeditor5-dev-ci": "^32.0.1",
+    "@ckeditor/ckeditor5-dev-release-tools": "^32.0.1",
     "browser-sync": "^2.27.10",
     "chai": "^4.3.6",
     "chokidar": "^3.5.3",
     "eslint": "^8.21.0",
     "eslint-config-ckeditor5": "^4.0.1",
-    "husky": "^8.0.0",
+    "husky": "^8.0.2",
     "lint-staged": "^13.0.3",
     "mocha": "^10.0.0",
     "mockery": "^2.1.0",
@@ -71,6 +74,7 @@
     "npm": ">=5.7.1"
   },
   "scripts": {
+    "postinstall": "node ./scripts-dev/postinstall.js",
     "dev:build-single": "node ./scripts-dev/build-single.js",
     "dev:build-multi": "node ./scripts-dev/build-multi.js",
     "dev:serve": "node ./scripts-dev/serve.js",
@@ -79,8 +83,7 @@
     "coverage": "nyc --reporter=lcov --reporter=text-summary --cache false npm run test",
     "changelog": "node ./scripts-dev/changelog.js",
     "release:bump-version": "node ./scripts-dev/bump-version.js",
-    "release:publish": "node ./scripts-dev/publish.js",
-    "prepare": "husky install"
+    "release:publish": "node ./scripts-dev/publish.js"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "MIT",
@@ -101,6 +104,6 @@
     "packages/**"
   ],
   "hexo": {
-    "version": "6.2.0"
+    "version": "6.3.0"
   }
 }

package/scripts-dev/postinstall.js

@@ -0,0 +1,18 @@
+/**
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+/* eslint-env node */
+
+const path = require( 'path' );
+const fs = require( 'fs' );
+const ROOT_DIRECTORY = path.join( __dirname, '..' );
+
+// When installing a repository as a dependency, the `.git` directory does not exist.
+// In such a case, husky should not attach its hooks as npm treats it as a package, not a git repository.
+if ( fs.existsSync( path.join( ROOT_DIRECTORY, '.git' ) ) ) {
+	require( 'husky' ).install();
+}

package/src/hexo/filter/project-locals.js

@@ -17,6 +17,7 @@ const umbertoVersion = require( '../../../package.json' ).version;
  * @param {String} basePath Project's base path, e.g. 'ckeditor5/1.0.0'.
  * @param {Object} docSearch Algolia's docsearch config.
  * @param {Object} config umberto.json config.
+ * @param {Object} googleoptimize Google Optimize config.
  * @param {Object} googletagmanager Google Tag Manager config.
  * @param {Object} googleanalytics Google Analytics config.
  * @param {Object} feedbackWidget Feedback widget config
@@ -30,6 +31,7 @@ module.exports = ( ctx, {
 	basePath,
 	docSearch = {},
 	config,
+	googleoptimize,
 	googletagmanager,
 	googleanalytics,
 	feedbackWidget,
@@ -93,6 +95,7 @@ module.exports = ( ctx, {
 
 		locals.umbertoVersion = umbertoVersion;
 		locals.disableSearch = disableSearch;
+		locals.googleoptimize = googleoptimize;
 		locals.googletagmanager = googletagmanager;
 		locals.googleanalytics = googleanalytics;
 		locals.feedbackWidget = feedbackWidget;

package/src/index.js

@@ -56,6 +56,7 @@ module.exports = {
 				mainConfig: {
 					projects: [ '.' ],
 					docsearch: pConfig.docsearch,
+					googleoptimize: pConfig.googleoptimize,
 					googletagmanager: pConfig.googletagmanager,
 					googleanalytics: pConfig.googleanalytics,
 					feedbackWidget: pConfig.feedbackWidget,

package/src/tasks/build-documentation.js

@@ -135,6 +135,7 @@ module.exports = options => {
 				dev,
 				docSearch: mainConfig.docsearch,
 				disableSearch: mainConfig.docsearch === false,
+				googleoptimize: mainConfig.googleoptimize,
 				googletagmanager: mainConfig.googletagmanager,
 				googleanalytics: mainConfig.googleanalytics,
 				feedbackWidget: mainConfig.feedbackWidget,
@@ -305,6 +306,7 @@ function buildProjects( rootPath, projectPaths, options = {} ) {
 				extraStyles: options.extraStyles,
 				extraScripts: options.extraScripts,
 				disableSearch: options.disableSearch,
+				googleoptimize: options.googleoptimize,
 				googletagmanager: options.googletagmanager,
 				googleanalytics: options.googleanalytics,
 				feedbackWidget: options.feedbackWidget,
@@ -322,6 +324,7 @@ function buildProjects( rootPath, projectPaths, options = {} ) {
 			extraStyles: options.extraStyles,
 			extraScripts: options.extraScripts,
 			disableSearch: options.disableSearch,
+			googleoptimize: options.googleoptimize,
 			googletagmanager: options.googletagmanager,
 			googleanalytics: options.googleanalytics,
 			feedbackWidget: options.feedbackWidget,
@@ -362,6 +365,7 @@ function buildProjects( rootPath, projectPaths, options = {} ) {
 			basePath,
 			docSearch: options.docSearch,
 			config,
+			googleoptimize: options.googleoptimize,
 			googletagmanager: options.googletagmanager,
 			googleanalytics: options.googleanalytics,
 			feedbackWidget: options.feedbackWidget,
@@ -464,6 +468,7 @@ function buildApis( projectConfigs, options = {} ) {
 					projectSlug: config.slug
 				},
 				disableSearch: options.disableSearch,
+				googleoptimize: options.googleoptimize,
 				googletagmanager: options.googletagmanager,
 				googleanalytics: options.googleanalytics,
 				feedbackWidget: options.feedbackWidget,
@@ -531,6 +536,7 @@ function buildSdks( projectConfigs, options = {} ) {
 				},
 				disableSearch: options.disableSearch,
 				projectsData: basicProjectsData,
+				googleoptimize: options.googleoptimize,
 				googletagmanager: options.googletagmanager,
 				googleanalytics: options.googleanalytics,
 				feedbackWidget: options.feedbackWidget,

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

@@ -368,7 +368,7 @@ 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 glob.sync( upath.resolve( rootPath, directory ) )
 		.map( p => {
 			const relativePath = p.replace( rootPath + '/', '' );
 

package/themes/umberto/layout/_api-docs/_mixin/_class-item.pug

@@ -10,6 +10,11 @@ mixin classItem( item )
 	li( class="collapsing-list__item collapsing-list__item--visible" )&attributes( attrData )
 		div( class="collapsing-list__term" id=item.id )
 			h3
+				if isNonEmptyArray( item.badges )
+					p.badges
+						each badge in item.badges
+							+badge( badge )
+
 				code
 					+linkOrText( item.longname, {
 						doStripLongname: false,
@@ -18,10 +23,6 @@ mixin classItem( item )
 
 				+devNames( item.longname )
 
-			if isNonEmptyArray( item.badges )
-				p.badges
-					each badge in item.badges
-						+badge( badge )
 		if ( item.description && item.description.excerpt )
 			div.collapsing-list__description
 				p( class="collapsing-list__excerpt collapsing-list__excerpt--short" )

package/themes/umberto/layout/_api-docs/_mixin/_dev-names.pug

@@ -1,3 +1,3 @@
 mixin devNames( name )
-	span.collapsing-list__dev-names( aria-hidden='true' )
+	span.collapsing-list__dev-names( aria-hidden='true', title=name )
 		code #{ name }

package/themes/umberto/layout/_api-docs/_mixin/_method.pug

@@ -16,6 +16,12 @@ mixin method( met )
 		- const id = encodeURI( met.id )
 		div( class="collapsing-list__term toggler--collapsed" id=id )
 			h3
+				//- badges
+				if isNonEmptyArray( met.badges )
+					p.badges
+						each badge in met.badges
+							+badge( badge )
+
 				code
 					a( class="member-name" href="#" + id ) #{ met.name }
 
@@ -41,13 +47,9 @@ mixin method( met )
 						if isNonEmptyArray( met.returns[0].types )
 							+type( met.returns[0].types )
 
-				+devNames( met.longname )
 
-				//- badges
-			if isNonEmptyArray( met.badges )
-				p.badges
-					each badge in met.badges
-						+badge( badge )
+
+				+devNames( met.longname )
 
 		div.collapsing-list__description
 			if ( met.description && met.description.excerpt )

package/themes/umberto/layout/_api-docs/_mixin/_property.pug

@@ -12,6 +12,11 @@ mixin property( prop )
 	li( class = itemClasses )&attributes( attrData )
 		div( class="collapsing-list__term toggler--collapsed" id=prop.id )
 			h3
+				if isNonEmptyArray( prop.badges )
+					p.badges
+						each badge in prop.badges
+							+badge( badge )
+
 				code
 					a( class="member-name" href="#" + prop.id ) #{ prop.name }
 
@@ -21,11 +26,6 @@ mixin property( prop )
 
 				+devNames( prop.longname )
 
-			if isNonEmptyArray( prop.badges )
-				p.badges
-					each badge in prop.badges
-						+badge( badge )
-
 		div.collapsing-list__description
 			if ( prop.description && prop.description.excerpt )
 				div.collapsing-list__excerpt

package/themes/umberto/layout/_partial/google-optimize.pug

@@ -0,0 +1,15 @@
+if googleoptimize
+
+    // Google Optimize
+    script.
+        if (!{ JSON.stringify(googleoptimize.domains) }.indexOf(location.hostname) !== -1) {
+            (function (w, d, s, i) {
+                var f = d.getElementsByTagName(s)[0],
+                    j = d.createElement(s);
+                j.async = true;
+                j.src = 'https://www.googleoptimize.com/optimize.js?id=' + i;
+                f.parentNode.insertBefore(j, f);
+            })( window, document, 'script', '!{ googleoptimize.id }' );
+        }
+
+    // End Google Optimize

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

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

package/themes/umberto/layout/_partial/report-issue-widget.pug

@@ -6,7 +6,7 @@
 
 div.info-box.notice.notice__feedback
     p
-        | Every day, we work hard to keep our documentation complete. Have you spotted an outdated information? Is something missing?
+        | Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing?
         | Please report it via our!{' '}
         a( href=githubUrl.toString() id='report-widget-issue-tracker' ) issue tracker
         | .

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

@@ -148,10 +148,17 @@ ul.collapsing-list {
 
 			margin-bottom: 0;
 			padding-top: 0;
+			width: 100%;
 
 			&:first-of-type {
 				flex: 2;
 			}
+
+			.badges {
+				text-align: right;
+				float: right;
+				margin-left: u-spacing( 0 );
+			}
 		}
 
 		p {
@@ -159,11 +166,6 @@ ul.collapsing-list {
 			padding-top: 0;
 		}
 
-		.badges {
-			text-align: right;
-			margin-left: u-spacing( 0 );
-		}
-
 		&.hidden {
 			&::before {
 				display: none;
@@ -241,6 +243,12 @@ ul.collapsing-list {
 			color: u-color( 'text', 40% );
 			font-size: u-font-size( -1 );
 			cursor: default;
+			white-space: nowrap;
+			overflow: hidden;
+			text-overflow: ellipsis;
+			direction: rtl;
+			text-align: left;
+			width: 100%;
 		}
 		& code {
 			display: none;