Merge pull request #13071 from ckeditor/ck/12998

Other (basic-styles): Rewritten ckeditor5-basic-styles package to TypeScript. Closes #12998.

.gitignore

@@ -25,8 +25,8 @@ mrgit.json
 .yalc
 yalc.lock
 
-
 # Ignore compiled TypeScript files.
+packages/ckeditor5-basic-styles/src/**/*.js
 packages/ckeditor5-clipboard/src/**/*.js
 packages/ckeditor5-code-block/src/**/*.js
 packages/ckeditor5-core/src/**/*.js

packages/ckeditor5-basic-styles/package.json

@@ -10,7 +10,7 @@
     "ckeditor5-plugin",
     "ckeditor5-dll"
   ],
-  "main": "src/index.js",
+  "main": "src/index.ts",
   "dependencies": {
     "ckeditor5": "^35.4.0"
   },
@@ -24,6 +24,7 @@
     "@ckeditor/ckeditor5-theme-lark": "^35.4.0",
     "@ckeditor/ckeditor5-ui": "^35.4.0",
     "@ckeditor/ckeditor5-utils": "^35.4.0",
+    "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"
   },
@@ -42,13 +43,16 @@
   },
   "files": [
     "lang",
-    "src",
+    "src/**/*.js",
+    "src/**/*.d.ts",
     "theme",
     "build",
     "ckeditor5-metadata.json",
     "CHANGELOG.md"
   ],
   "scripts": {
-    "dll:build": "webpack"
+    "dll:build": "webpack",
+    "build": "tsc -p ./tsconfig.release.json",
+    "postversion": "npm run build"
   }
 }

packages/ckeditor5-basic-styles/src/attributecommand.ts

@@ -0,0 +1,133 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module basic-styles/attributecommand
+ */
+
+import { Command, type Editor } from 'ckeditor5/src/core';
+
+/**
+ * An extension of the base {@link module:core/command~Command} class, which provides utilities for a command
+ * that toggles a single attribute on a text or an element.
+ *
+ * `AttributeCommand` uses {@link module:engine/model/document~Document#selection}
+ * to decide which nodes (if any) should be changed, and applies or removes the attribute from them.
+ *
+ * The command checks the {@link module:engine/model/model~Model#schema} to decide if it can be enabled
+ * for the current selection and to which nodes the attribute can be applied.
+ */
+export default class AttributeCommand extends Command {
+	/**
+	 * Flag indicating whether the command is active. The command is active when the
+	 * {@link module:engine/model/selection~Selection#hasAttribute selection has the attribute} which means that:
+	 *
+	 * * If the selection is not empty – That the attribute is set on the first node in the selection that allows this attribute.
+	 * * If the selection is empty – That the selection has the attribute itself (which means that newly typed
+	 * text will have this attribute, too).
+	 *
+	 * @observable
+	 * @readonly
+	 */
+	declare public value: boolean;
+
+	/**
+	 * The attribute that will be set by the command.
+	 */
+	public readonly attributeKey: string;
+
+	/**
+	 * @param attributeKey Attribute that will be set by the command.
+	 */
+	constructor( editor: Editor, attributeKey: string ) {
+		super( editor );
+
+		this.attributeKey = attributeKey;
+	}
+
+	/**
+	 * Updates the command's {@link #value} and {@link #isEnabled} based on the current selection.
+	 */
+	public override refresh(): void {
+		const model = this.editor.model;
+		const doc = model.document;
+
+		this.value = this._getValueFromFirstAllowedNode();
+		this.isEnabled = model.schema.checkAttributeInSelection( doc.selection, this.attributeKey );
+	}
+
+	/**
+	 * Executes the command — applies the attribute to the selection or removes it from the selection.
+	 *
+	 * If the command is active (`value == true`), it will remove attributes. Otherwise, it will set attributes.
+	 *
+	 * The execution result differs, depending on the {@link module:engine/model/document~Document#selection}:
+	 *
+	 * * If the selection is on a range, the command applies the attribute to all nodes in that range
+	 * (if they are allowed to have this attribute by the {@link module:engine/model/schema~Schema schema}).
+	 * * If the selection is collapsed in a non-empty node, the command applies the attribute to the
+	 * {@link module:engine/model/document~Document#selection} itself (note that typed characters copy attributes from the selection).
+	 * * If the selection is collapsed in an empty node, the command applies the attribute to the parent node of the selection (note
+	 * that the selection inherits all attributes from a node if it is in an empty node).
+	 *
+	 * @fires execute
+	 * @param options Command options.
+	 * @param options.forceValue If set, it will force the command behavior. If `true`,
+	 * the command will apply the attribute, otherwise the command will remove the attribute.
+	 * If not set, the command will look for its current value to decide what it should do.
+	 */
+	public override execute( options: { forceValue?: boolean } = {} ): void {
+		const model = this.editor.model;
+		const doc = model.document;
+		const selection = doc.selection;
+		const value = ( options.forceValue === undefined ) ? !this.value : options.forceValue;
+
+		model.change( writer => {
+			if ( selection.isCollapsed ) {
+				if ( value ) {
+					writer.setSelectionAttribute( this.attributeKey, true );
+				} else {
+					writer.removeSelectionAttribute( this.attributeKey );
+				}
+			} else {
+				const ranges = model.schema.getValidRanges( selection.getRanges(), this.attributeKey );
+
+				for ( const range of ranges ) {
+					if ( value ) {
+						writer.setAttribute( this.attributeKey, value, range );
+					} else {
+						writer.removeAttribute( this.attributeKey, range );
+					}
+				}
+			}
+		} );
+	}
+
+	/**
+	 * Checks the attribute value of the first node in the selection that allows the attribute.
+	 * For the collapsed selection returns the selection attribute.
+	 *
+	 * @returns The attribute value.
+	 */
+	private _getValueFromFirstAllowedNode(): boolean {
+		const model = this.editor.model;
+		const schema = model.schema;
+		const selection = model.document.selection;
+
+		if ( selection.isCollapsed ) {
+			return selection.hasAttribute( this.attributeKey );
+		}
+
+		for ( const range of selection.getRanges() ) {
+			for ( const item of range.getItems() ) {
+				if ( schema.checkAttribute( item, this.attributeKey ) ) {
+					return item.hasAttribute( this.attributeKey );
+				}
+			}
+		}
+
+		return false;
+	}
+}

