@ckeditor/ckeditor5-remove-format 39.0.1 → 40.0.0

package/src/augmentation.d.ts

@@ -1,15 +1,15 @@
-/**
- * @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 type { RemoveFormat, RemoveFormatEditing, RemoveFormatUI, RemoveFormatCommand } from './index';
-declare module '@ckeditor/ckeditor5-core' {
-    interface PluginsMap {
-        [RemoveFormat.pluginName]: RemoveFormat;
-        [RemoveFormatUI.pluginName]: RemoveFormatUI;
-        [RemoveFormatEditing.pluginName]: RemoveFormatEditing;
-    }
-    interface CommandsMap {
-        removeFormat: RemoveFormatCommand;
-    }
-}
+/**
+ * @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 type { RemoveFormat, RemoveFormatEditing, RemoveFormatUI, RemoveFormatCommand } from './index';
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [RemoveFormat.pluginName]: RemoveFormat;
+        [RemoveFormatUI.pluginName]: RemoveFormatUI;
+        [RemoveFormatEditing.pluginName]: RemoveFormatEditing;
+    }
+    interface CommandsMap {
+        removeFormat: RemoveFormatCommand;
+    }
+}

package/src/augmentation.js

@@ -1,5 +1,5 @@
-/**
- * @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
- */
-export {};
+/**
+ * @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
+ */
+export {};

package/src/index.d.ts

@@ -1,12 +1,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
- */
-export { default as RemoveFormat } from './removeformat';
-export { default as RemoveFormatEditing } from './removeformatediting';
-export { default as RemoveFormatUI } from './removeformatui';
-export type { default as RemoveFormatCommand } from './removeformatcommand';
-import './augmentation';
+/**
+ * @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';
+export type { default as RemoveFormatCommand } from './removeformatcommand';
+import './augmentation';

package/src/index.js

@@ -1,11 +1,11 @@
-/**
- * @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';
-import './augmentation';
+/**
+ * @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';
+import './augmentation';

package/src/removeformat.d.ts

@@ -1,28 +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/removeformat
- */
-import { Plugin } from 'ckeditor5/src/core';
-import RemoveFormatUI from './removeformatui';
-import RemoveFormatEditing from './removeformatediting';
-/**
- * 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(): readonly [typeof RemoveFormatEditing, typeof RemoveFormatUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "RemoveFormat";
-}
+/**
+ * @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.
+ *
+ * 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(): readonly [typeof RemoveFormatEditing, typeof RemoveFormatUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "RemoveFormat";
+}

package/src/removeformat.js

@@ -1,32 +1,32 @@
-/**
- * @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.
- *
- * 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() {
-        return [RemoveFormatEditing, RemoveFormatUI];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'RemoveFormat';
-    }
-}
+/**
+ * @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.
+ *
+ * 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() {
+        return [RemoveFormatEditing, RemoveFormatUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'RemoveFormat';
+    }
+}

package/src/removeformatcommand.d.ts

@@ -1,42 +1,42 @@
-/**
- * @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;
-}
+/**
+ * @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;
+}

package/src/removeformatcommand.js

@@ -1,94 +1,94 @@
-/**
- * @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';
-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.
- *
- * ```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.
-     *
-     * @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;
-            }
-        }
-    }
-}
+/**
+ * @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';
+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.
+ *
+ * ```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.
+     *
+     * @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

@@ -1,23 +1,23 @@
-/**
- * @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;
-}
+/**
+ * @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;
+}

package/src/removeformatediting.js

@@ -1,29 +1,29 @@
-/**
- * @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.
- */
-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));
-    }
-}
+/**
+ * @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.
+ */
+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));
+    }
+}

package/src/removeformatui.d.ts

@@ -1,22 +1,22 @@
-/**
- * @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;
-}
+/**
+ * @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;
+}