@ckeditor/ckeditor5-autoformat 40.0.0 → 40.2.0

package/src/autoformat.js

@@ -1,189 +1,189 @@
-/**
- * @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 { Plugin } from 'ckeditor5/src/core';
-import { Delete } from 'ckeditor5/src/typing';
-import blockAutoformatEditing from './blockautoformatediting';
-import inlineAutoformatEditing from './inlineautoformatediting';
-/**
- * Enables a set of predefined autoformatting actions.
- *
- * For a detailed overview, check the {@glink features/autoformat Autoformatting} feature guide
- * and the {@glink api/autoformat package page}.
- */
-export default class Autoformat extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [Delete];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'Autoformat';
-    }
-    /**
-     * @inheritDoc
-     */
-    afterInit() {
-        this._addListAutoformats();
-        this._addBasicStylesAutoformats();
-        this._addHeadingAutoformats();
-        this._addBlockQuoteAutoformats();
-        this._addCodeBlockAutoformats();
-        this._addHorizontalLineAutoformats();
-    }
-    /**
-     * Adds autoformatting related to the {@link module:list/list~List}.
-     *
-     * When typed:
-     * - `* ` or `- ` – A paragraph will be changed into a bulleted list.
-     * - `1. ` or `1) ` – A paragraph will be changed into a numbered list ("1" can be any digit or a list of digits).
-     * - `[] ` or `[ ] ` – A paragraph will be changed into a to-do list.
-     * - `[x] ` or `[ x ] ` – A paragraph will be changed into a checked to-do list.
-     */
-    _addListAutoformats() {
-        const commands = this.editor.commands;
-        if (commands.get('bulletedList')) {
-            blockAutoformatEditing(this.editor, this, /^[*-]\s$/, 'bulletedList');
-        }
-        if (commands.get('numberedList')) {
-            blockAutoformatEditing(this.editor, this, /^1[.|)]\s$/, 'numberedList');
-        }
-        if (commands.get('todoList')) {
-            blockAutoformatEditing(this.editor, this, /^\[\s?\]\s$/, 'todoList');
-        }
-        if (commands.get('checkTodoList')) {
-            blockAutoformatEditing(this.editor, this, /^\[\s?x\s?\]\s$/, () => {
-                this.editor.execute('todoList');
-                this.editor.execute('checkTodoList');
-            });
-        }
-    }
-    /**
-     * Adds autoformatting related to the {@link module:basic-styles/bold~Bold},
-     * {@link module:basic-styles/italic~Italic}, {@link module:basic-styles/code~Code}
-     * and {@link module:basic-styles/strikethrough~Strikethrough}
-     *
-     * When typed:
-     * - `**foobar**` – `**` characters are removed and `foobar` is set to bold,
-     * - `__foobar__` – `__` characters are removed and `foobar` is set to bold,
-     * - `*foobar*` – `*` characters are removed and `foobar` is set to italic,
-     * - `_foobar_` – `_` characters are removed and `foobar` is set to italic,
-     * - ``` `foobar` – ``` ` ``` characters are removed and `foobar` is set to code,
-     * - `~~foobar~~` – `~~` characters are removed and `foobar` is set to strikethrough.
-     */
-    _addBasicStylesAutoformats() {
-        const commands = this.editor.commands;
-        if (commands.get('bold')) {
-            const boldCallback = getCallbackFunctionForInlineAutoformat(this.editor, 'bold');
-            inlineAutoformatEditing(this.editor, this, /(?:^|\s)(\*\*)([^*]+)(\*\*)$/g, boldCallback);
-            inlineAutoformatEditing(this.editor, this, /(?:^|\s)(__)([^_]+)(__)$/g, boldCallback);
-        }
-        if (commands.get('italic')) {
-            const italicCallback = getCallbackFunctionForInlineAutoformat(this.editor, 'italic');
-            // The italic autoformatter cannot be triggered by the bold markers, so we need to check the
-            // text before the pattern (e.g. `(?:^|[^\*])`).
-            inlineAutoformatEditing(this.editor, this, /(?:^|\s)(\*)([^*_]+)(\*)$/g, italicCallback);
-            inlineAutoformatEditing(this.editor, this, /(?:^|\s)(_)([^_]+)(_)$/g, italicCallback);
-        }
-        if (commands.get('code')) {
-            const codeCallback = getCallbackFunctionForInlineAutoformat(this.editor, 'code');
-            inlineAutoformatEditing(this.editor, this, /(`)([^`]+)(`)$/g, codeCallback);
-        }
-        if (commands.get('strikethrough')) {
-            const strikethroughCallback = getCallbackFunctionForInlineAutoformat(this.editor, 'strikethrough');
-            inlineAutoformatEditing(this.editor, this, /(~~)([^~]+)(~~)$/g, strikethroughCallback);
-        }
-    }
-    /**
-     * Adds autoformatting related to {@link module:heading/heading~Heading}.
-     *
-     * It is using a number at the end of the command name to associate it with the proper trigger:
-     *
-     * * `heading` with a `heading1` value will be executed when typing `#`,
-     * * `heading` with a `heading2` value will be executed when typing `##`,
-     * * ... up to `heading6` for `######`.
-     */
-    _addHeadingAutoformats() {
-        const command = this.editor.commands.get('heading');
-        if (command) {
-            command.modelElements
-                .filter(name => name.match(/^heading[1-6]$/))
-                .forEach(modelName => {
-                const level = modelName[7];
-                const pattern = new RegExp(`^(#{${level}})\\s$`);
-                blockAutoformatEditing(this.editor, this, pattern, () => {
-                    // Should only be active if command is enabled and heading style associated with pattern is inactive.
-                    if (!command.isEnabled || command.value === modelName) {
-                        return false;
-                    }
-                    this.editor.execute('heading', { value: modelName });
-                });
-            });
-        }
-    }
-    /**
-     * Adds autoformatting related to {@link module:block-quote/blockquote~BlockQuote}.
-     *
-     * When typed:
-     * * `> ` – A paragraph will be changed to a block quote.
-     */
-    _addBlockQuoteAutoformats() {
-        if (this.editor.commands.get('blockQuote')) {
-            blockAutoformatEditing(this.editor, this, /^>\s$/, 'blockQuote');
-        }
-    }
-    /**
-     * Adds autoformatting related to {@link module:code-block/codeblock~CodeBlock}.
-     *
-     * When typed:
-     * - `` ``` `` – A paragraph will be changed to a code block.
-     */
-    _addCodeBlockAutoformats() {
-        const editor = this.editor;
-        const selection = editor.model.document.selection;
-        if (editor.commands.get('codeBlock')) {
-            blockAutoformatEditing(editor, this, /^```$/, () => {
-                if (selection.getFirstPosition().parent.is('element', 'listItem')) {
-                    return false;
-                }
-                this.editor.execute('codeBlock', {
-                    usePreviousLanguageChoice: true
-                });
-            });
-        }
-    }
-    /**
-     * Adds autoformatting related to {@link module:horizontal-line/horizontalline~HorizontalLine}.
-     *
-     * When typed:
-     * - `` --- `` – Will be replaced with a horizontal line.
-     */
-    _addHorizontalLineAutoformats() {
-        if (this.editor.commands.get('horizontalLine')) {
-            blockAutoformatEditing(this.editor, this, /^---$/, 'horizontalLine');
-        }
-    }
-}
-/**
- * Helper function for getting `inlineAutoformatEditing` callbacks that checks if command is enabled.
- */
-function getCallbackFunctionForInlineAutoformat(editor, attributeKey) {
-    return (writer, rangesToFormat) => {
-        const command = editor.commands.get(attributeKey);
-        if (!command.isEnabled) {
-            return false;
-        }
-        const validRanges = editor.model.schema.getValidRanges(rangesToFormat, attributeKey);
-        for (const range of validRanges) {
-            writer.setAttribute(attributeKey, true, range);
-        }
-        // After applying attribute to the text, remove given attribute from the selection.
-        // This way user is able to type a text without attribute used by auto formatter.
-        writer.removeSelectionAttribute(attributeKey);
-    };
-}
+/**
+ * @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 { Plugin } from 'ckeditor5/src/core';
+import { Delete } from 'ckeditor5/src/typing';
+import blockAutoformatEditing from './blockautoformatediting';
+import inlineAutoformatEditing from './inlineautoformatediting';
+/**
+ * Enables a set of predefined autoformatting actions.
+ *
+ * For a detailed overview, check the {@glink features/autoformat Autoformatting} feature guide
+ * and the {@glink api/autoformat package page}.
+ */
+export default class Autoformat extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [Delete];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Autoformat';
+    }
+    /**
+     * @inheritDoc
+     */
+    afterInit() {
+        this._addListAutoformats();
+        this._addBasicStylesAutoformats();
+        this._addHeadingAutoformats();
+        this._addBlockQuoteAutoformats();
+        this._addCodeBlockAutoformats();
+        this._addHorizontalLineAutoformats();
+    }
+    /**
+     * Adds autoformatting related to the {@link module:list/list~List}.
+     *
+     * When typed:
+     * - `* ` or `- ` – A paragraph will be changed into a bulleted list.
+     * - `1. ` or `1) ` – A paragraph will be changed into a numbered list ("1" can be any digit or a list of digits).
+     * - `[] ` or `[ ] ` – A paragraph will be changed into a to-do list.
+     * - `[x] ` or `[ x ] ` – A paragraph will be changed into a checked to-do list.
+     */
+    _addListAutoformats() {
+        const commands = this.editor.commands;
+        if (commands.get('bulletedList')) {
+            blockAutoformatEditing(this.editor, this, /^[*-]\s$/, 'bulletedList');
+        }
+        if (commands.get('numberedList')) {
+            blockAutoformatEditing(this.editor, this, /^1[.|)]\s$/, 'numberedList');
+        }
+        if (commands.get('todoList')) {
+            blockAutoformatEditing(this.editor, this, /^\[\s?\]\s$/, 'todoList');
+        }
+        if (commands.get('checkTodoList')) {
+            blockAutoformatEditing(this.editor, this, /^\[\s?x\s?\]\s$/, () => {
+                this.editor.execute('todoList');
+                this.editor.execute('checkTodoList');
+            });
+        }
+    }
+    /**
+     * Adds autoformatting related to the {@link module:basic-styles/bold~Bold},
+     * {@link module:basic-styles/italic~Italic}, {@link module:basic-styles/code~Code}
+     * and {@link module:basic-styles/strikethrough~Strikethrough}
+     *
+     * When typed:
+     * - `**foobar**` – `**` characters are removed and `foobar` is set to bold,
+     * - `__foobar__` – `__` characters are removed and `foobar` is set to bold,
+     * - `*foobar*` – `*` characters are removed and `foobar` is set to italic,
+     * - `_foobar_` – `_` characters are removed and `foobar` is set to italic,
+     * - ``` `foobar` – ``` ` ``` characters are removed and `foobar` is set to code,
+     * - `~~foobar~~` – `~~` characters are removed and `foobar` is set to strikethrough.
+     */
+    _addBasicStylesAutoformats() {
+        const commands = this.editor.commands;
+        if (commands.get('bold')) {
+            const boldCallback = getCallbackFunctionForInlineAutoformat(this.editor, 'bold');
+            inlineAutoformatEditing(this.editor, this, /(?:^|\s)(\*\*)([^*]+)(\*\*)$/g, boldCallback);
+            inlineAutoformatEditing(this.editor, this, /(?:^|\s)(__)([^_]+)(__)$/g, boldCallback);
+        }
+        if (commands.get('italic')) {
+            const italicCallback = getCallbackFunctionForInlineAutoformat(this.editor, 'italic');
+            // The italic autoformatter cannot be triggered by the bold markers, so we need to check the
+            // text before the pattern (e.g. `(?:^|[^\*])`).
+            inlineAutoformatEditing(this.editor, this, /(?:^|\s)(\*)([^*_]+)(\*)$/g, italicCallback);
+            inlineAutoformatEditing(this.editor, this, /(?:^|\s)(_)([^_]+)(_)$/g, italicCallback);
+        }
+        if (commands.get('code')) {
+            const codeCallback = getCallbackFunctionForInlineAutoformat(this.editor, 'code');
+            inlineAutoformatEditing(this.editor, this, /(`)([^`]+)(`)$/g, codeCallback);
+        }
+        if (commands.get('strikethrough')) {
+            const strikethroughCallback = getCallbackFunctionForInlineAutoformat(this.editor, 'strikethrough');
+            inlineAutoformatEditing(this.editor, this, /(~~)([^~]+)(~~)$/g, strikethroughCallback);
+        }
+    }
+    /**
+     * Adds autoformatting related to {@link module:heading/heading~Heading}.
+     *
+     * It is using a number at the end of the command name to associate it with the proper trigger:
+     *
+     * * `heading` with a `heading1` value will be executed when typing `#`,
+     * * `heading` with a `heading2` value will be executed when typing `##`,
+     * * ... up to `heading6` for `######`.
+     */
+    _addHeadingAutoformats() {
+        const command = this.editor.commands.get('heading');
+        if (command) {
+            command.modelElements
+                .filter(name => name.match(/^heading[1-6]$/))
+                .forEach(modelName => {
+                const level = modelName[7];
+                const pattern = new RegExp(`^(#{${level}})\\s$`);
+                blockAutoformatEditing(this.editor, this, pattern, () => {
+                    // Should only be active if command is enabled and heading style associated with pattern is inactive.
+                    if (!command.isEnabled || command.value === modelName) {
+                        return false;
+                    }
+                    this.editor.execute('heading', { value: modelName });
+                });
+            });
+        }
+    }
+    /**
+     * Adds autoformatting related to {@link module:block-quote/blockquote~BlockQuote}.
+     *
+     * When typed:
+     * * `> ` – A paragraph will be changed to a block quote.
+     */
+    _addBlockQuoteAutoformats() {
+        if (this.editor.commands.get('blockQuote')) {
+            blockAutoformatEditing(this.editor, this, /^>\s$/, 'blockQuote');
+        }
+    }
+    /**
+     * Adds autoformatting related to {@link module:code-block/codeblock~CodeBlock}.
+     *
+     * When typed:
+     * - `` ``` `` – A paragraph will be changed to a code block.
+     */
+    _addCodeBlockAutoformats() {
+        const editor = this.editor;
+        const selection = editor.model.document.selection;
+        if (editor.commands.get('codeBlock')) {
+            blockAutoformatEditing(editor, this, /^```$/, () => {
+                if (selection.getFirstPosition().parent.is('element', 'listItem')) {
+                    return false;
+                }
+                this.editor.execute('codeBlock', {
+                    usePreviousLanguageChoice: true
+                });
+            });
+        }
+    }
+    /**
+     * Adds autoformatting related to {@link module:horizontal-line/horizontalline~HorizontalLine}.
+     *
+     * When typed:
+     * - `` --- `` – Will be replaced with a horizontal line.
+     */
+    _addHorizontalLineAutoformats() {
+        if (this.editor.commands.get('horizontalLine')) {
+            blockAutoformatEditing(this.editor, this, /^---$/, 'horizontalLine');
+        }
+    }
+}
+/**
+ * Helper function for getting `inlineAutoformatEditing` callbacks that checks if command is enabled.
+ */
+function getCallbackFunctionForInlineAutoformat(editor, attributeKey) {
+    return (writer, rangesToFormat) => {
+        const command = editor.commands.get(attributeKey);
+        if (!command.isEnabled) {
+            return false;
+        }
+        const validRanges = editor.model.schema.getValidRanges(rangesToFormat, attributeKey);
+        for (const range of validRanges) {
+            writer.setAttribute(attributeKey, true, range);
+        }
+        // After applying attribute to the text, remove given attribute from the selection.
+        // This way user is able to type a text without attribute used by auto formatter.
+        writer.removeSelectionAttribute(attributeKey);
+    };
+}

package/src/blockautoformatediting.d.ts

@@ -1,57 +1,57 @@
-/**
- * @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 { Editor } from 'ckeditor5/src/core';
-import type Autoformat from './autoformat';
-/**
- * The block autoformatting engine. It allows to format various block patterns. For example,
- * it can be configured to turn a paragraph starting with `*` and followed by a space into a list item.
- *
- * The autoformatting operation is integrated with the undo manager,
- * so the autoformatting step can be undone if the user's intention was not to format the text.
- *
- * See the {@link module:autoformat/blockautoformatediting~blockAutoformatEditing `blockAutoformatEditing`} documentation
- * to learn how to create custom block autoformatters. You can also use
- * the {@link module:autoformat/autoformat~Autoformat} feature which enables a set of default autoformatters
- * (lists, headings, bold and italic).
- *
- * @module autoformat/blockautoformatediting
- */
-/**
- * Creates a listener triggered on {@link module:engine/model/document~Document#event:change:data `change:data`} event in the document.
- * Calls the callback when inserted text matches the regular expression or the command name
- * if provided instead of the callback.
- *
- * Examples of usage:
- *
- * To convert a paragraph into heading 1 when `- ` is typed, using just the command name:
- *
- * ```ts
- * blockAutoformatEditing( editor, plugin, /^\- $/, 'heading1' );
- * ```
- *
- * To convert a paragraph into heading 1 when `- ` is typed, using just the callback:
- *
- * ```ts
- * blockAutoformatEditing( editor, plugin, /^\- $/, ( context ) => {
- * 	const { match } = context;
- * 	const headingLevel = match[ 1 ].length;
- *
- * 	editor.execute( 'heading', {
- * 		formatId: `heading${ headingLevel }`
- * 	} );
- * } );
- * ```
- *
- * @param editor The editor instance.
- * @param plugin The autoformat plugin instance.
- * @param pattern The regular expression to execute on just inserted text. The regular expression is tested against the text
- * from the beginning until the caret position.
- * @param callbackOrCommand The callback to execute or the command to run when the text is matched.
- * In case of providing the callback, it receives the following parameter:
- * * match RegExp.exec() result of matching the pattern to inserted text.
- */
-export default function blockAutoformatEditing(editor: Editor, plugin: Autoformat, pattern: RegExp, callbackOrCommand: string | ((context: {
-    match: RegExpExecArray;
-}) => unknown)): 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
+ */
+import type { Editor } from 'ckeditor5/src/core';
+import type Autoformat from './autoformat';
+/**
+ * The block autoformatting engine. It allows to format various block patterns. For example,
+ * it can be configured to turn a paragraph starting with `*` and followed by a space into a list item.
+ *
+ * The autoformatting operation is integrated with the undo manager,
+ * so the autoformatting step can be undone if the user's intention was not to format the text.
+ *
+ * See the {@link module:autoformat/blockautoformatediting~blockAutoformatEditing `blockAutoformatEditing`} documentation
+ * to learn how to create custom block autoformatters. You can also use
+ * the {@link module:autoformat/autoformat~Autoformat} feature which enables a set of default autoformatters
+ * (lists, headings, bold and italic).
+ *
+ * @module autoformat/blockautoformatediting
+ */
+/**
+ * Creates a listener triggered on {@link module:engine/model/document~Document#event:change:data `change:data`} event in the document.
+ * Calls the callback when inserted text matches the regular expression or the command name
+ * if provided instead of the callback.
+ *
+ * Examples of usage:
+ *
+ * To convert a paragraph into heading 1 when `- ` is typed, using just the command name:
+ *
+ * ```ts
+ * blockAutoformatEditing( editor, plugin, /^\- $/, 'heading1' );
+ * ```
+ *
+ * To convert a paragraph into heading 1 when `- ` is typed, using just the callback:
+ *
+ * ```ts
+ * blockAutoformatEditing( editor, plugin, /^\- $/, ( context ) => {
+ * 	const { match } = context;
+ * 	const headingLevel = match[ 1 ].length;
+ *
+ * 	editor.execute( 'heading', {
+ * 		formatId: `heading${ headingLevel }`
+ * 	} );
+ * } );
+ * ```
+ *
+ * @param editor The editor instance.
+ * @param plugin The autoformat plugin instance.
+ * @param pattern The regular expression to execute on just inserted text. The regular expression is tested against the text
+ * from the beginning until the caret position.
+ * @param callbackOrCommand The callback to execute or the command to run when the text is matched.
+ * In case of providing the callback, it receives the following parameter:
+ * * match RegExp.exec() result of matching the pattern to inserted text.
+ */
+export default function blockAutoformatEditing(editor: Editor, plugin: Autoformat, pattern: RegExp, callbackOrCommand: string | ((context: {
+    match: RegExpExecArray;
+}) => unknown)): void;