@ckeditor/ckeditor5-code-block 38.1.0 → 38.1.1

package/src/indentcodeblockcommand.js

@@ -1,78 +1,78 @@
-/**
- * @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 code-block/indentcodeblockcommand
- */
-import { Command } from 'ckeditor5/src/core';
-import { getIndentOutdentPositions, isModelSelectionInCodeBlock } from './utils';
-/**
- * The code block indentation increase command plugin.
- */
-export default class IndentCodeBlockCommand extends Command {
-    constructor(editor) {
-        super(editor);
-        this._indentSequence = editor.config.get('codeBlock.indentSequence');
-    }
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        this.isEnabled = this._checkEnabled();
-    }
-    /**
-     * Executes the command. When the command {@link #isEnabled is enabled}, the indentation of the
-     * code lines in the selection will be increased.
-     *
-     * @fires execute
-     */
-    execute() {
-        const editor = this.editor;
-        const model = editor.model;
-        model.change(writer => {
-            const positions = getIndentOutdentPositions(model);
-            // Indent all positions, for instance assuming the indent sequence is 4x space ("    "):
-            //
-            //		<codeBlock>^foo</codeBlock>        ->       <codeBlock>    foo</codeBlock>
-            //
-            //		<codeBlock>foo^bar</codeBlock>     ->       <codeBlock>foo    bar</codeBlock>
-            //
-            // Also, when there is more than one position:
-            //
-            //		<codeBlock>
-            //			^foobar
-            //			<softBreak></softBreak>
-            //			^bazqux
-            //		</codeBlock>
-            //
-            //		->
-            //
-            //		<codeBlock>
-            //			    foobar
-            //			<softBreak></softBreak>
-            //			    bazqux
-            //		</codeBlock>
-            //
-            for (const position of positions) {
-                const indentSequenceTextElement = writer.createText(this._indentSequence);
-                // Previously insertion was done by writer.insertText(). It was changed to insertContent() to enable
-                // integration of code block with track changes. It's the easiest way of integration because insertContent()
-                // is already integrated with track changes, but if it ever cause any troubles it can be reverted, however
-                // some additional work will be required in track changes integration of code block.
-                model.insertContent(indentSequenceTextElement, position);
-            }
-        });
-    }
-    /**
-     * Checks whether the command can be enabled in the current context.
-     */
-    _checkEnabled() {
-        if (!this._indentSequence) {
-            return false;
-        }
-        // Indent (forward) command is always enabled when there's any code block in the selection
-        // because you can always indent code lines.
-        return isModelSelectionInCodeBlock(this.editor.model.document.selection);
-    }
-}
+/**
+ * @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 code-block/indentcodeblockcommand
+ */
+import { Command } from 'ckeditor5/src/core';
+import { getIndentOutdentPositions, isModelSelectionInCodeBlock } from './utils';
+/**
+ * The code block indentation increase command plugin.
+ */
+export default class IndentCodeBlockCommand extends Command {
+    constructor(editor) {
+        super(editor);
+        this._indentSequence = editor.config.get('codeBlock.indentSequence');
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        this.isEnabled = this._checkEnabled();
+    }
+    /**
+     * Executes the command. When the command {@link #isEnabled is enabled}, the indentation of the
+     * code lines in the selection will be increased.
+     *
+     * @fires execute
+     */
+    execute() {
+        const editor = this.editor;
+        const model = editor.model;
+        model.change(writer => {
+            const positions = getIndentOutdentPositions(model);
+            // Indent all positions, for instance assuming the indent sequence is 4x space ("    "):
+            //
+            //		<codeBlock>^foo</codeBlock>        ->       <codeBlock>    foo</codeBlock>
+            //
+            //		<codeBlock>foo^bar</codeBlock>     ->       <codeBlock>foo    bar</codeBlock>
+            //
+            // Also, when there is more than one position:
+            //
+            //		<codeBlock>
+            //			^foobar
+            //			<softBreak></softBreak>
+            //			^bazqux
+            //		</codeBlock>
+            //
+            //		->
+            //
+            //		<codeBlock>
+            //			    foobar
+            //			<softBreak></softBreak>
+            //			    bazqux
+            //		</codeBlock>
+            //
+            for (const position of positions) {
+                const indentSequenceTextElement = writer.createText(this._indentSequence);
+                // Previously insertion was done by writer.insertText(). It was changed to insertContent() to enable
+                // integration of code block with track changes. It's the easiest way of integration because insertContent()
+                // is already integrated with track changes, but if it ever cause any troubles it can be reverted, however
+                // some additional work will be required in track changes integration of code block.
+                model.insertContent(indentSequenceTextElement, position);
+            }
+        });
+    }
+    /**
+     * Checks whether the command can be enabled in the current context.
+     */
+    _checkEnabled() {
+        if (!this._indentSequence) {
+            return false;
+        }
+        // Indent (forward) command is always enabled when there's any code block in the selection
+        // because you can always indent code lines.
+        return isModelSelectionInCodeBlock(this.editor.model.document.selection);
+    }
+}

