[refactor] Editor code refactoring (#3194)

* removed relative imports from editor core

* Update issue widget file paths and imports to use kebab case instead of camel case, to align with coding conventions and improve consistency.

* Update Tiptap core and extensions versions to 2.1.13 and Tiptap React version to 2.1.13. Update Tiptap table imports to use the new location in package @tiptap/pm/tables. Update AlertLabel component to use the new type definition for LucideIcon.

* updated lock file

* removed default exports from editor/core

* fixed injecting css into the core package itself

* seperated css code to have single source of origin wrt to the package

* removed default imports from document editor

* all instances using index as key while mapping fixed

* Update Lite Text Editor package.json to remove @plane/editor-types as a dependency.

Update Lite Text Editor index.ts to update the import of IMentionSuggestion and IMentionHighlight from @plane/editor-types to @plane/editor-core.

Update Lite Text Editor ui/index.tsx to update the import of UploadImage, DeleteImage, IMentionSuggestion, and RestoreImage from @plane/editor-types to @plane/editor-core.

Update Lite Text Editor ui/menus/fixed-menu/index.tsx to update the import of UploadImage from @plane/editor-types to @plane/editor-core.

Update turbo.json to remove @plane/editor-types#build as a dependency for @plane/lite-text-editor#build, @plane/rich-text-editor#build, and @plane/document-editor#build.

* Remove deprecated import and adjust tippy.js usage in the slash-commands.tsx file of the editor extensions package.

* Update dependencies in `rich-text-editor/package.json`, remove `@plane/editor-types` and add `@plane/editor-core` in `rich-text-editor/src/index.ts`, and update imports in `rich-text-editor/src/ui/extensions/index.tsx` and `rich-text-editor/src/ui/index.tsx` to use `@plane/editor-core` instead of `@plane/editor-types`.

* Update package.json dependencies and add new types for image deletion, upload, restore, mention highlight, mention suggestion, and slash command item.

* Update import statements in various files to use the new package "@plane/editor-core" instead of "@plane/editor-types".

* fixed document editor to follow conventions

* Refactor imports in the Rich Text Editor package to use relative paths instead of absolute paths.

- Updated imports in `index.ts`, `ui/index.tsx`, and `ui/menus/bubble-menu/index.tsx` to use relative paths.
- Updated `tsconfig.json` to include the `baseUrl` compiler option and adjust the `include` and `exclude` paths.

* Refactor Lite Text Editor code to use relative import paths instead of absolute import paths.

* Added LucideIconType to the exports in index.ts for use in other files.
Created a new file lucide-icon.ts which contains the type LucideIconType.
Updated the icon type in HeadingOneItem in menu-items/index.tsx to use LucideIconType.
Updated the Icon type in AlertLabel in alert-label.tsx to use LucideIconType.
Updated the Icon type in VerticalDropdownItemProps in vertical-dropdown-menu.tsx to use LucideIconType.
Updated the Icon type in BubbleMenuItem in fixed-menu/index.tsx to use LucideIconType.
Deleted the file tooltip.tsx since it is no longer used.
Updated the Icon type in BubbleMenuItem in bubble-menu/index.tsx to use LucideIconType.

* ♻️ refactor: simplify rendering logic in slash-commands.tsx

The rendering logic in the file "slash-commands.tsx" has been simplified. Previously, the code used inline positioning for the popup, but it has now been removed. Instead of appending the popup to the document body, it is now appended to the element with the ID "tiptap-container". The "flip" option has also been removed. These changes have improved the readability and maintainability of the code.

* fixed build errors caused due to core's internal imports

* regression: fixed pages not saving issue and not duplicating with proper content issue

* build: Update @tiptap dependencies

Updated the @tiptap dependencies in the package.json files of `document-editor`, `extensions`, and `rich-text-editor` packages to version 2.1.13.

* 🚑 fix: Correct appendTo selector in slash-commands.tsx

Update the `appendTo` function call in `slash-commands.tsx` to use the correct selector `#editor-container` instead of `#tiptap-container`. This ensures that the component is appended to the appropriate container in the editor extension.

Note: The commit message assumes that the change is a fix for an issue or error. If it's not a fix, please provide more context so that an appropriate commit type can be determined.

packages/editor/core/package.json

@@ -28,28 +28,22 @@
     "react-dom": "18.2.0"
   },
   "dependencies": {
-    "@plane/editor-types": "*",
-    "@tiptap/core": "^2.1.7",
+    "@tiptap/core": "^2.1.13",
     "@tiptap/extension-blockquote": "^2.1.13",
-    "@tiptap/extension-code-block-lowlight": "^2.1.12",
-    "@tiptap/extension-color": "^2.1.11",
-    "@tiptap/extension-image": "^2.1.7",
-    "@tiptap/extension-link": "^2.1.7",
-    "@tiptap/extension-list-item": "^2.1.12",
-    "@tiptap/extension-mention": "^2.1.12",
-    "@tiptap/extension-table": "^2.1.6",
-    "@tiptap/extension-table-cell": "^2.1.6",
-    "@tiptap/extension-table-header": "^2.1.6",
-    "@tiptap/extension-table-row": "^2.1.6",
-    "@tiptap/extension-task-item": "^2.1.7",
-    "@tiptap/extension-task-list": "^2.1.7",
-    "@tiptap/extension-text-style": "^2.1.11",
-    "@tiptap/extension-underline": "^2.1.7",
-    "@tiptap/pm": "^2.1.7",
-    "@tiptap/prosemirror-tables": "^1.1.4",
-    "@tiptap/react": "^2.1.7",
-    "@tiptap/starter-kit": "^2.1.10",
-    "@tiptap/suggestion": "^2.0.4",
+    "@tiptap/extension-code-block-lowlight": "^2.1.13",
+    "@tiptap/extension-color": "^2.1.13",
+    "@tiptap/extension-image": "^2.1.13",
+    "@tiptap/extension-link": "^2.1.13",
+    "@tiptap/extension-list-item": "^2.1.13",
+    "@tiptap/extension-mention": "^2.1.13",
+    "@tiptap/extension-task-item": "^2.1.13",
+    "@tiptap/extension-task-list": "^2.1.13",
+    "@tiptap/extension-text-style": "^2.1.13",
+    "@tiptap/extension-underline": "^2.1.13",
+    "@tiptap/pm": "^2.1.13",
+    "@tiptap/react": "^2.1.13",
+    "@tiptap/starter-kit": "^2.1.13",
+    "@tiptap/suggestion": "^2.0.13",
     "class-variance-authority": "^0.7.0",
     "clsx": "^1.2.1",
     "highlight.js": "^11.8.0",

packages/editor/core/src/ui/hooks/use-editor.tsx → packages/editor/core/src/hooks/use-editor.tsx

@@ -1,10 +1,13 @@
 import { useEditor as useCustomEditor, Editor } from "@tiptap/react";
 import { useImperativeHandle, useRef, MutableRefObject } from "react";
-import { CoreEditorProps } from "../props";
-import { CoreEditorExtensions } from "../extensions";
+import { CoreEditorProps } from "src/ui/props";
+import { CoreEditorExtensions } from "src/ui/extensions";
 import { EditorProps } from "@tiptap/pm/view";
-import { getTrimmedHTML } from "../../lib/utils";
-import { DeleteImage, IMentionSuggestion, RestoreImage, UploadImage } from "@plane/editor-types";
+import { getTrimmedHTML } from "src/lib/utils";
+import { DeleteImage } from "src/types/delete-image";
+import { IMentionSuggestion } from "src/types/mention-suggestion";
+import { RestoreImage } from "src/types/restore-image";
+import { UploadImage } from "src/types/upload-image";
 
 interface CustomEditorProps {
   uploadFile: UploadImage;

packages/editor/core/src/ui/hooks/use-read-only-editor.tsx → packages/editor/core/src/hooks/use-read-only-editor.tsx

@@ -1,9 +1,9 @@
 import { useEditor as useCustomEditor, Editor } from "@tiptap/react";
 import { useImperativeHandle, useRef, MutableRefObject } from "react";
-import { CoreReadOnlyEditorExtensions } from "../read-only/extensions";
-import { CoreReadOnlyEditorProps } from "../read-only/props";
+import { CoreReadOnlyEditorExtensions } from "src/ui/read-only/extensions";
+import { CoreReadOnlyEditorProps } from "src/ui/read-only/props";
 import { EditorProps } from "@tiptap/pm/view";
-import { IMentionSuggestion } from "@plane/editor-types";
+import { IMentionSuggestion } from "src/types/mention-suggestion";
 
 interface CustomReadOnlyEditorProps {
   value: string;

packages/editor/core/src/index.ts

@@ -1,23 +1,32 @@
 // styles
 // import "./styles/tailwind.css";
-// import "./styles/editor.css";
-import "./styles/github-dark.css";
+import "src/styles/editor.css";
+import "src/styles/table.css";
+import "src/styles/github-dark.css";
 
-export { isCellSelection } from "./ui/extensions/table/table/utilities/is-cell-selection";
+export { isCellSelection } from "src/ui/extensions/table/table/utilities/is-cell-selection";
 
 // utils
-export * from "./lib/utils";
-export * from "./ui/extensions/table/table";
-export { startImageUpload } from "./ui/plugins/upload-image";
+export * from "src/lib/utils";
+export * from "src/ui/extensions/table/table";
+export { startImageUpload } from "src/ui/plugins/upload-image";
 
 // components
-export { EditorContainer } from "./ui/components/editor-container";
-export { EditorContentWrapper } from "./ui/components/editor-content";
+export { EditorContainer } from "src/ui/components/editor-container";
+export { EditorContentWrapper } from "src/ui/components/editor-content";
 
 // hooks
-export { useEditor } from "./ui/hooks/use-editor";
-export { useReadOnlyEditor } from "./ui/hooks/use-read-only-editor";
+export { useEditor } from "src/hooks/use-editor";
+export { useReadOnlyEditor } from "src/hooks/use-read-only-editor";
 
 // helper items
-export * from "./ui/menus/menu-items";
-export * from "./lib/editor-commands";
+export * from "src/ui/menus/menu-items";
+export * from "src/lib/editor-commands";
+
+// types
+export type { DeleteImage } from "src/types/delete-image";
+export type { UploadImage } from "src/types/upload-image";
+export type { RestoreImage } from "src/types/restore-image";
+export type { IMentionHighlight, IMentionSuggestion } from "src/types/mention-suggestion";
+export type { ISlashCommandItem, CommandProps } from "src/types/slash-commands-suggestion";
+export type { LucideIconType } from "src/types/lucide-icon";

packages/editor/core/src/lib/editor-commands.ts

@@ -1,7 +1,7 @@
-import { UploadImage } from "@plane/editor-types";
 import { Editor, Range } from "@tiptap/core";
-import { startImageUpload } from "../ui/plugins/upload-image";
-import { findTableAncestor } from "./utils";
+import { startImageUpload } from "src/ui/plugins/upload-image";
+import { findTableAncestor } from "src/lib/utils";
+import { UploadImage } from "src/types/upload-image";
 
 export const toggleHeadingOne = (editor: Editor, range?: Range) => {
   if (range) editor.chain().focus().deleteRange(range).setNode("heading", { level: 1 }).run();

packages/editor/core/src/styles/editor.css

@@ -6,6 +6,12 @@
   height: 0;
 }
 
+/* block quotes */
+.ProseMirror blockquote p::before,
+.ProseMirror blockquote p::after {
+  display: none;
+}
+
 .ProseMirror .is-empty::before {
   content: attr(data-placeholder);
   float: left;
@@ -15,7 +21,6 @@
 }
 
 /* Custom image styles */
-
 .ProseMirror img {
   transition: filter 0.1s ease-in-out;
 
@@ -53,11 +58,12 @@ ul[data-type="taskList"] li > label input[type="checkbox"] {
   background-color: rgb(var(--color-background-100));
   margin: 0;
   cursor: pointer;
-  width: 1.2rem;
-  height: 1.2rem;
+  width: 0.8rem;
+  height: 0.8rem;
   position: relative;
-  border: 2px solid rgb(var(--color-text-100));
-  margin-right: 0.3rem;
+  border: 1.5px solid rgb(var(--color-text-100));
+  margin-right: 0.2rem;
+  margin-top: 0.15rem;
   display: grid;
   place-content: center;
 
@@ -71,8 +77,8 @@ ul[data-type="taskList"] li > label input[type="checkbox"] {
 
   &::before {
     content: "";
-    width: 0.65em;
-    height: 0.65em;
+    width: 0.5em;
+    height: 0.5em;
     transform: scale(0);
     transition: 120ms transform ease-in-out;
     box-shadow: inset 1em 1em;
@@ -229,3 +235,34 @@ ul[data-type="taskList"] li[data-checked="true"] > div > p {
 .ProseMirror table * .is-empty::before {
   opacity: 0;
 }
+
+.ProseMirror pre {
+  background: rgba(var(--color-background-80));
+  border-radius: 0.5rem;
+  color: rgba(var(--color-text-100));
+  font-family: "JetBrainsMono", monospace;
+  padding: 0.75rem 1rem;
+}
+
+.ProseMirror pre code {
+  background: none;
+  color: inherit;
+  font-size: 0.8rem;
+  padding: 0;
+}
+
+div[data-type="horizontalRule"] {
+  line-height: 0;
+  padding: 0.25rem 0;
+  margin-top: 0;
+  margin-bottom: 0;
+
+  & > div {
+    border-bottom: 1px solid rgb(var(--color-text-100));
+  }
+}
+
+/* image resizer */
+.moveable-control-box {
+  z-index: 10 !important;
+}

packages/editor/core/src/types/lucide-icon.ts

@@ -0,0 +1,3 @@
+import { Smile } from "lucide-react";
+
+export type LucideIconType = typeof Smile;

packages/editor/core/src/ui/components/editor-content.tsx

@@ -1,6 +1,6 @@
 import { Editor, EditorContent } from "@tiptap/react";
 import { ReactNode } from "react";
-import { ImageResizer } from "../extensions/image/image-resize";
+import { ImageResizer } from "src/ui/extensions/image/image-resize";
 
 interface EditorContentProps {
   editor: Editor | null;

packages/editor/core/src/ui/extensions/custom-list-keymap/list-helpers/get-next-list-depth.ts

@@ -1,7 +1,7 @@
 import { getNodeAtPosition } from "@tiptap/core";
 import { EditorState } from "@tiptap/pm/state";
 
-import { findListItemPos } from "./find-list-item-pos";
+import { findListItemPos } from "src/ui/extensions/custom-list-keymap/list-helpers/find-list-item-pos";
 
 export const getNextListDepth = (typeOrName: string, state: EditorState) => {
   const listItemPos = findListItemPos(typeOrName, state);

packages/editor/core/src/ui/extensions/custom-list-keymap/list-helpers/handle-backspace.ts

@@ -1,8 +1,8 @@
 import { Editor, isAtStartOfNode, isNodeActive } from "@tiptap/core";
 import { Node } from "@tiptap/pm/model";
 
-import { findListItemPos } from "./find-list-item-pos";
-import { hasListBefore } from "./has-list-before";
+import { findListItemPos } from "src/ui/extensions/custom-list-keymap/list-helpers/find-list-item-pos";
+import { hasListBefore } from "src/ui/extensions/custom-list-keymap/list-helpers/has-list-before";
 
 export const handleBackspace = (editor: Editor, name: string, parentListTypes: string[]) => {
   // this is required to still handle the undo handling

packages/editor/core/src/ui/extensions/custom-list-keymap/list-helpers/handle-delete.ts

@@ -1,7 +1,7 @@
 import { Editor, isAtEndOfNode, isNodeActive } from "@tiptap/core";
 
-import { nextListIsDeeper } from "./next-list-is-deeper";
-import { nextListIsHigher } from "./next-list-is-higher";
+import { nextListIsDeeper } from "src/ui/extensions/custom-list-keymap/list-helpers/next-list-is-deeper";
+import { nextListIsHigher } from "src/ui/extensions/custom-list-keymap/list-helpers/next-list-is-higher";
 
 export const handleDelete = (editor: Editor, name: string) => {
   // if the cursor is not inside the current node type

packages/editor/core/src/ui/extensions/custom-list-keymap/list-helpers/next-list-is-deeper.ts

@@ -1,7 +1,7 @@
 import { EditorState } from "@tiptap/pm/state";
 
-import { findListItemPos } from "./find-list-item-pos";
-import { getNextListDepth } from "./get-next-list-depth";
+import { findListItemPos } from "src/ui/extensions/custom-list-keymap/list-helpers/find-list-item-pos";
+import { getNextListDepth } from "src/ui/extensions/custom-list-keymap/list-helpers/get-next-list-depth";
 
 export const nextListIsDeeper = (typeOrName: string, state: EditorState) => {
   const listDepth = getNextListDepth(typeOrName, state);

packages/editor/core/src/ui/extensions/custom-list-keymap/list-helpers/next-list-is-higher.ts

@@ -1,7 +1,7 @@
 import { EditorState } from "@tiptap/pm/state";
 
-import { findListItemPos } from "./find-list-item-pos";
-import { getNextListDepth } from "./get-next-list-depth";
+import { findListItemPos } from "src/ui/extensions/custom-list-keymap/list-helpers/find-list-item-pos";
+import { getNextListDepth } from "src/ui/extensions/custom-list-keymap/list-helpers/get-next-list-depth";
 
 export const nextListIsHigher = (typeOrName: string, state: EditorState) => {
   const listDepth = getNextListDepth(typeOrName, state);

packages/editor/core/src/ui/extensions/custom-list-keymap/list-keymap.ts

@@ -1,6 +1,6 @@
 import { Extension } from "@tiptap/core";
 
-import { handleBackspace, handleDelete } from "./list-helpers";
+import { handleBackspace, handleDelete } from "src/ui/extensions/custom-list-keymap/list-helpers";
 
 export type ListKeymapOptions = {
   listTypes: Array<{

packages/editor/core/src/ui/extensions/horizontal-rule.tsx

@@ -22,7 +22,7 @@ declare module "@tiptap/core" {
   }
 }
 
-export default Node.create<HorizontalRuleOptions>({
+export const HorizontalRule = Node.create<HorizontalRuleOptions>({
   name: "horizontalRule",
 
   addOptions() {

packages/editor/core/src/ui/extensions/image/index.tsx

@@ -1,9 +1,10 @@
 import { EditorState, Plugin, PluginKey, Transaction } from "@tiptap/pm/state";
 import { Node as ProseMirrorNode } from "@tiptap/pm/model";
-import UploadImagesPlugin from "../../plugins/upload-image";
+import { UploadImagesPlugin } from "src/ui/plugins/upload-image";
 import ImageExt from "@tiptap/extension-image";
-import { onNodeDeleted, onNodeRestored } from "../../plugins/delete-image";
-import { DeleteImage, RestoreImage } from "@plane/editor-types";
+import { onNodeDeleted, onNodeRestored } from "src/ui/plugins/delete-image";
+import { DeleteImage } from "src/types/delete-image";
+import { RestoreImage } from "src/types/restore-image";
 
 interface ImageNode extends ProseMirrorNode {
   attrs: {
@@ -15,7 +16,7 @@ interface ImageNode extends ProseMirrorNode {
 const deleteKey = new PluginKey("delete-image");
 const IMAGE_NODE_TYPE = "image";
 
-const ImageExtension = (deleteImage: DeleteImage, restoreFile: RestoreImage, cancelUploadImage?: () => any) =>
+export const ImageExtension = (deleteImage: DeleteImage, restoreFile: RestoreImage, cancelUploadImage?: () => any) =>
   ImageExt.extend({
     addProseMirrorPlugins() {
       return [
@@ -130,5 +131,3 @@ const ImageExtension = (deleteImage: DeleteImage, restoreFile: RestoreImage, can
       };
     },
   });
-
-export default ImageExtension;

packages/editor/core/src/ui/extensions/image/read-only-image.tsx

@@ -1,6 +1,6 @@
 import Image from "@tiptap/extension-image";
 
-const ReadOnlyImageExtension = Image.extend({
+export const ReadOnlyImageExtension = Image.extend({
   addAttributes() {
     return {
       ...this.parent?.(),
@@ -13,5 +13,3 @@ const ReadOnlyImageExtension = Image.extend({
     };
   },
 });
-
-export default ReadOnlyImageExtension;

packages/editor/core/src/ui/extensions/index.tsx

@@ -7,22 +7,25 @@ import TaskItem from "@tiptap/extension-task-item";
 import TaskList from "@tiptap/extension-task-list";
 import { Markdown } from "tiptap-markdown";
 
-import TableHeader from "./table/table-header/table-header";
-import Table from "./table/table";
-import TableCell from "./table/table-cell/table-cell";
-import TableRow from "./table/table-row/table-row";
-import HorizontalRule from "./horizontal-rule";
+import { TableHeader } from "src/ui/extensions/table/table-header/table-header";
+import { Table } from "src/ui/extensions/table/table";
+import { TableCell } from "src/ui/extensions/table/table-cell/table-cell";
+import { TableRow } from "src/ui/extensions/table/table-row/table-row";
+import { HorizontalRule } from "src/ui/extensions/horizontal-rule";
 
-import ImageExtension from "./image";
+import { ImageExtension } from "src/ui/extensions/image";
 
-import { isValidHttpUrl } from "../../lib/utils";
-import { Mentions } from "../mentions";
+import { isValidHttpUrl } from "src/lib/utils";
+import { Mentions } from "src/ui/mentions";
 
-import { CustomKeymap } from "./keymap";
-import { CustomCodeBlock } from "./code";
-import { CustomQuoteExtension } from "./quote";
-import { ListKeymap } from "./custom-list-keymap";
-import { IMentionSuggestion, DeleteImage, RestoreImage } from "@plane/editor-types";
+import { CustomKeymap } from "src/ui/extensions/keymap";
+import { CustomCodeBlock } from "src/ui/extensions/code";
+import { CustomQuoteExtension } from "src/ui/extensions/quote";
+import { ListKeymap } from "src/ui/extensions/custom-list-keymap";
+
+import { DeleteImage } from "src/types/delete-image";
+import { IMentionSuggestion } from "src/types/mention-suggestion";
+import { RestoreImage } from "src/types/restore-image";
 
 export const CoreEditorExtensions = (
   mentionConfig: {

packages/editor/core/src/ui/extensions/table/table-cell/index.ts

@@ -1 +1 @@
-export { default as default } from "./table-cell";
+export { TableCell } from "./table-cell";

packages/editor/core/src/ui/extensions/table/table-cell/table-cell.ts

@@ -4,7 +4,7 @@ export interface TableCellOptions {
   HTMLAttributes: Record<string, any>;
 }
 
-export default Node.create<TableCellOptions>({
+export const TableCell = Node.create<TableCellOptions>({
   name: "tableCell",
 
   addOptions() {

packages/editor/core/src/ui/extensions/table/table-header/index.ts

@@ -1 +1 @@
-export { default as default } from "./table-header";
+export { TableHeader } from "./table-header";