packages/ckeditor5-basic-styles/src/bold.ts

@@ -0,0 +1,43 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module basic-styles/bold
+ */
+
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+import BoldEditing from './bold/boldediting';
+import BoldUI from './bold/boldui';
+
+/**
+ * The bold feature.
+ *
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature documentation}
+ * and the {@glink api/basic-styles package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:basic-styles/bold/boldediting~BoldEditing bold editing feature}
+ * and {@link module:basic-styles/bold/boldui~BoldUI bold UI feature}.
+ */
+export default class Bold extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
+	public static get requires(): PluginDependencies {
+		return [ BoldEditing, BoldUI ];
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public static get pluginName(): 'Bold' {
+		return 'Bold';
+	}
+}
+
+declare module '@ckeditor/ckeditor5-core' {
+	interface PluginsMap {
+		[ Bold.pluginName ]: Bold;
+	}
+}

packages/ckeditor5-basic-styles/src/bold/boldediting.ts

@@ -0,0 +1,83 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module basic-styles/bold/boldediting
+ */
+
+import { Plugin } from 'ckeditor5/src/core';
+import AttributeCommand from '../attributecommand';
+
+const BOLD = 'bold';
+
+/**
+ * The bold editing feature.
+ *
+ * It registers the `'bold'` command and introduces the `bold` attribute in the model which renders to the view
+ * as a `<strong>` element.
+ */
+export default class BoldEditing extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
+	public static get pluginName(): 'BoldEditing' {
+		return 'BoldEditing';
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public init(): void {
+		const editor = this.editor;
+		// Allow bold attribute on text nodes.
+		editor.model.schema.extend( '$text', { allowAttributes: BOLD } );
+		editor.model.schema.setAttributeProperties( BOLD, {
+			isFormatting: true,
+			copyOnEnter: true
+		} );
+
+		// Build converter from model to view for data and editing pipelines.
+		editor.conversion.attributeToElement( {
+			model: BOLD,
+			view: 'strong',
+			upcastAlso: [
+				'b',
+				viewElement => {
+					const fontWeight = viewElement.getStyle( 'font-weight' );
+
+					if ( !fontWeight ) {
+						return null;
+					}
+
+					// Value of the `font-weight` attribute can be defined as a string or a number.
+					if ( fontWeight == 'bold' || Number( fontWeight ) >= 600 ) {
+						return {
+							name: true,
+							styles: [ 'font-weight' ]
+						};
+					}
+
+					return null;
+				}
+			]
+		} );
+
+		// Create bold command.
+		editor.commands.add( BOLD, new AttributeCommand( editor, BOLD ) );
+
+		// Set the Ctrl+B keystroke.
+		editor.keystrokes.set( 'CTRL+B', BOLD );
+	}
+}
+
+declare module '@ckeditor/ckeditor5-core' {
+	interface CommandsMap {
+		bold: AttributeCommand;
+	}
+
+	interface PluginsMap {
+		[ BoldEditing.pluginName ]: BoldEditing;
+	}
+}

packages/ckeditor5-basic-styles/src/bold/boldui.ts

@@ -0,0 +1,63 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module basic-styles/bold/boldui
+ */
+
+import { Plugin, icons } from 'ckeditor5/src/core';
+import { ButtonView } from 'ckeditor5/src/ui';
+
+const BOLD = 'bold';
+
+/**
+ * The bold UI feature. It introduces the Bold button.
+ */
+export default class BoldUI extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
+	public static get pluginName(): 'BoldUI' {
+		return 'BoldUI';
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public init(): void {
+		const editor = this.editor;
+		const t = editor.t;
+
+		// Add bold button to feature components.
+		editor.ui.componentFactory.add( BOLD, locale => {
+			const command = editor.commands.get( BOLD )!;
+			const view = new ButtonView( locale );
+
+			view.set( {
+				label: t( 'Bold' ),
+				icon: icons.bold,
+				keystroke: 'CTRL+B',
+				tooltip: true,
+				isToggleable: true
+			} );
+
+			view.bind( 'isOn', 'isEnabled' ).to( command, 'value', 'isEnabled' );
+
+			// Execute command.
+			this.listenTo( view, 'execute', () => {
+				editor.execute( BOLD );
+				editor.editing.view.focus();
+			} );
+
+			return view;
+		} );
+	}
+}
+
+declare module '@ckeditor/ckeditor5-core' {
+	interface PluginsMap {
+		[ BoldUI.pluginName ]: BoldUI;
+	}
+}