@atlaskit/editor-plugin-code-block-advanced 7.0.0 → 7.1.1

package/src/nodeviews/codeBlockAdvanced.ts

@@ -17,6 +17,7 @@ import type {
 	getPosHandler,
 	getPosHandlerNode,
 	ExtractInjectionAPI,
+	EditorContentMode,
 } from '@atlaskit/editor-common/types';
 import { ZERO_WIDTH_SPACE } from '@atlaskit/editor-common/whitespace';
 import { type EditorSelectionAPI } from '@atlaskit/editor-plugin-selection';
@@ -37,19 +38,20 @@ import type { CodeBlockAdvancedPlugin } from '../codeBlockAdvancedPluginType';
 import { highlightStyle } from '../ui/syntaxHighlightingTheme';
 import { cmTheme, codeFoldingTheme } from '../ui/theme';
 
-// Store last observed heights of code blocks
-const codeBlockHeights = new WeakMap<HTMLElement, number>();
-
 import { syncCMWithPM } from './codemirrorSync/syncCMWithPM';
 import { getCMSelectionChanges } from './codemirrorSync/updateCMSelection';
 import { firstCodeBlockInDocument } from './extensions/firstCodeBlockInDocument';
 import { foldGutterExtension, getCodeBlockFoldStateEffects } from './extensions/foldGutter';
 import { keymapExtension } from './extensions/keymap';
+import { lineSeparatorExtension } from './extensions/lineSeparator';
 import { manageSelectionMarker } from './extensions/manageSelectionMarker';
 import { prosemirrorDecorationPlugin } from './extensions/prosemirrorDecorations';
 import { tripleClickSelectAllExtension } from './extensions/tripleClickExtension';
 import { LanguageLoader } from './languages/loader';
 