package/src/index.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
- */
-/**
- * @module code-block
- */
-export { default as CodeBlock } from './codeblock';
-export { default as CodeBlockEditing } from './codeblockediting';
-export { default as CodeBlockUI } from './codeblockui';
-export type { default as CodeBlockCommand } from './codeblockcommand';
-export type { default as IndentCodeBlockCommand } from './indentcodeblockcommand';
-export type { default as OutdentCodeBlockCommand } from './outdentcodeblockcommand';
-export type { CodeBlockConfig } from './codeblockconfig';
-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 code-block
+ */
+export { default as CodeBlock } from './codeblock';
+export { default as CodeBlockEditing } from './codeblockediting';
+export { default as CodeBlockUI } from './codeblockui';
+export type { default as CodeBlockCommand } from './codeblockcommand';
+export type { default as IndentCodeBlockCommand } from './indentcodeblockcommand';
+export type { default as OutdentCodeBlockCommand } from './outdentcodeblockcommand';
+export type { CodeBlockConfig } from './codeblockconfig';
+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 code-block
- */
-export { default as CodeBlock } from './codeblock';
-export { default as CodeBlockEditing } from './codeblockediting';
-export { default as CodeBlockUI } from './codeblockui';
-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 code-block
+ */
+export { default as CodeBlock } from './codeblock';
+export { default as CodeBlockEditing } from './codeblockediting';
+export { default as CodeBlockUI } from './codeblockui';
+import './augmentation';

package/src/outdentcodeblockcommand.d.ts

