@ckeditor/ckeditor5-remove-format 36.0.0 → 37.0.0-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-remove-format",
-  "version": "36.0.0",
+  "version": "37.0.0-alpha.0",
   "description": "Remove format feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,24 +12,25 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "^36.0.0"
+    "ckeditor5": "^37.0.0-alpha.0"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^36.0.0",
-    "@ckeditor/ckeditor5-clipboard": "^36.0.0",
-    "@ckeditor/ckeditor5-core": "^36.0.0",
-    "@ckeditor/ckeditor5-dev-utils": "^32.0.0",
-    "@ckeditor/ckeditor5-editor-classic": "^36.0.0",
-    "@ckeditor/ckeditor5-engine": "^36.0.0",
-    "@ckeditor/ckeditor5-enter": "^36.0.0",
-    "@ckeditor/ckeditor5-heading": "^36.0.0",
-    "@ckeditor/ckeditor5-image": "^36.0.0",
-    "@ckeditor/ckeditor5-link": "^36.0.0",
-    "@ckeditor/ckeditor5-paragraph": "^36.0.0",
-    "@ckeditor/ckeditor5-theme-lark": "^36.0.0",
-    "@ckeditor/ckeditor5-typing": "^36.0.0",
-    "@ckeditor/ckeditor5-undo": "^36.0.0",
-    "@ckeditor/ckeditor5-utils": "^36.0.0",
+    "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-clipboard": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-dev-utils": "^34.0.0",
+    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-enter": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-heading": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-image": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-link": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-typing": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-undo": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.0",
+    "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"
   },
@@ -48,13 +49,17 @@
   },
   "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"
+  },
+  "types": "src/index.d.ts"
 }

package/src/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module remove-format
+ */
+export { default as RemoveFormat } from './removeformat';
+export { default as RemoveFormatEditing } from './removeformatediting';
+export { default as RemoveFormatUI } from './removeformatui';

package/src/index.js

@@ -2,11 +2,9 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module remove-format
  */
-
 export { default as RemoveFormat } from './removeformat';
 export { default as RemoveFormatEditing } from './removeformatediting';
 export { default as RemoveFormatUI } from './removeformatui';

package/src/removeformat.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module remove-format/removeformat
+ */
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+/**
+ * The remove format plugin.
+ *
+ * This is a "glue" plugin which loads the {@link module:remove-format/removeformatediting~RemoveFormatEditing}
+ * and {@link module:remove-format/removeformatui~RemoveFormatUI} plugins.
+ *
+ * For a detailed overview, check out the {@glink features/remove-format remove format} feature documentation.
+ */
+export default class RemoveFormat extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'RemoveFormat';
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [RemoveFormat.pluginName]: RemoveFormat;
+    }
+}

package/src/removeformat.js

@@ -2,16 +2,12 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module remove-format/removeformat
  */
-
 import { Plugin } from 'ckeditor5/src/core';
-
 import RemoveFormatUI from './removeformatui';
 import RemoveFormatEditing from './removeformatediting';
-
 /**
  * The remove format plugin.
  *
@@ -19,21 +15,18 @@ import RemoveFormatEditing from './removeformatediting';
  * and {@link module:remove-format/removeformatui~RemoveFormatUI} plugins.
  *
  * For a detailed overview, check out the {@glink features/remove-format remove format} feature documentation.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class RemoveFormat extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ RemoveFormatEditing, RemoveFormatUI ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'RemoveFormat';
-	}
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [RemoveFormatEditing, RemoveFormatUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'RemoveFormat';
+    }
 }

package/src/removeformatcommand.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { Command } from 'ckeditor5/src/core';
+/**
+ * The remove format command.
+ *
+ * It is used by the {@link module:remove-format/removeformat~RemoveFormat remove format feature}
+ * to clear the formatting in the selection.
+ *
+ * ```ts
+ * editor.execute( 'removeFormat' );
+ * ```
+ */
+export default class RemoveFormatCommand extends Command {
+    value: boolean;
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * @inheritDoc
+     */
+    execute(): void;
+    /**
+     * Returns an iterable of items in a selection (including the selection itself) that have formatting model
+     * attributes to be removed by the feature.
+     *
+     * @param schema The schema describing the item.
+     */
+    private _getFormattingItems;
+    /**
+     * Returns an iterable of formatting attributes of a given model item.
+     *
+     * **Note:** Formatting items have the `isFormatting` property set to `true`.
+     *
+     * @param schema The schema describing the item.
+     * @returns The names of formatting attributes found in a given item.
+     */
+    private _getFormattingAttributes;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface CommandsMap {
+        removeFormat: RemoveFormatCommand;
+    }
+}

package/src/removeformatcommand.js

@@ -2,113 +2,93 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
-/**
- * @module remove-format/removeformatcommand
- */
-
 import { Command } from 'ckeditor5/src/core';
 import { first } from 'ckeditor5/src/utils';