+// Store last observed heights of code blocks
+const codeBlockHeights = new WeakMap<HTMLElement, number>();
+
 export interface ConfigProps {
 	allowCodeFolding: boolean;
 	api: ExtractInjectionAPI<CodeBlockAdvancedPlugin> | undefined;
@@ -66,15 +68,18 @@ class CodeBlockAdvancedNodeView implements NodeView {
 	private languageCompartment = new Compartment();
 	private readOnlyCompartment = new Compartment();
 	private pmDecorationsCompartment = new Compartment();
+	private themeCompartment = new Compartment();
 	private node: PMNode;
 	private getPos: getPosHandlerNode;
 	private cm: CodeMirror;
+	private contentMode: EditorContentMode | undefined;
 	private selectionAPI: EditorSelectionAPI | undefined;
 	private maybeTryingToReachNodeSelection = false;
 	private cleanupDisabledState: (() => void) | undefined;
 	private languageLoader: LanguageLoader;
 	private pmFacet = Facet.define<DecorationSource>();
 	private ro?: ResizeObserver;
+	private unsubscribeContentFormat: (() => void) | undefined;
 
 	constructor(
 		node: PMNode,
@@ -86,12 +91,24 @@ class CodeBlockAdvancedNodeView implements NodeView {
 		this.node = node;
 		this.view = view;
 		this.getPos = getPos;
+		const contentFormatSharedState = expValEquals(
+			'confluence_compact_text_format',
+			'isEnabled',
+			true,
+		)
+			? config.api?.contentFormat?.sharedState
+			: undefined;
+		this.contentMode = expValEquals('confluence_compact_text_format', 'isEnabled', true)
+			? contentFormatSharedState?.currentState?.()?.contentMode
+			: undefined;
+
 		this.selectionAPI = config.api?.selection?.actions;
 		const getNode = () => this.node;
 		const onMaybeNodeSelection = () => (this.maybeTryingToReachNodeSelection = true);
 		this.cleanupDisabledState = config.api?.editorDisabled?.sharedState.onChange(() => {
 			this.updateReadonlyState();
 		});
+
 		this.languageLoader = new LanguageLoader((lang) => {
 			this.updating = true;
 			this.cm.dispatch({
@@ -126,7 +143,13 @@ class CodeBlockAdvancedNodeView implements NodeView {
 				}),
 				// Goes before cmTheme to override styles
 				config.allowCodeFolding ? [codeFoldingTheme] : [],
-				cmTheme,
+				this.themeCompartment.of(
+					cmTheme({
+						contentMode: expValEquals('confluence_compact_text_format', 'isEnabled', true)
+							? this.contentMode
+							: undefined,
+					}),
+				),
 				syntaxHighlighting(highlightStyle),
 				bracketMatching(),
 				lineNumbers({
@@ -160,23 +183,35 @@ class CodeBlockAdvancedNodeView implements NodeView {
 				config.allowCodeFolding
 					? [foldGutterExtension({ selectNode, getNode: () => this.node })]
 					: [],
+				lineSeparatorExtension(),
 			],
 		});
 
-		// We append an additional element that fixes a selection bug on chrome if the code block
-		// is the first element followed by subsequent code blocks
-		const spaceContainer = document.createElement('span');
-		spaceContainer.innerText = ZERO_WIDTH_SPACE;
-		spaceContainer.style.height = '0';
-		// The editor's outer node is our DOM representation
-		this.dom = this.cm.dom;
-		this.dom.appendChild(spaceContainer);
+		if (contentFormatSharedState) {
+			this.unsubscribeContentFormat = contentFormatSharedState.onChange(
+				({ nextSharedState, prevSharedState }) => {
+					const prevMode = prevSharedState?.contentMode;
+					const nextMode = nextSharedState?.contentMode;
+					if (nextMode === prevMode) {
+						return;
+					}
+
+					this.applyContentModeTheme(nextMode);
+
+					if (this.updating || this.cm.hasFocus) {
+						return;
+					}
+
+					this.cm.requestMeasure();
+				},
+			);
+		}
 
 		// Observe size changes of the CodeMirror DOM and request a measurement pass
 		if (
-			expValEquals('confluence_compact_text_format', 'isEnabled', true) ||
-			(expValEquals('cc_editor_ai_content_mode', 'variant', 'test') &&
-				fg('platform_editor_content_mode_button_mvp'))
+			!expValEquals('confluence_compact_text_format', 'isEnabled', true) &&
+			expValEquals('cc_editor_ai_content_mode', 'variant', 'test') &&
+			fg('platform_editor_content_mode_button_mvp')
 		) {
 			this.ro = new ResizeObserver((entries) => {
 				// Skip measurements when:
@@ -195,12 +230,22 @@ class CodeBlockAdvancedNodeView implements NodeView {
 					}
 					codeBlockHeights.set(this.cm.contentDOM, currentHeight);
 				}
+
 				// CodeMirror to re-measure when its content size changes
 				this.cm.requestMeasure();
 			});
 			this.ro.observe(this.cm.contentDOM);
 		}
 
+		// We append an additional element that fixes a selection bug on chrome if the code block
+		// is the first element followed by subsequent code blocks
+		const spaceContainer = document.createElement('span');
+		spaceContainer.innerText = ZERO_WIDTH_SPACE;
+		spaceContainer.style.height = '0';
+		// The editor's outer node is our DOM representation
+		this.dom = this.cm.dom;
+		this.dom.appendChild(spaceContainer);
+
 		// This flag is used to avoid an update loop between the outer and
 		// inner editor
 		this.updating = false;
@@ -220,10 +265,13 @@ class CodeBlockAdvancedNodeView implements NodeView {
 		// codemirror
 		this.clearProseMirrorDecorations();
 		this.cleanupDisabledState?.();
+		if (expValEquals('confluence_compact_text_format', 'isEnabled', true)) {
+			this.unsubscribeContentFormat?.();
+		}
 		if (
-			expValEquals('confluence_compact_text_format', 'isEnabled', true) ||
-			(expValEquals('cc_editor_ai_content_mode', 'variant', 'test') &&
-				fg('platform_editor_content_mode_button_mvp'))
+			!expValEquals('confluence_compact_text_format', 'isEnabled', true) &&
+			expValEquals('cc_editor_ai_content_mode', 'variant', 'test') &&
+			fg('platform_editor_content_mode_button_mvp')
 		) {
 			this.ro?.disconnect();
 		}
@@ -308,7 +356,19 @@ class CodeBlockAdvancedNodeView implements NodeView {
 		this.updating = false;
 	}
 
-	update(node: PMNode, _: readonly Decoration[], innerDecorations: DecorationSource) {
+	private applyContentModeTheme(contentMode: EditorContentMode | undefined) {
+		if (contentMode === this.contentMode) {
+			return;
+		}
+		this.contentMode = contentMode;
+		this.updating = true;
+		this.cm.dispatch({
+			effects: this.themeCompartment.reconfigure(cmTheme({ contentMode })),
+		});
+		this.updating = false;
+	}
+
+	update(node: PMNode, _: readonly Decoration[], innerDecorations: DecorationSource): boolean {
 		this.maybeTryingToReachNodeSelection = false;
 
 		if (node.type !== this.node.type) {
@@ -361,7 +421,7 @@ class CodeBlockAdvancedNodeView implements NodeView {
 		this.updating = false;
 	}
 
-	stopEvent(e: Event) {
+	stopEvent(e: Event): boolean {
 		// If we have selected the node we should not stop these events
 		if (
 			(e instanceof KeyboardEvent || e instanceof ClipboardEvent) &&

package/src/nodeviews/extensions/keymap/backspace.ts

@@ -12,7 +12,7 @@ interface BackspaceProps {
 	view: EditorView;
 }
 
-export const backspaceKeymap = ({ cm, view, getPos, getNode }: BackspaceProps) => {
+export const backspaceKeymap = ({ cm, view, getPos, getNode }: BackspaceProps): boolean => {
 	const ranges = cm.state.selection.ranges;
 
 	if (ranges.length > 1) {

package/src/nodeviews/extensions/lineSeparator.ts

@@ -0,0 +1,14 @@
+import { EditorState as CodeMirrorState } from '@codemirror/state';
+
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+
+/**
+ * To avoid issues with CRLF (\r\n) syncing with ProseMirror,
+ * we only consider \n for line separators.
+ */
+export const lineSeparatorExtension = () => {
+	if (expValEquals('platform_editor_fix_advanced_codeblocks_crlf', 'isEnabled', true)) {
+		return CodeMirrorState.lineSeparator.of('\n');
+	}
+	return [];
+};

package/src/pm-plugins/shiftArrowKeyWorkaround.ts

@@ -1,7 +1,7 @@
 import { TextSelection } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 
-export const shiftArrowUpWorkaround = (view: EditorView, event: KeyboardEvent) => {
+export const shiftArrowUpWorkaround = (view: EditorView, event: KeyboardEvent): boolean => {
 	const {
 		doc,
 		selection: { $head, $anchor },
@@ -28,7 +28,7 @@ export const shiftArrowUpWorkaround = (view: EditorView, event: KeyboardEvent) =
 	return false;
 };
 
-export const shiftArrowDownWorkaround = (view: EditorView, event: KeyboardEvent) => {
+export const shiftArrowDownWorkaround = (view: EditorView, event: KeyboardEvent): boolean => {
 	const {
 		doc,
 		selection: { $head, $anchor },

package/src/ui/theme.ts

@@ -1,91 +1,94 @@
 import { EditorView as CodeMirror } from '@codemirror/view';
 
+import type { EditorContentMode } from '@atlaskit/editor-common/types';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { token } from '@atlaskit/tokens';
 
-const getLineHeight = () =>
-	expValEquals('confluence_compact_text_format', 'isEnabled', true) ||
+const shouldUseCompactTypography = (contentMode?: EditorContentMode) =>
+	contentMode === 'compact' ||
 	(expValEquals('cc_editor_ai_content_mode', 'variant', 'test') &&
-		fg('platform_editor_content_mode_button_mvp'))
-		? '1.5em'
-		: '1.5rem';
+		fg('platform_editor_content_mode_button_mvp'));
 
-const getFontSize = () =>
-	expValEquals('confluence_compact_text_format', 'isEnabled', true) ||
-	(expValEquals('cc_editor_ai_content_mode', 'variant', 'test') &&
-		fg('platform_editor_content_mode_button_mvp'))
-		? '0.875em'
-		: '0.875rem';
+const getLineHeight = (contentMode?: EditorContentMode) =>
+	shouldUseCompactTypography(contentMode) ? '1.5em' : '1.5rem';
 
-export const cmTheme = CodeMirror.theme({
-	'&': {
-		backgroundColor: token('color.background.neutral'),
-		padding: '0',
-		marginTop: token('space.100'),
-		marginBottom: token('space.100'),
-		// eslint-disable-next-line @atlaskit/design-system/use-tokens-typography
-		fontSize: getFontSize(),
-		// Custom syntax styling to match existing styling
-		// eslint-disable-next-line @atlaskit/design-system/use-tokens-typography
-		lineHeight: getLineHeight(),
-	},
-	'&.cm-focused': {
-		outline: 'none',
-	},
-	'.cm-line': {
-		padding: '0',
-	},
-	'&.cm-editor.code-block.danger': {
-		backgroundColor: token('color.background.danger'),
-	},
-	'.cm-content[aria-readonly="true"]': {
-		caretColor: 'transparent',
-	},
-	'.cm-content': {
-		cursor: 'text',
-		caretColor: token('color.text'),
-		margin: token('space.100'),
-		padding: token('space.0'),
-	},
-	'.cm-scroller': {
-		backgroundColor: token('color.background.neutral'),
-		// Custom syntax styling to match existing styling
-		// eslint-disable-next-line @atlaskit/design-system/use-tokens-typography
-		lineHeight: 'unset',
-		fontFamily: token('font.family.code'),
-		borderRadius: token('radius.small'),
-		backgroundImage: overflowShadow({
-			leftCoverWidth: token('space.300'),
-		}),
-		backgroundAttachment: 'local, local, local, local, scroll, scroll, scroll, scroll',
-	},
-	'&.cm-focused .cm-cursor': {
-		borderLeftColor: token('color.text'),
-	},
-	'.cm-gutter': {
-		padding: token('space.100'),
-	},
-	'.cm-gutters': {
-		backgroundColor: token('color.background.neutral'),
-		border: 'none',
-		padding: token('space.0'),
-		color: token('color.text.subtlest'),
-	},
-	'.cm-lineNumbers .cm-gutterElement': {
-		paddingLeft: token('space.0'),
-		paddingRight: token('space.0'),
-		minWidth: 'unset',
-	},
-	// Set the gutter element min height to prevent flicker of styling while
-	// codemirror is calculating (which happens after an animation frame).
-	// Example problem: https://github.com/codemirror/dev/issues/1076
-	// Ignore the first gutter element as it is a special hidden element.
-	'.cm-gutterElement:not(:first-child)': {
-		// eslint-disable-next-line @atlaskit/design-system/use-tokens-typography
-		minHeight: getLineHeight(),
-	},
-});
+const getFontSize = (contentMode?: EditorContentMode) =>
+	shouldUseCompactTypography(contentMode) ? '0.875em' : '0.875rem';
+
+type ThemeOptions = {
+	contentMode?: EditorContentMode;
+};
+
+export const cmTheme = (options?: ThemeOptions) =>
+	CodeMirror.theme({
+		'&': {
+			backgroundColor: token('color.background.neutral'),
+			padding: '0',
+			marginTop: token('space.100'),
+			marginBottom: token('space.100'),
+			// eslint-disable-next-line @atlaskit/design-system/use-tokens-typography
+			fontSize: getFontSize(options?.contentMode),
+			// Custom syntax styling to match existing styling
+			// eslint-disable-next-line @atlaskit/design-system/use-tokens-typography
+			lineHeight: getLineHeight(options?.contentMode),
+		},
+		'&.cm-focused': {
+			outline: 'none',
+		},
+		'.cm-line': {
+			padding: '0',
+		},
+		'&.cm-editor.code-block.danger': {
+			backgroundColor: token('color.background.danger'),
+		},
+		'.cm-content[aria-readonly="true"]': {
+			caretColor: 'transparent',
+		},
+		'.cm-content': {
+			cursor: 'text',
+			caretColor: token('color.text'),
+			margin: token('space.100'),
+			padding: token('space.0'),
+		},
+		'.cm-scroller': {
+			backgroundColor: token('color.background.neutral'),
+			// Custom syntax styling to match existing styling
+			// eslint-disable-next-line @atlaskit/design-system/use-tokens-typography
+			lineHeight: 'unset',
+			fontFamily: token('font.family.code'),
+			borderRadius: token('radius.small'),
+			backgroundImage: overflowShadow({
+				leftCoverWidth: token('space.300'),
+			}),
+			backgroundAttachment: 'local, local, local, local, scroll, scroll, scroll, scroll',
+		},
+		'&.cm-focused .cm-cursor': {
+			borderLeftColor: token('color.text'),
+		},
+		'.cm-gutter': {
+			padding: token('space.100'),
+		},
+		'.cm-gutters': {
+			backgroundColor: token('color.background.neutral'),
+			border: 'none',
+			padding: token('space.0'),
+			color: token('color.text.subtlest'),
+		},
+		'.cm-lineNumbers .cm-gutterElement': {
+			paddingLeft: token('space.0'),
+			paddingRight: token('space.0'),
+			minWidth: 'unset',
+		},
+		// Set the gutter element min height to prevent flicker of styling while
+		// codemirror is calculating (which happens after an animation frame).
+		// Example problem: https://github.com/codemirror/dev/issues/1076
+		// Ignore the first gutter element as it is a special hidden element.
+		'.cm-gutterElement:not(:first-child)': {
+			// eslint-disable-next-line @atlaskit/design-system/use-tokens-typography
+			minHeight: getLineHeight(options?.contentMode),
+		},
+	});
 
 export const codeFoldingTheme = CodeMirror.theme({
 	'.cm-gutter': {

package/tsconfig.app.json

@@ -43,6 +43,9 @@
 		{
 			"path": "../editor-plugin-code-block/tsconfig.app.json"
 		},
+		{
+			"path": "../editor-plugin-content-format/tsconfig.app.json"
+		},
 		{
 			"path": "../editor-plugin-editor-disabled/tsconfig.app.json"
 		},

package/build/tsconfig.json

@@ -1,22 +0,0 @@
-{
-  "extends": "../tsconfig",
-  "compilerOptions": {
-    "target": "es5",
-    "paths": {}
-  },
-  "include": [
-    "../src/**/*.ts",
-    "../src/**/*.tsx"
-  ],
-  "exclude": [
-    "../src/**/__tests__/*",
-    "../src/**/*.test.*",
-    "../src/**/test.*",
-    "../src/**/examples.*",
-    "../src/**/examples/*",
-    "../src/**/examples/**/*",
-    "../src/**/*.stories.*",
-    "../src/**/stories/*",
-    "../src/**/stories/**/*"
-  ]
-}