@atlaskit/editor-plugin-code-block 3.3.10 → 3.3.11

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-plugin-code-block
 
+## 3.3.11
+
+### Patch Changes
+
+- [#136266](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/136266)
+  [`cb41a82ab6813`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/cb41a82ab6813) -
+  ED-24752 Add new plugin to code block that strips auto inserted fullstops from mac on code blocks
+- Updated dependencies
+
 ## 3.3.10
 
 ### Patch Changes

package/dist/cjs/plugin.js

@@ -12,6 +12,7 @@ var _analytics = require("@atlaskit/editor-common/analytics");
 var _messages = require("@atlaskit/editor-common/messages");
 var _quickInsert = require("@atlaskit/editor-common/quick-insert");
 var _actions = require("./actions");
+var _codeBlockAutoFullStopTransformPlugin = require("./pm-plugins/codeBlockAutoFullStopTransformPlugin");
 var _codeBlockCopySelectionPlugin = require("./pm-plugins/codeBlockCopySelectionPlugin");
 var _ideUx = _interopRequireDefault(require("./pm-plugins/ide-ux"));
 var _inputRule = require("./pm-plugins/input-rule");
@@ -65,6 +66,11 @@ var codeBlockPlugin = function codeBlockPlugin(_ref) {
         plugin: function plugin() {
           return (0, _codeBlockCopySelectionPlugin.codeBlockCopySelectionPlugin)();
         }
+      }, {
+        name: 'codeBlockAutoFullStopTransform',
+        plugin: function plugin() {
+          return (0, _codeBlockAutoFullStopTransformPlugin.codeBlockAutoFullStopTransformPlugin)();
+        }
       }];
     },
     // Workaround for a firefox issue where dom selection is off sync

package/dist/cjs/pm-plugins/codeBlockAutoFullStopTransformPlugin.js

@@ -0,0 +1,65 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.codeBlockAutoFullStopTransformPlugin = codeBlockAutoFullStopTransformPlugin;
+exports.codeBlockAutoFullStopTransformPluginKey = void 0;
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _utils = require("@atlaskit/editor-common/utils");
+var _state = require("@atlaskit/editor-prosemirror/state");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _utils2 = require("../utils");
+var codeBlockAutoFullStopTransformPluginKey = exports.codeBlockAutoFullStopTransformPluginKey = new _state.PluginKey('codeBlockAutoFullStopTransformPluginKey');
+function codeBlockAutoFullStopTransformPlugin() {
+  return new _safePlugin.SafePlugin({
+    key: codeBlockAutoFullStopTransformPluginKey,
+    appendTransaction: function appendTransaction(_transactions, oldState, newState) {
+      if (!(0, _platformFeatureFlags.fg)('editor_support_code_block_wrapping') || !(0, _platformFeatureFlags.fg)('code_block_auto_insertion_bug_fix')) {
+        return undefined;
+      }
+
+      // We need to compare the old and new state to isloate auto insertion of fullstop on mac
+      var trNew = newState.tr;
+      var trOld = oldState.tr;
+      var fromOld = trOld.selection.from;
+      var _trNew$selection = trNew.selection,
+        fromNew = _trNew$selection.from,
+        toNew = _trNew$selection.to;
+      var isCodeBlock = !!(0, _utils2.findCodeBlock)(oldState, trOld.selection) && !!(0, _utils2.findCodeBlock)(newState, trNew.selection);
+
+      /**
+       * Mac will auto insert a fullstop when the user double taps the space key after some content.
+       * Line number decorators are assumed content so on new lines the fullstop is inserted.
+       *
+       * - When a fulltop is auto inserted the new states selection is the same, the old state selection is one position less
+       * - The text returned for the old state returns as a space with the selection from - 1
+       * - The text returned for the new state returns as a fullstop with the selection from - 2 to from -1
+       *
+       * This is enough conditional logic to isoloate the auto insertion of the fullstop on mac
+       *
+       * There are some solutions to this problem in codemirror which can be read further here
+       * https://discuss.codemirror.net/t/dot-being-added-when-pressing-space-repeatedly/3899
+       */
+
+      // both selections must be of code block early exit
+      if (_utils.browser.mac && fromNew === toNew && fromNew === fromOld + 1 && isCodeBlock) {
+        // detect when '.' is inserted when the previous state was a space ' '
+        try {
+          var textBetweenBefore = trOld.doc.textBetween(fromOld - 1, fromOld); // ' '
+          var textBetweenAfter = trNew.doc.textBetween(fromNew - 2, fromNew - 1); // '.'
+          if (textBetweenBefore === ' ' && textBetweenAfter === '.') {
+            trNew.delete(fromNew - 2, fromNew); // remove the fullstop
+            trNew.insertText('  ', fromNew - 2); // insert double space
+
+            return trNew;
+          }
+        } catch (error) {
+          // if for some reason textBetween fails, just return the new transaction as is by defaut.
+          return undefined;
+        }
+      }
+      return undefined;
+    }
+  });
+}