@@ -1,33 +1,33 @@
-/**
- * @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, type Editor } from 'ckeditor5/src/core';
-/**
- * The code block indentation decrease command plugin.
- */
-export default class OutdentCodeBlockCommand extends Command {
-    /**
-     * A sequence of characters removed from the line when the command is executed.
-     */
-    private readonly _indentSequence;
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command. When the command {@link #isEnabled is enabled}, the indentation of the
-     * code lines in the selection will be decreased.
-     *
-     * @fires execute
-     */
-    execute(): void;
-    /**
-     * Checks whether the command can be enabled in the current context.
-     *
-     * @private
-     * @returns {Boolean} Whether the command should be enabled.
-     */
-    private _checkEnabled;
-}
+/**
+ * @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, type Editor } from 'ckeditor5/src/core';
+/**
+ * The code block indentation decrease command plugin.
+ */
+export default class OutdentCodeBlockCommand extends Command {
+    /**
+     * A sequence of characters removed from the line when the command is executed.
+     */
+    private readonly _indentSequence;
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command. When the command {@link #isEnabled is enabled}, the indentation of the
+     * code lines in the selection will be decreased.
+     *
+     * @fires execute
+     */
+    execute(): void;
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @private
+     * @returns {Boolean} Whether the command should be enabled.
+     */
+    private _checkEnabled;
+}

package/src/outdentcodeblockcommand.js

@@ -1,148 +1,148 @@
-/**
- * @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 { getLeadingWhiteSpaces, getIndentOutdentPositions, isModelSelectionInCodeBlock } from './utils';
-/**
- * The code block indentation decrease command plugin.
- */
-export default class OutdentCodeBlockCommand extends Command {
-    constructor(editor) {
-        super(editor);
-        this._indentSequence = editor.config.get('codeBlock.indentSequence');
-    }
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        this.isEnabled = this._checkEnabled();
-    }
-    /**
-     * Executes the command. When the command {@link #isEnabled is enabled}, the indentation of the
-     * code lines in the selection will be decreased.
-     *
-     * @fires execute
-     */
-    execute() {
-        const editor = this.editor;
-        const model = editor.model;
-        model.change(() => {
-            const positions = getIndentOutdentPositions(model);
-            // Outdent all positions, for instance assuming the indent sequence is 4x space ("    "):
-            //
-            //		<codeBlock>^foo</codeBlock>         ->       <codeBlock>foo</codeBlock>
-            //
-            //		<codeBlock>    ^bar</codeBlock>     ->       <codeBlock>bar</codeBlock>
-            //
-            // Also, when there is more than one position:
-            //
-            //		<codeBlock>
-            //			    ^foobar
-            //			<softBreak></softBreak>
-            //			    ^bazqux
-            //		</codeBlock>
-            //
-            //		->
-            //
-            //		<codeBlock>
-            //			foobar
-            //			<softBreak></softBreak>
-            //			bazqux
-            //		</codeBlock>
-            for (const position of positions) {
-                const range = getLastOutdentableSequenceRange(model, position, this._indentSequence);
-                if (range) {
-                    // Previously deletion was done by writer.remove(). It was changed to deleteContent() to enable
-                    // integration of code block with track changes. It's the easiest way of integration because deleteContent()
-                    // is already integrated with track changes, but if it ever cause any troubles it can be reverted, however
-                    // some additional work will be required in track changes integration of code block.
-                    model.deleteContent(model.createSelection(range));
-                }
-            }
-        });
-    }
-    /**
-     * Checks whether the command can be enabled in the current context.
-     *
-     * @private
-     * @returns {Boolean} Whether the command should be enabled.
-     */
-    _checkEnabled() {
-        if (!this._indentSequence) {
-            return false;
-        }
-        const model = this.editor.model;
-        if (!isModelSelectionInCodeBlock(model.document.selection)) {
-            return false;
-        }
-        // Outdent command can execute only when there is an indent character sequence
-        // in some of the lines.
-        return getIndentOutdentPositions(model).some(position => {
-            return getLastOutdentableSequenceRange(model, position, this._indentSequence);
-        });
-    }
-}
-// For a position coming from `getIndentOutdentPositions()`, it returns the range representing
-// the last occurrence of the indent sequence among the leading whitespaces of the code line the
-// position represents.
-//
-// For instance, assuming the indent sequence is 4x space ("    "):
-//
-//		<codeBlock>foo^</codeBlock>                                 ->          null
-//		<codeBlock>foo^<softBreak></softBreak>bar</codeBlock>       ->          null
-//		<codeBlock>  ^foo</codeBlock>                               ->          null
-//		<codeBlock>        ^foo</codeBlock>                         ->          <codeBlock>    [    ]foo</codeBlock>
-//		<codeBlock>    ^foo    bar</codeBlock>                      ->          <codeBlock>[    ]foo    bar</codeBlock>
-//
-// @param {<module:engine/model/model~Model>} model
-// @param {<module:engine/model/position~Position>} position
-// @param {String} sequence
-// @returns {<module:engine/model/range~Range>|null}
-function getLastOutdentableSequenceRange(model, position, sequence) {
-    // Positions start before each text node (code line). Get the node corresponding to the position.
-    const nodeAtPosition = getCodeLineTextNodeAtPosition(position);
-    if (!nodeAtPosition) {
-        return null;
-    }
-    const leadingWhiteSpaces = getLeadingWhiteSpaces(nodeAtPosition);
-    const lastIndexOfSequence = leadingWhiteSpaces.lastIndexOf(sequence);
-    // For instance, assuming the indent sequence is 4x space ("    "):
-    //
-    //		<codeBlock>    	^foo</codeBlock>           ->             null
-    //
-    if (lastIndexOfSequence + sequence.length !== leadingWhiteSpaces.length) {
-        return null;
-    }
-    // For instance, assuming the indent sequence is 4x space ("    "):
-    //
-    //		<codeBlock>  ^foo</codeBlock>           ->             null
-    //
-    if (lastIndexOfSequence === -1) {
-        return null;
-    }
-    const { parent, startOffset } = nodeAtPosition;
-    // Create a range that contains the **last** indent sequence among the leading whitespaces
-    // of the line.
-    //
-    // For instance, assuming the indent sequence is 4x space ("    "):
-    //
-    //		<codeBlock>        ^foo</codeBlock>      ->     <codeBlock>    [    ]foo</codeBlock>
-    //
-    return model.createRange(model.createPositionAt(parent, startOffset + lastIndexOfSequence), model.createPositionAt(parent, startOffset + lastIndexOfSequence + sequence.length));
-}
-function getCodeLineTextNodeAtPosition(position) {
-    // Positions start before each text node (code line). Get the node corresponding to the position.
-    let nodeAtPosition = position.parent.getChild(position.index);
-    // <codeBlock>foo^</codeBlock>
-    // <codeBlock>foo^<softBreak></softBreak>bar</codeBlock>
-    if (!nodeAtPosition || nodeAtPosition.is('element', 'softBreak')) {
-        nodeAtPosition = position.nodeBefore;
-    }
-    // <codeBlock>^</codeBlock>
-    // <codeBlock>foo^<softBreak></softBreak>bar</codeBlock>
-    if (!nodeAtPosition || nodeAtPosition.is('element', 'softBreak')) {
-        return null;
-    }
-    return nodeAtPosition;
-}
+/**
+ * @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 { getLeadingWhiteSpaces, getIndentOutdentPositions, isModelSelectionInCodeBlock } from './utils';
+/**
+ * The code block indentation decrease command plugin.
+ */
+export default class OutdentCodeBlockCommand extends Command {
+    constructor(editor) {
+        super(editor);
+        this._indentSequence = editor.config.get('codeBlock.indentSequence');
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        this.isEnabled = this._checkEnabled();
+    }
+    /**
+     * Executes the command. When the command {@link #isEnabled is enabled}, the indentation of the
+     * code lines in the selection will be decreased.
+     *
+     * @fires execute
+     */
+    execute() {
+        const editor = this.editor;
+        const model = editor.model;
+        model.change(() => {
+            const positions = getIndentOutdentPositions(model);
+            // Outdent all positions, for instance assuming the indent sequence is 4x space ("    "):
+            //
+            //		<codeBlock>^foo</codeBlock>         ->       <codeBlock>foo</codeBlock>
+            //
+            //		<codeBlock>    ^bar</codeBlock>     ->       <codeBlock>bar</codeBlock>
+            //
+            // Also, when there is more than one position:
+            //
+            //		<codeBlock>
+            //			    ^foobar
+            //			<softBreak></softBreak>
+            //			    ^bazqux
+            //		</codeBlock>
+            //
+            //		->
+            //
+            //		<codeBlock>
+            //			foobar
+            //			<softBreak></softBreak>
+            //			bazqux
+            //		</codeBlock>
+            for (const position of positions) {
+                const range = getLastOutdentableSequenceRange(model, position, this._indentSequence);
+                if (range) {
+                    // Previously deletion was done by writer.remove(). It was changed to deleteContent() to enable
+                    // integration of code block with track changes. It's the easiest way of integration because deleteContent()
+                    // is already integrated with track changes, but if it ever cause any troubles it can be reverted, however
+                    // some additional work will be required in track changes integration of code block.
+                    model.deleteContent(model.createSelection(range));
+                }
+            }
+        });
+    }
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @private
+     * @returns {Boolean} Whether the command should be enabled.
+     */
+    _checkEnabled() {
+        if (!this._indentSequence) {
+            return false;
+        }
+        const model = this.editor.model;
+        if (!isModelSelectionInCodeBlock(model.document.selection)) {
+            return false;
+        }
+        // Outdent command can execute only when there is an indent character sequence
+        // in some of the lines.
+        return getIndentOutdentPositions(model).some(position => {
+            return getLastOutdentableSequenceRange(model, position, this._indentSequence);
+        });
+    }
+}
+// For a position coming from `getIndentOutdentPositions()`, it returns the range representing
+// the last occurrence of the indent sequence among the leading whitespaces of the code line the
+// position represents.
+//
+// For instance, assuming the indent sequence is 4x space ("    "):
+//
+//		<codeBlock>foo^</codeBlock>                                 ->          null
+//		<codeBlock>foo^<softBreak></softBreak>bar</codeBlock>       ->          null
+//		<codeBlock>  ^foo</codeBlock>                               ->          null
+//		<codeBlock>        ^foo</codeBlock>                         ->          <codeBlock>    [    ]foo</codeBlock>
+//		<codeBlock>    ^foo    bar</codeBlock>                      ->          <codeBlock>[    ]foo    bar</codeBlock>
+//
+// @param {<module:engine/model/model~Model>} model
+// @param {<module:engine/model/position~Position>} position
+// @param {String} sequence
+// @returns {<module:engine/model/range~Range>|null}
+function getLastOutdentableSequenceRange(model, position, sequence) {
+    // Positions start before each text node (code line). Get the node corresponding to the position.
+    const nodeAtPosition = getCodeLineTextNodeAtPosition(position);
+    if (!nodeAtPosition) {
+        return null;
+    }
+    const leadingWhiteSpaces = getLeadingWhiteSpaces(nodeAtPosition);
+    const lastIndexOfSequence = leadingWhiteSpaces.lastIndexOf(sequence);
+    // For instance, assuming the indent sequence is 4x space ("    "):
+    //
+    //		<codeBlock>    	^foo</codeBlock>           ->             null
+    //
+    if (lastIndexOfSequence + sequence.length !== leadingWhiteSpaces.length) {
+        return null;
+    }
+    // For instance, assuming the indent sequence is 4x space ("    "):
+    //
+    //		<codeBlock>  ^foo</codeBlock>           ->             null
+    //
+    if (lastIndexOfSequence === -1) {
+        return null;
+    }
+    const { parent, startOffset } = nodeAtPosition;
+    // Create a range that contains the **last** indent sequence among the leading whitespaces
+    // of the line.
+    //
+    // For instance, assuming the indent sequence is 4x space ("    "):
+    //
+    //		<codeBlock>        ^foo</codeBlock>      ->     <codeBlock>    [    ]foo</codeBlock>
+    //
+    return model.createRange(model.createPositionAt(parent, startOffset + lastIndexOfSequence), model.createPositionAt(parent, startOffset + lastIndexOfSequence + sequence.length));
+}
+function getCodeLineTextNodeAtPosition(position) {
+    // Positions start before each text node (code line). Get the node corresponding to the position.
+    let nodeAtPosition = position.parent.getChild(position.index);
+    // <codeBlock>foo^</codeBlock>
+    // <codeBlock>foo^<softBreak></softBreak>bar</codeBlock>
+    if (!nodeAtPosition || nodeAtPosition.is('element', 'softBreak')) {
+        nodeAtPosition = position.nodeBefore;
+    }
+    // <codeBlock>^</codeBlock>
+    // <codeBlock>foo^<softBreak></softBreak>bar</codeBlock>
+    if (!nodeAtPosition || nodeAtPosition.is('element', 'softBreak')) {
+        return null;
+    }
+    return nodeAtPosition;
+}