-
 /**
  * The remove format command.
  *
  * It is used by the {@link module:remove-format/removeformat~RemoveFormat remove format feature}
  * to clear the formatting in the selection.
  *
- *		editor.execute( 'removeFormat' );
- *
- * @extends module:core/command~Command
+ * ```ts
+ * editor.execute( 'removeFormat' );
+ * ```
  */
 export default class RemoveFormatCommand extends Command {
-	/**
-	 * @inheritDoc
-	 */
-	refresh() {
-		const model = this.editor.model;
-
-		this.isEnabled = !!first( this._getFormattingItems( model.document.selection, model.schema ) );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	execute() {
-		const model = this.editor.model;
-		const schema = model.schema;
-
-		model.change( writer => {
-			for ( const item of this._getFormattingItems( model.document.selection, schema ) ) {
-				if ( item.is( 'selection' ) ) {
-					for ( const attributeName of this._getFormattingAttributes( item, schema ) ) {
-						writer.removeSelectionAttribute( attributeName );
-					}
-				} else {
-					// Workaround for items with multiple removable attributes. See
-					// https://github.com/ckeditor/ckeditor5-remove-format/pull/1#pullrequestreview-220515609
-					const itemRange = writer.createRangeOn( item );
-
-					for ( const attributeName of this._getFormattingAttributes( item, schema ) ) {
-						writer.removeAttribute( attributeName, itemRange );
-					}
-				}
-			}
-		} );
-	}
-
-	/**
-	 * Returns an iterable of items in a selection (including the selection itself) that have formatting model
-	 * attributes to be removed by the feature.
-	 *
-	 * @protected
-	 * @param {module:engine/model/documentselection~DocumentSelection} selection
-	 * @param {module:engine/model/schema~Schema} schema The schema describing the item.
-	 * @returns {Iterable.<module:engine/model/item~Item>|Iterable.<module:engine/model/documentselection~DocumentSelection>}
-	 */
-	* _getFormattingItems( selection, schema ) {
-		const itemHasRemovableFormatting = item => {
-			return !!first( this._getFormattingAttributes( item, schema ) );
-		};
-
-		// Check formatting on selected items that are not blocks.
-		for ( const curRange of selection.getRanges() ) {
-			for ( const item of curRange.getItems() ) {
-				if ( !schema.isBlock( item ) && itemHasRemovableFormatting( item ) ) {
-					yield item;
-				}
-			}
-		}
-
-		// Check formatting from selected blocks.
-		for ( const block of selection.getSelectedBlocks() ) {
-			if ( itemHasRemovableFormatting( block ) ) {
-				yield block;
-			}
-		}
-
-		// Finally the selection might be formatted as well, so make sure to check it.
-		if ( itemHasRemovableFormatting( selection ) ) {
-			yield selection;
-		}
-	}
-
-	/**
-	 * Returns an iterable of formatting attributes of a given model item.
-	 *
-	 * **Note:** Formatting items have the `isFormatting` property set to `true`.
-	 *
-	 * @protected
-	 * @param {module:engine/model/item~Item|module:engine/model/documentselection~DocumentSelection} item
-	 * @param {module:engine/model/schema~Schema} schema The schema describing the item.
-	 * @returns {Iterable.<String>} The names of formatting attributes found in a given item.
-	 */
-	* _getFormattingAttributes( item, schema ) {
-		for ( const [ attributeName ] of item.getAttributes() ) {
-			const attributeProperties = schema.getAttributeProperties( attributeName );
-
-			if ( attributeProperties && attributeProperties.isFormatting ) {
-				yield attributeName;
-			}
-		}
-	}
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const model = this.editor.model;
+        this.isEnabled = !!first(this._getFormattingItems(model.document.selection, model.schema));
+    }
+    /**
+     * @inheritDoc
+     */
+    execute() {
+        const model = this.editor.model;
+        const schema = model.schema;
+        model.change(writer => {
+            for (const item of this._getFormattingItems(model.document.selection, schema)) {
+                if (item.is('selection')) {
+                    for (const attributeName of this._getFormattingAttributes(item, schema)) {
+                        writer.removeSelectionAttribute(attributeName);
+                    }
+                }
+                else {
+                    // Workaround for items with multiple removable attributes. See
+                    // https://github.com/ckeditor/ckeditor5-remove-format/pull/1#pullrequestreview-220515609
+                    const itemRange = writer.createRangeOn(item);
+                    for (const attributeName of this._getFormattingAttributes(item, schema)) {
+                        writer.removeAttribute(attributeName, itemRange);
+                    }
+                }
+            }
+        });
+    }
+    /**
+     * Returns an iterable of items in a selection (including the selection itself) that have formatting model
+     * attributes to be removed by the feature.
+     *
+     * @param schema The schema describing the item.
+     */
+    *_getFormattingItems(selection, schema) {
+        const itemHasRemovableFormatting = (item) => {
+            return !!first(this._getFormattingAttributes(item, schema));
+        };
+        // Check formatting on selected items that are not blocks.
+        for (const curRange of selection.getRanges()) {
+            for (const item of curRange.getItems()) {
+                if (!schema.isBlock(item) && itemHasRemovableFormatting(item)) {
+                    yield item;
+                }
+            }
+        }
+        // Check formatting from selected blocks.
+        for (const block of selection.getSelectedBlocks()) {
+            if (itemHasRemovableFormatting(block)) {
+                yield block;
+            }
+        }
+        // Finally the selection might be formatted as well, so make sure to check it.
+        if (itemHasRemovableFormatting(selection)) {
+            yield selection;
+        }
+    }
+    /**
+     * Returns an iterable of formatting attributes of a given model item.
+     *
+     * **Note:** Formatting items have the `isFormatting` property set to `true`.
+     *
+     * @param schema The schema describing the item.
+     * @returns The names of formatting attributes found in a given item.
+     */
+    *_getFormattingAttributes(item, schema) {
+        for (const [attributeName] of item.getAttributes()) {
+            const attributeProperties = schema.getAttributeProperties(attributeName);
+            if (attributeProperties && attributeProperties.isFormatting) {
+                yield attributeName;
+            }
+        }
+    }
 }