package/dist/es2019/plugin.js

@@ -4,6 +4,7 @@ import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } f
 import { blockTypeMessages } from '@atlaskit/editor-common/messages';
 import { IconCode } from '@atlaskit/editor-common/quick-insert';
 import { createInsertCodeBlockTransaction, insertCodeBlockWithAnalytics } from './actions';
+import { codeBlockAutoFullStopTransformPlugin } from './pm-plugins/codeBlockAutoFullStopTransformPlugin';
 import { codeBlockCopySelectionPlugin } from './pm-plugins/codeBlockCopySelectionPlugin';
 import ideUX from './pm-plugins/ide-ux';
 import { createCodeBlockInputRule } from './pm-plugins/input-rule';
@@ -51,6 +52,9 @@ const codeBlockPlugin = ({
     }, {
       name: 'codeBlockCopySelection',
       plugin: () => codeBlockCopySelectionPlugin()
+    }, {
+      name: 'codeBlockAutoFullStopTransform',
+      plugin: () => codeBlockAutoFullStopTransformPlugin()
     }];
   },
   // Workaround for a firefox issue where dom selection is off sync

package/dist/es2019/pm-plugins/codeBlockAutoFullStopTransformPlugin.js

@@ -0,0 +1,65 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { browser } from '@atlaskit/editor-common/utils';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { findCodeBlock } from '../utils';
+export const codeBlockAutoFullStopTransformPluginKey = new PluginKey('codeBlockAutoFullStopTransformPluginKey');
+export function codeBlockAutoFullStopTransformPlugin() {
+  return new SafePlugin({
+    key: codeBlockAutoFullStopTransformPluginKey,
+    appendTransaction(_transactions, oldState, newState) {
+      if (!fg('editor_support_code_block_wrapping') || !fg('code_block_auto_insertion_bug_fix')) {
+        return undefined;
+      }
+
+      // We need to compare the old and new state to isloate auto insertion of fullstop on mac
+      const {
+        tr: trNew
+      } = newState;
+      const {
+        tr: trOld
+      } = oldState;
+      const {
+        from: fromOld
+      } = trOld.selection;
+      const {
+        from: fromNew,
+        to: toNew
+      } = trNew.selection;
+      const isCodeBlock = !!findCodeBlock(oldState, trOld.selection) && !!findCodeBlock(newState, trNew.selection);
+
+      /**
+       * Mac will auto insert a fullstop when the user double taps the space key after some content.
+       * Line number decorators are assumed content so on new lines the fullstop is inserted.
+       *
+       * - When a fulltop is auto inserted the new states selection is the same, the old state selection is one position less
+       * - The text returned for the old state returns as a space with the selection from - 1
+       * - The text returned for the new state returns as a fullstop with the selection from - 2 to from -1
+       *
+       * This is enough conditional logic to isoloate the auto insertion of the fullstop on mac
+       *
+       * There are some solutions to this problem in codemirror which can be read further here
+       * https://discuss.codemirror.net/t/dot-being-added-when-pressing-space-repeatedly/3899
+       */
+
+      // both selections must be of code block early exit
+      if (browser.mac && fromNew === toNew && fromNew === fromOld + 1 && isCodeBlock) {
+        // detect when '.' is inserted when the previous state was a space ' '
+        try {
+          const textBetweenBefore = trOld.doc.textBetween(fromOld - 1, fromOld); // ' '
+          const textBetweenAfter = trNew.doc.textBetween(fromNew - 2, fromNew - 1); // '.'
+          if (textBetweenBefore === ' ' && textBetweenAfter === '.') {
+            trNew.delete(fromNew - 2, fromNew); // remove the fullstop
+            trNew.insertText('  ', fromNew - 2); // insert double space
+
+            return trNew;
+          }
+        } catch (error) {
+          // if for some reason textBetween fails, just return the new transaction as is by defaut.
+          return undefined;
+        }
+      }
+      return undefined;
+    }
+  });
+}

package/dist/esm/plugin.js

@@ -7,6 +7,7 @@ import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } f
 import { blockTypeMessages } from '@atlaskit/editor-common/messages';
 import { IconCode } from '@atlaskit/editor-common/quick-insert';
 import { createInsertCodeBlockTransaction, insertCodeBlockWithAnalytics } from './actions';
+import { codeBlockAutoFullStopTransformPlugin } from './pm-plugins/codeBlockAutoFullStopTransformPlugin';
 import { codeBlockCopySelectionPlugin } from './pm-plugins/codeBlockCopySelectionPlugin';
 import ideUX from './pm-plugins/ide-ux';
 import { createCodeBlockInputRule } from './pm-plugins/input-rule';
