umberto 2.1.6 → 2.1.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umberto",
-  "version": "2.1.6",
+  "version": "2.1.8",
   "description": "CKSource Documentation builder",
   "main": "src/index.js",
   "files": [
@@ -60,7 +60,7 @@
     "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 +71,7 @@
     "npm": ">=5.7.1"
   },
   "scripts": {
+    "postinstall": "node ./scripts/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 +80,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",

package/scripts/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/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,21 +47,18 @@ 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 )
 				div.collapsing-list__excerpt
 					p !{ met.description.excerpt }
-					+seeSource( met )
 
 			div.collapsing-list__content
+				+seeSource( met )
+
 				if ( met.description )
 					| !{ met.description.content }
 

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,18 +26,14 @@ 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
 					p !{ prop.description.excerpt }
-					+seeSource( prop )
 
 			div.collapsing-list__content
+				+seeSource( prop )
+
 				if ( prop.description )
 					| !{ prop.description.content }
 

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/_api-see-source.scss

@@ -26,7 +26,9 @@
 		.toggler--expanded + .collapsing-list__description {
 			.see-source {
 				display: block;
+				float: right;
 				margin-left: 50px;
+				margin-bottom: 12px;
 			}
 		}
 	}

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

@@ -123,7 +123,9 @@ ul.collapsing-list {
 
 					.see-source {
 						display: block;
+						float: right;
 						margin-left: 50px;
+						margin-bottom: 12px;
 					}
 				}
 			}
@@ -146,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 {
@@ -157,11 +166,6 @@ ul.collapsing-list {
 			padding-top: 0;
 		}
 
-		.badges {
-			text-align: right;
-			margin-left: u-spacing( 0 );
-		}
-
 		&.hidden {
 			&::before {
 				display: none;
@@ -239,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;