@ckeditor/ckeditor5-code-block 0.0.0-nightly-20240509.0 → 0.0.0-nightly-20240510.0

package/dist/index.js

@@ -224,26 +224,37 @@ import { createDropdown, SplitButtonView, addListToDropdown, MenuBarMenuView, Me
     return t('Leaving code snippet');
 }
 
-class CodeBlockCommand extends Command {
+/**
+ * The code block command plugin.
+ */ class CodeBlockCommand extends Command {
+    /**
+	 * Contains the last used language.
+	 */ _lastLanguage;
+    /**
+	 * @inheritDoc
+	 */ constructor(editor){
+        super(editor);
+        this._lastLanguage = null;
+    }
     /**
-     * @inheritDoc
-     */ refresh() {
+	 * @inheritDoc
+	 */ refresh() {
         this.value = this._getValue();
         this.isEnabled = this._checkEnabled();
     }
     /**
-     * Executes the command. When the command {@link #value is on}, all topmost code blocks within
-     * the selection will be removed. If it is off, all selected blocks will be flattened and
-     * wrapped by a code block.
-     *
-     * @fires execute
-     * @param options Command options.
-     * @param options.language The code block language.
-     * @param options.forceValue If set, it will force the command behavior. If `true`, the command will apply a code block,
-     * otherwise the command will remove the code block. If not set, the command will act basing on its current value.
-     * @param options.usePreviousLanguageChoice If set on `true` and the `options.language` is not specified, the command
-     * will apply the previous language (if the command was already executed) when inserting the `codeBlock` element.
-     */ execute(options = {}) {
+	 * Executes the command. When the command {@link #value is on}, all topmost code blocks within
+	 * the selection will be removed. If it is off, all selected blocks will be flattened and
+	 * wrapped by a code block.
+	 *
+	 * @fires execute
+	 * @param options Command options.
+	 * @param options.language The code block language.
+	 * @param options.forceValue If set, it will force the command behavior. If `true`, the command will apply a code block,
+	 * otherwise the command will remove the code block. If not set, the command will act basing on its current value.
+	 * @param options.usePreviousLanguageChoice If set on `true` and the `options.language` is not specified, the command
+	 * will apply the previous language (if the command was already executed) when inserting the `codeBlock` element.
+	 */ execute(options = {}) {
         const editor = this.editor;
         const model = editor.model;
         const selection = model.document.selection;
@@ -261,20 +272,20 @@ class CodeBlockCommand extends Command {
         });
     }
     /**
-     * Checks the command's {@link #value}.
-     *
-     * @returns The current value.
-     */ _getValue() {
+	 * Checks the command's {@link #value}.
+	 *
+	 * @returns The current value.
+	 */ _getValue() {
         const selection = this.editor.model.document.selection;
         const firstBlock = first(selection.getSelectedBlocks());
         const isCodeBlock = !!(firstBlock && firstBlock.is('element', 'codeBlock'));
         return isCodeBlock ? firstBlock.getAttribute('language') : false;
     }
     /**
-     * Checks whether the command can be enabled in the current context.
-     *
-     * @returns Whether the command should be enabled.
-     */ _checkEnabled() {
+	 * Checks whether the command can be enabled in the current context.
+	 *
+	 * @returns Whether the command should be enabled.
+	 */ _checkEnabled() {
         if (this.value) {
             return true;
         }
@@ -324,12 +335,6 @@ class CodeBlockCommand extends Command {
             writer.removeAttribute('language', block);
         }
     }
-    /**
-     * @inheritDoc
-     */ constructor(editor){
-        super(editor);
-        this._lastLanguage = null;
-    }
 }
 /**
  * Picks the language for the new code block. If any language is passed as an option,
@@ -346,18 +351,27 @@ class CodeBlockCommand extends Command {
     return defaultLanguage;
 }
 
-class IndentCodeBlockCommand extends Command {
+/**
+ * The code block indentation increase command plugin.
+ */ class IndentCodeBlockCommand extends Command {
     /**
-     * @inheritDoc
-     */ refresh() {
+	 * A sequence of characters added to the line when the command is executed.
+	 */ _indentSequence;
+    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() {
+	 * 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)=>{
@@ -395,8 +409,8 @@ class IndentCodeBlockCommand extends Command {
         });
     }
     /**
-     * Checks whether the command can be enabled in the current context.
-     */ _checkEnabled() {
+	 * Checks whether the command can be enabled in the current context.
+	 */ _checkEnabled() {
         if (!this._indentSequence) {
             return false;
         }
@@ -404,24 +418,29 @@ class IndentCodeBlockCommand extends Command {
         // because you can always indent code lines.
         return isModelSelectionInCodeBlock(this.editor.model.document.selection);
     }
+}
+
+/**
+ * The code block indentation decrease command plugin.
+ */ class OutdentCodeBlockCommand extends Command {
+    /**
+	 * A sequence of characters removed from the line when the command is executed.
+	 */ _indentSequence;
     constructor(editor){
         super(editor);
         this._indentSequence = editor.config.get('codeBlock.indentSequence');
     }
-}
-
-class OutdentCodeBlockCommand extends Command {
     /**
-     * @inheritDoc
-     */ refresh() {
+	 * @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() {
+	 * 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(()=>{
@@ -460,11 +479,11 @@ class OutdentCodeBlockCommand extends Command {
         });
     }
     /**
-     * Checks whether the command can be enabled in the current context.
-     *
-     * @private
-     * @returns {Boolean} Whether the command should be enabled.
-     */ _checkEnabled() {
+	 * 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;
         }
@@ -478,10 +497,6 @@ class OutdentCodeBlockCommand extends Command {
             return getLastOutdentableSequenceRange(model, position, this._indentSequence);
         });
     }
-    constructor(editor){
-        super(editor);
-        this._indentSequence = editor.config.get('codeBlock.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
@@ -824,22 +839,93 @@ function getCodeLineTextNodeAtPosition(position) {
 }
 
 const DEFAULT_ELEMENT = 'paragraph';
-class CodeBlockEditing extends Plugin {
+/**
+ * The editing part of the code block feature.
+ *
+ * Introduces the `'codeBlock'` command and the `'codeBlock'` model element.
+ */ class CodeBlockEditing extends Plugin {
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'CodeBlockEditing';
     }
     /**
-     * @inheritDoc
-     */ static get requires() {
+	 * @inheritDoc
+	 */ static get requires() {
         return [
             ShiftEnter
         ];
     }
     /**
-     * @inheritDoc
-     */ init() {
+	 * @inheritDoc
+	 */ constructor(editor){
+        super(editor);
+        editor.config.define('codeBlock', {
+            languages: [
+                {
+                    language: 'plaintext',
+                    label: 'Plain text'
+                },
+                {
+                    language: 'c',
+                    label: 'C'
+                },
+                {
+                    language: 'cs',
+                    label: 'C#'
+                },
+                {
+                    language: 'cpp',
+                    label: 'C++'
+                },
+                {
+                    language: 'css',
+                    label: 'CSS'
+                },
+                {
+                    language: 'diff',
+                    label: 'Diff'
+                },
+                {
+                    language: 'html',
+                    label: 'HTML'
+                },
+                {
+                    language: 'java',
+                    label: 'Java'
+                },
+                {
+                    language: 'javascript',
+                    label: 'JavaScript'
+                },
+                {
+                    language: 'php',
+                    label: 'PHP'
+                },
+                {
+                    language: 'python',
+                    label: 'Python'
+                },
+                {
+                    language: 'ruby',
+                    label: 'Ruby'
+                },
+                {
+                    language: 'typescript',
+                    label: 'TypeScript'
+                },
+                {
+                    language: 'xml',
+                    label: 'XML'
+                }
+            ],
+            // A single tab.
+            indentSequence: '\t'
+        });
+    }
+    /**
+	 * @inheritDoc
+	 */ init() {
         const editor = this.editor;
         const schema = editor.model.schema;
         const model = editor.model;
@@ -946,8 +1032,8 @@ class CodeBlockEditing extends Plugin {
         });
     }
     /**
-     * @inheritDoc
-     */ afterInit() {
+	 * @inheritDoc
+	 */ afterInit() {
         const editor = this.editor;
         const commands = editor.commands;
         const indent = commands.get('indent');
@@ -984,11 +1070,11 @@ class CodeBlockEditing extends Plugin {
         this._initAriaAnnouncements();
     }
     /**
-     * Observe when user enters or leaves code block and set proper aria value in global live announcer.
-     * This allows screen readers to indicate when the user has entered and left the specified code block.
-     *
-     * @internal
-     */ _initAriaAnnouncements() {
+	 * Observe when user enters or leaves code block and set proper aria value in global live announcer.
+	 * This allows screen readers to indicate when the user has entered and left the specified code block.
+	 *
+	 * @internal
+	 */ _initAriaAnnouncements() {
         const { model, ui, t } = this.editor;
         const languageDefs = getNormalizedAndLocalizedLanguageDefinitions(this.editor);
         let lastFocusedCodeBlock = null;
@@ -1006,73 +1092,6 @@ class CodeBlockEditing extends Plugin {
             lastFocusedCodeBlock = focusParent;
         });
     }
-    /**
-     * @inheritDoc
-     */ constructor(editor){
-        super(editor);
-        editor.config.define('codeBlock', {
-            languages: [
-                {
-                    language: 'plaintext',
-                    label: 'Plain text'
-                },
-                {
-                    language: 'c',
-                    label: 'C'
-                },
-                {
-                    language: 'cs',
-                    label: 'C#'
-                },
-                {
-                    language: 'cpp',
-                    label: 'C++'
-                },
-                {
-                    language: 'css',
-                    label: 'CSS'
-                },
-                {
-                    language: 'diff',
-                    label: 'Diff'
-                },
-                {
-                    language: 'html',
-                    label: 'HTML'
-                },
-                {
-                    language: 'java',
-                    label: 'Java'
-                },
-                {
-                    language: 'javascript',
-                    label: 'JavaScript'
-                },
-                {
-                    language: 'php',
-                    label: 'PHP'
-                },
-                {
-                    language: 'python',
-                    label: 'Python'
-                },
-                {
-                    language: 'ruby',
-                    label: 'Ruby'
-                },
-                {
-                    language: 'typescript',
-                    label: 'TypeScript'
-                },
-                {
-                    language: 'xml',
-                    label: 'XML'
-                }
-            ],
-            // A single tab.
-            indentSequence: '\t'
-        });
-    }
 }
 /**
  * Normally, when the Enter (or Shift+Enter) key is pressed, a soft line break is to be added to the
@@ -1224,15 +1243,19 @@ function isSoftBreakNode(node) {
     return node && node.is('element', 'softBreak');
 }
 
-class CodeBlockUI extends Plugin {
+/**
+ * The code block UI plugin.
+ *
+ * Introduces the `'codeBlock'` dropdown.
+ */ class CodeBlockUI extends Plugin {
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'CodeBlockUI';
     }
     /**
-     * @inheritDoc
-     */ init() {
+	 * @inheritDoc
+	 */ init() {
         const editor = this.editor;
         const t = editor.t;
         const componentFactory = editor.ui.componentFactory;
@@ -1303,9 +1326,9 @@ class CodeBlockUI extends Plugin {
         });
     }
     /**
-     * A helper returning a collection of the `codeBlock` dropdown items representing languages
-     * available for the user to choose from.
-     */ _getLanguageListItemDefinitions(normalizedLanguageDefs) {
+	 * A helper returning a collection of the `codeBlock` dropdown items representing languages
+	 * available for the user to choose from.
+	 */ _getLanguageListItemDefinitions(normalizedLanguageDefs) {
         const editor = this.editor;
         const command = editor.commands.get('codeBlock');
         const itemDefinitions = new Collection();
@@ -1328,18 +1351,26 @@ class CodeBlockUI extends Plugin {
     }
 }
 
-class CodeBlock extends Plugin {
+/**
+ * The code block plugin.
+ *
+ * For more information about this feature check the {@glink api/code-block package page} and the
+ * {@glink features/code-blocks code block} feature guide.
+ *
+ * This is a "glue" plugin that loads the {@link module:code-block/codeblockediting~CodeBlockEditing code block editing feature}
+ * and the {@link module:code-block/codeblockui~CodeBlockUI code block UI feature}.
+ */ class CodeBlock extends Plugin {
     /**
-     * @inheritDoc
-     */ static get requires() {
+	 * @inheritDoc
+	 */ static get requires() {
         return [
             CodeBlockEditing,
             CodeBlockUI
         ];
     }
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'CodeBlock';
     }
 }