@@ -58,6 +59,11 @@ var codeBlockPlugin = function codeBlockPlugin(_ref) {
         plugin: function plugin() {
           return codeBlockCopySelectionPlugin();
         }
+      }, {
+        name: 'codeBlockAutoFullStopTransform',
+        plugin: function plugin() {
+          return codeBlockAutoFullStopTransformPlugin();
+        }
       }];
     },
     // Workaround for a firefox issue where dom selection is off sync

package/dist/esm/pm-plugins/codeBlockAutoFullStopTransformPlugin.js

@@ -0,0 +1,58 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { browser } from '@atlaskit/editor-common/utils';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { findCodeBlock } from '../utils';
+export var codeBlockAutoFullStopTransformPluginKey = new PluginKey('codeBlockAutoFullStopTransformPluginKey');
+export function codeBlockAutoFullStopTransformPlugin() {
+  return new SafePlugin({
+    key: codeBlockAutoFullStopTransformPluginKey,
+    appendTransaction: function appendTransaction(_transactions, oldState, newState) {
+      if (!fg('editor_support_code_block_wrapping') || !fg('code_block_auto_insertion_bug_fix')) {
+        return undefined;
+      }
+
+      // We need to compare the old and new state to isloate auto insertion of fullstop on mac
+      var trNew = newState.tr;
+      var trOld = oldState.tr;
+      var fromOld = trOld.selection.from;
+      var _trNew$selection = trNew.selection,
+        fromNew = _trNew$selection.from,
+        toNew = _trNew$selection.to;
+      var isCodeBlock = !!findCodeBlock(oldState, trOld.selection) && !!findCodeBlock(newState, trNew.selection);
+
+      /**
+       * Mac will auto insert a fullstop when the user double taps the space key after some content.
+       * Line number decorators are assumed content so on new lines the fullstop is inserted.
+       *
+       * - When a fulltop is auto inserted the new states selection is the same, the old state selection is one position less
+       * - The text returned for the old state returns as a space with the selection from - 1
+       * - The text returned for the new state returns as a fullstop with the selection from - 2 to from -1
+       *
+       * This is enough conditional logic to isoloate the auto insertion of the fullstop on mac
+       *
+       * There are some solutions to this problem in codemirror which can be read further here
+       * https://discuss.codemirror.net/t/dot-being-added-when-pressing-space-repeatedly/3899
+       */
+
+      // both selections must be of code block early exit
+      if (browser.mac && fromNew === toNew && fromNew === fromOld + 1 && isCodeBlock) {
+        // detect when '.' is inserted when the previous state was a space ' '
+        try {
+          var textBetweenBefore = trOld.doc.textBetween(fromOld - 1, fromOld); // ' '
+          var textBetweenAfter = trNew.doc.textBetween(fromNew - 2, fromNew - 1); // '.'
+          if (textBetweenBefore === ' ' && textBetweenAfter === '.') {
+            trNew.delete(fromNew - 2, fromNew); // remove the fullstop
+            trNew.insertText('  ', fromNew - 2); // insert double space
+
+            return trNew;
+          }
+        } catch (error) {
+          // if for some reason textBetween fails, just return the new transaction as is by defaut.
+          return undefined;
+        }
+      }
+      return undefined;
+    }
+  });
+}

package/dist/types/pm-plugins/codeBlockAutoFullStopTransformPlugin.d.ts

@@ -0,0 +1,4 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export declare const codeBlockAutoFullStopTransformPluginKey: PluginKey<any>;
+export declare function codeBlockAutoFullStopTransformPlugin(): SafePlugin<any>;

package/dist/types-ts4.5/pm-plugins/codeBlockAutoFullStopTransformPlugin.d.ts

@@ -0,0 +1,4 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export declare const codeBlockAutoFullStopTransformPluginKey: PluginKey<any>;
+export declare function codeBlockAutoFullStopTransformPlugin(): SafePlugin<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-code-block",
-	"version": "3.3.10",
+	"version": "3.3.11",
 	"description": "Code block plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -33,7 +33,7 @@
 	"dependencies": {
 		"@atlaskit/adf-schema": "^40.9.0",
 		"@atlaskit/code": "^15.6.0",
-		"@atlaskit/editor-common": "^88.5.0",
+		"@atlaskit/editor-common": "^88.7.0",
 		"@atlaskit/editor-plugin-analytics": "^1.8.0",
 		"@atlaskit/editor-plugin-composition": "^1.2.0",
 		"@atlaskit/editor-plugin-decorations": "^1.3.0",
@@ -94,6 +94,9 @@
 		"editor_support_code_block_wrapping": {
 			"type": "boolean"
 		},
+		"code_block_auto_insertion_bug_fix": {
+			"type": "boolean"
+		},
 		"platform.editor.live-view.disable-editing-in-view-mode_fi1rx": {
 			"type": "boolean"
 		}