@atlaskit/editor-plugin-code-block
Version:
Code block plugin for @atlaskit/editor-core
312 lines (310 loc) • 17.4 kB
JavaScript
import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
import _defineProperty from "@babel/runtime/helpers/defineProperty";
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
import React from 'react';
import { areCodeBlockLineNumbersVisible, isCodeBlockWordWrapEnabled } from '@atlaskit/editor-common/code-block';
import commonMessages, { codeBlockButtonMessages } from '@atlaskit/editor-common/messages';
import { areToolbarFlagsEnabled } from '@atlaskit/editor-common/toolbar-flag-check';
import { findDomRefAtPos } from '@atlaskit/editor-prosemirror/utils';
import AngleBracketsIcon from '@atlaskit/icon/core/angle-brackets';
import CopyIcon from '@atlaskit/icon/core/copy';
import DeleteIcon from '@atlaskit/icon/core/delete';
import ListNumberedIcon from '@atlaskit/icon/core/list-numbered';
import TextWrapIcon from '@atlaskit/icon/core/text-wrap';
import { fg } from '@atlaskit/platform-feature-flags';
import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
import { expValEqualsNoExposure } from '@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure';
import { changeLanguage, copyContentToClipboardWithAnalytics, createFormatCodeOnClick, removeCodeBlockWithAnalytics, resetCopiedState, toggleLineNumbersForCodeBlockNode, toggleWordWrapStateForCodeBlockNode } from '../editor-commands';
import { CodeBlockLanguagePicker } from '../ui/CodeBlockLanguagePicker';
import { WrapIcon } from '../ui/icons/WrapIcon';
import { DETECT_LANGUAGE_VALUE, NONE_LANGUAGE_VALUE, PLAIN_TEXT_LANGUAGE_VALUE } from '../ui/language-picker-options';
import { preloadFormatterOnIntent } from '../utils/format-code/formatter';
import { autoDetectPluginKey } from './auto-detect-state';
import { provideVisualFeedbackForCopyButton, removeVisualFeedbackForCopyButton } from './codeBlockCopySelectionPlugin';
import { createLanguageList, DEFAULT_LANGUAGES, getLanguageIdentifier } from './language-list';
import { pluginKey } from './plugin-key';
var getDetectLanguageOption = function getDetectLanguageOption(formatMessage) {
return {
alias: [],
label: formatMessage(codeBlockButtonMessages.detectLanguage),
value: DETECT_LANGUAGE_VALUE
};
};
var getNoneDetectedOption = function getNoneDetectedOption(formatMessage) {
return {
alias: [],
label: formatMessage(codeBlockButtonMessages.noneDetected),
value: NONE_LANGUAGE_VALUE
};
};
var getDefaultLanguagePickerValue = function getDefaultLanguagePickerValue(language, languagePickerOptions) {
return language ? languagePickerOptions.find(function (option) {
return language === NONE_LANGUAGE_VALUE ? option.value === PLAIN_TEXT_LANGUAGE_VALUE : option.value === language || option.alias.includes(language);
}) : undefined;
};
var getAutoDetectPickerValue = function getAutoDetectPickerValue(_ref) {
var autoDetectEntry = _ref.autoDetectEntry,
formatMessage = _ref.formatMessage,
language = _ref.language,
languagePickerOptions = _ref.languagePickerOptions;
var defaultPickerValue = getDefaultLanguagePickerValue(language, languagePickerOptions);
// A weak re-detection records noneDetected but can leave a previously auto-detected
// language on the node. Keep showing "(detected)" only while that preserved language
// still matches the node language, so manual language changes do not inherit the label.
var shouldShowDetectedLabel = Boolean(defaultPickerValue) && (autoDetectEntry === null || autoDetectEntry === void 0 ? void 0 : autoDetectEntry.autoDetectedLanguage) === language && Boolean(autoDetectEntry === null || autoDetectEntry === void 0 ? void 0 : autoDetectEntry.detectionResult);
if (shouldShowDetectedLabel && defaultPickerValue) {
return _objectSpread(_objectSpread({}, defaultPickerValue), {}, {
label: formatMessage(codeBlockButtonMessages.detectedLanguage, {
language: defaultPickerValue.label
})
});
}
if (language || !autoDetectEntry) {
return defaultPickerValue;
}
if (autoDetectEntry.detectionResult === 'noneDetected') {
return getNoneDetectedOption(formatMessage);
}
if (!autoDetectEntry.detectionResult) {
return getDetectLanguageOption(formatMessage);
}
return undefined;
};
export var getToolbarConfig = function getToolbarConfig() {
var allowCopyToClipboard = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
var api = arguments.length > 1 ? arguments[1] : undefined;
var overrideLanguageName = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : undefined;
var formatCodeProvider = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : undefined;
var languageList = createLanguageList(overrideLanguageName ? DEFAULT_LANGUAGES.map(function (languageOption) {
return _objectSpread(_objectSpread({}, languageOption), {}, {
name: overrideLanguageName(languageOption.name)
});
}) : DEFAULT_LANGUAGES);
var languagePickerOptions = languageList.map(function (lang) {
return {
label: lang.name,
value: getLanguageIdentifier(lang),
alias: lang.alias
};
});
return function (state, _ref2) {
var _api$editorViewMode, _api$decorations$acti, _api$decorations, _api$analytics, _codeBlockState$pos, _node$attrs, _node$attrs2;
var formatMessage = _ref2.formatMessage;
var isViewMode = (api === null || api === void 0 || (_api$editorViewMode = api.editorViewMode) === null || _api$editorViewMode === void 0 || (_api$editorViewMode = _api$editorViewMode.sharedState.currentState()) === null || _api$editorViewMode === void 0 ? void 0 : _api$editorViewMode.mode) === 'view';
var _ref3 = (_api$decorations$acti = api === null || api === void 0 || (_api$decorations = api.decorations) === null || _api$decorations === void 0 ? void 0 : _api$decorations.actions) !== null && _api$decorations$acti !== void 0 ? _api$decorations$acti : {},
hoverDecoration = _ref3.hoverDecoration;
var editorAnalyticsAPI = api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions;
var codeBlockState = pluginKey.getState(state);
var pos = (_codeBlockState$pos = codeBlockState === null || codeBlockState === void 0 ? void 0 : codeBlockState.pos) !== null && _codeBlockState$pos !== void 0 ? _codeBlockState$pos : null;
if (!codeBlockState || pos === null) {
return;
}
var node = state.doc.nodeAt(pos);
var nodeType = state.schema.nodes.codeBlock;
if ((node === null || node === void 0 ? void 0 : node.type) !== nodeType) {
return;
}
var isWrapped = isCodeBlockWordWrapEnabled(node);
var areLineNumbersVisible = areCodeBlockLineNumbersVisible(node);
var language = node === null || node === void 0 || (_node$attrs = node.attrs) === null || _node$attrs === void 0 ? void 0 : _node$attrs.language;
var localId = node === null || node === void 0 || (_node$attrs2 = node.attrs) === null || _node$attrs2 === void 0 ? void 0 : _node$attrs2.localId;
var autoDetectState = autoDetectPluginKey.getState(state);
var isFormatCodePending = typeof localId === 'string' && Boolean(codeBlockState.pendingFormats[localId]);
// Keep fresh option objects for the legacy toolbar select so reopening it
// continues to start from the top rather than preserving the previously
// focused option by reference.
var languageSelectOptions = languagePickerOptions.map(function (option) {
return _objectSpread({}, option);
});
var defaultValue = language ? languageSelectOptions.find(function (option) {
return option.value === language;
}) || languageSelectOptions.find(function (option) {
return option.alias.includes(language);
}) : null;
var languageSelect = {
id: 'editor.codeBlock.languageOptions',
type: 'select',
selectType: 'list',
onChange: function onChange(option) {
return changeLanguage(editorAnalyticsAPI)(option.value);
},
defaultValue: defaultValue,
placeholder: formatMessage(codeBlockButtonMessages.selectLanguage),
options: languageSelectOptions,
filterOption: languageListFilter
};
var areAnyNewToolbarFlagsEnabled = areToolbarFlagsEnabled(Boolean(api === null || api === void 0 ? void 0 : api.toolbar));
var languagePicker;
if (expValEquals('platform_editor_code_block_q4_lovability', 'isEnabled', true) && fg('platform_editor_code_block_add_line_number_button')) {
var autoDetectEntry = typeof localId === 'string' && fg('platform_editor_code_block_language_detection_flow') ? autoDetectState === null || autoDetectState === void 0 ? void 0 : autoDetectState.languageDetectionMap[localId] : undefined;
var autoDetectPickerValue = getAutoDetectPickerValue({
autoDetectEntry: autoDetectEntry,
formatMessage: formatMessage,
language: language,
languagePickerOptions: languagePickerOptions
});
languagePicker = {
type: 'custom',
fallback: [],
render: function render(view) {
if (!view) {
return null;
}
return /*#__PURE__*/React.createElement(CodeBlockLanguagePicker, {
api: api,
defaultValue: autoDetectPickerValue,
editorView: view,
filterOption: languageListFilter,
formatMessage: formatMessage,
languagePickerOptions: languagePickerOptions,
triggerSpacing: !areAnyNewToolbarFlagsEnabled && fg('platform_editor_code_block_dogfooding_patch') ? 'compact' : 'default'
});
}
};
}
var separator = {
type: 'separator'
};
var copyToClipboardItems = !allowCopyToClipboard ? [] : [{
id: 'editor.codeBlock.copy',
type: 'button',
supportsViewMode: true,
appearance: 'subtle',
icon: CopyIcon,
// note: copyContentToClipboardWithAnalytics contains logic that also removes the
// visual feedback for the copy button
onClick: copyContentToClipboardWithAnalytics(editorAnalyticsAPI),
title: formatMessage(codeBlockState.contentCopied ? codeBlockButtonMessages.copiedCodeToClipboard : codeBlockButtonMessages.copyCodeToClipboard),
onMouseEnter: provideVisualFeedbackForCopyButton,
// note: resetCopiedState contains logic that also removes the
// visual feedback for the copy button
onMouseLeave: resetCopiedState,
onFocus: provideVisualFeedbackForCopyButton,
onBlur: removeVisualFeedbackForCopyButton,
hideTooltipOnClick: false,
disabled: codeBlockState.isNodeSelected,
tabIndex: null
}, separator];
var copyAndDeleteButtonMenuItems = [];
if (areAnyNewToolbarFlagsEnabled) {
var overflowMenuOptions = [{
title: formatMessage(commonMessages.delete),
icon: DeleteIcon({
label: ''
}),
onMouseEnter: hoverDecoration === null || hoverDecoration === void 0 ? void 0 : hoverDecoration(nodeType, true),
onMouseLeave: hoverDecoration === null || hoverDecoration === void 0 ? void 0 : hoverDecoration(nodeType, false),
onFocus: hoverDecoration === null || hoverDecoration === void 0 ? void 0 : hoverDecoration(nodeType, true),
onBlur: hoverDecoration === null || hoverDecoration === void 0 ? void 0 : hoverDecoration(nodeType, false),
onClick: removeCodeBlockWithAnalytics(editorAnalyticsAPI)
}];
if (allowCopyToClipboard) {
overflowMenuOptions.unshift({
title: formatMessage(commonMessages.copyToClipboard),
onClick: copyContentToClipboardWithAnalytics(editorAnalyticsAPI),
icon: CopyIcon({
label: ''
}),
onMouseEnter: provideVisualFeedbackForCopyButton,
onMouseLeave: resetCopiedState,
onFocus: provideVisualFeedbackForCopyButton,
onBlur: removeVisualFeedbackForCopyButton,
disabled: codeBlockState.isNodeSelected
});
}
copyAndDeleteButtonMenuItems = isViewMode ? [].concat(copyToClipboardItems) : [{
type: 'separator',
fullHeight: true
}, {
type: 'overflow-dropdown',
testId: 'code-block-overflow-dropdown-trigger',
options: overflowMenuOptions
}];
} else {
var deleteButton = {
id: 'editor.codeBlock.delete',
type: 'button',
appearance: 'danger',
icon: DeleteIcon,
iconFallback: DeleteIcon,
onMouseEnter: hoverDecoration === null || hoverDecoration === void 0 ? void 0 : hoverDecoration(nodeType, true),
onMouseLeave: hoverDecoration === null || hoverDecoration === void 0 ? void 0 : hoverDecoration(nodeType, false),
onFocus: hoverDecoration === null || hoverDecoration === void 0 ? void 0 : hoverDecoration(nodeType, true),
onBlur: hoverDecoration === null || hoverDecoration === void 0 ? void 0 : hoverDecoration(nodeType, false),
onClick: removeCodeBlockWithAnalytics(editorAnalyticsAPI),
title: formatMessage(commonMessages.remove),
tabIndex: null
};
copyAndDeleteButtonMenuItems = [separator].concat(copyToClipboardItems, [deleteButton]);
}
var codeBlockWrapButtonTitle = expValEqualsNoExposure('platform_editor_code_block_q4_lovability', 'isEnabled', true) ? formatMessage(isWrapped ? codeBlockButtonMessages.unwrapCodeLabel : codeBlockButtonMessages.wrapCodeLabel) : formatMessage(codeBlockButtonMessages.wrapCode);
var codeBlockWrapButton = {
id: 'editor.codeBlock.wrap',
type: 'button',
// Toggling button now writes to ADF, hence it should be available in view mode
supportsViewMode: !expValEqualsNoExposure('platform_editor_code_block_q4_lovability', 'isEnabled', true),
icon: TextWrapIcon,
iconFallback: WrapIcon,
onClick: toggleWordWrapStateForCodeBlockNode(editorAnalyticsAPI),
title: codeBlockWrapButtonTitle,
tabIndex: null,
selected: isWrapped
};
var codeBlockLineNumbersButton = {
id: 'editor.codeBlock.lineNumbers',
type: 'button',
supportsViewMode: false,
icon: ListNumberedIcon,
onClick: toggleLineNumbersForCodeBlockNode(editorAnalyticsAPI),
title: formatMessage(areLineNumbersVisible ? codeBlockButtonMessages.hideLineNumbersLabel : codeBlockButtonMessages.showLineNumbersLabel),
tabIndex: null,
selected: areLineNumbersVisible
};
var formatLanguage = formatCodeProvider !== null && formatCodeProvider !== void 0 && formatCodeProvider.isSupportedLanguage(language) ? language : undefined;
var canFormatCode = node.textContent.length > 0 && Boolean(formatLanguage);
var formatCodeButton = {
id: 'editor.codeBlock.formatCode',
type: 'button',
supportsViewMode: false,
disabled: !canFormatCode || isFormatCodePending,
icon: AngleBracketsIcon,
onClick: createFormatCodeOnClick({
api: api,
editorAnalyticsAPI: editorAnalyticsAPI,
formatCodeProvider: formatCodeProvider
}),
onFocus: preloadFormatterOnIntent(formatCodeProvider, formatLanguage),
onMouseEnter: preloadFormatterOnIntent(formatCodeProvider, formatLanguage),
title: formatMessage(canFormatCode ? codeBlockButtonMessages.formatCode : codeBlockButtonMessages.formatCodeUnavailable)
};
return {
title: 'CodeBlock floating controls',
// Ignored via go/ees005
// eslint-disable-next-line @atlaskit/editor/no-as-casting
getDomRef: function getDomRef(view) {
return findDomRefAtPos(pos, view.domAtPos.bind(view));
},
nodeType: nodeType,
items: [languagePicker !== null && languagePicker !== void 0 ? languagePicker : languageSelect].concat(_toConsumableArray(areAnyNewToolbarFlagsEnabled ? [] : [separator]), [codeBlockWrapButton], _toConsumableArray(expValEquals('platform_editor_code_block_q4_lovability', 'isEnabled', true) && fg('platform_editor_code_block_add_line_number_button') ? [codeBlockLineNumbersButton].concat(_toConsumableArray(formatCodeProvider ? [formatCodeButton] : [])) : []), _toConsumableArray(copyAndDeleteButtonMenuItems)),
scrollable: true
};
};
};
/**
* Filters language list based on both name and alias properties.
* @param option
* @param rawInput
* @example
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export var languageListFilter = function languageListFilter(option, rawInput) {
// Ignored via go/ees005
// eslint-disable-next-line @typescript-eslint/no-explicit-any
var _ref4 = option,
data = _ref4.data;
var searchString = rawInput.toLowerCase();
return data.label.toLowerCase().includes(searchString) || data.alias.some(function (alias) {
return alias.toLowerCase() === searchString;
});
};