package/src/removeformatediting.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module remove-format/removeformatediting
+ */
+import { Plugin } from 'ckeditor5/src/core';
+/**
+ * The remove format editing plugin.
+ *
+ * It registers the {@link module:remove-format/removeformatcommand~RemoveFormatCommand removeFormat} command.
+ */
+export default class RemoveFormatEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'RemoveFormatEditing';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [RemoveFormatEditing.pluginName]: RemoveFormatEditing;
+    }
+}

package/src/removeformatediting.js

@@ -2,36 +2,28 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module remove-format/removeformatediting
  */
-
 import { Plugin } from 'ckeditor5/src/core';
-
 import RemoveFormatCommand from './removeformatcommand';
-
 /**
  * The remove format editing plugin.
  *
  * It registers the {@link module:remove-format/removeformatcommand~RemoveFormatCommand removeFormat} command.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class RemoveFormatEditing extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'RemoveFormatEditing';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const editor = this.editor;
-
-		editor.commands.add( 'removeFormat', new RemoveFormatCommand( editor ) );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'RemoveFormatEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        editor.commands.add('removeFormat', new RemoveFormatCommand(editor));
+    }
 }

package/src/removeformatui.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module remove-format/removeformatui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+/**
+ * The remove format UI plugin. It registers the `'removeFormat'` button which can be
+ * used in the toolbar.
+ */
+export default class RemoveFormatUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'RemoveFormatUI';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [RemoveFormatUI.pluginName]: RemoveFormatUI;
+    }
+}

package/src/removeformatui.js

@@ -2,58 +2,45 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module remove-format/removeformatui
  */
-
 import { Plugin } from 'ckeditor5/src/core';
 import { ButtonView } from 'ckeditor5/src/ui';
-
 import removeFormatIcon from '../theme/icons/remove-format.svg';
-
 const REMOVE_FORMAT = 'removeFormat';
-
 /**
  * The remove format UI plugin. It registers the `'removeFormat'` button which can be
  * used in the toolbar.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class RemoveFormatUI extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'RemoveFormatUI';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const editor = this.editor;
-		const t = editor.t;
-
-		editor.ui.componentFactory.add( REMOVE_FORMAT, locale => {
-			const command = editor.commands.get( REMOVE_FORMAT );
-			const view = new ButtonView( locale );
-
-			view.set( {
-				label: t( 'Remove Format' ),
-				icon: removeFormatIcon,
-				tooltip: true
-			} );
-
-			view.bind( 'isOn', 'isEnabled' ).to( command, 'value', 'isEnabled' );
-
-			// Execute the command.
-			this.listenTo( view, 'execute', () => {
-				editor.execute( REMOVE_FORMAT );
-				editor.editing.view.focus();
-			} );
-
-			return view;
-		} );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'RemoveFormatUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.t;
+        editor.ui.componentFactory.add(REMOVE_FORMAT, locale => {
+            const command = editor.commands.get(REMOVE_FORMAT);
+            const view = new ButtonView(locale);
+            view.set({
+                label: t('Remove Format'),
+                icon: removeFormatIcon,
+                tooltip: true
+            });
+            view.bind('isOn', 'isEnabled').to(command, 'value', 'isEnabled');
+            // Execute the command.
+            this.listenTo(view, 'execute', () => {
+                editor.execute(REMOVE_FORMAT);
+                editor.editing.view.focus();
+            });
+            return view;
+        });
+    }
 }