migrate plate versions; better link support (#142)

- migrate (many versions) to latest plate and slate versions - extensive refactor to support plate changes - add tailwind and numerous required dependencies to achieve parity with prior implementation - improve link support; default plate version includes a hovering link edit menu similar to my prior link edit menu - remove most of the custom image helpers (prefer plate versions) - remove custom link plugin (prefer plate version)
cloverich · Jan 27, 2024 · 8b503c9 · 8b503c9
1 parent f9d4b94
commit 8b503c9
Show file tree

Hide file tree

Showing 46 changed files with 3,744 additions and 2,230 deletions.
diff --git a/.gitignore b/.gitignore
@@ -16,4 +16,6 @@ packaged/
 
 # bundler (dev) outputs .bundle files
 # along-side src files, used during development
-*.bundle.*
+*.bundle.*
+# eh, if its index.bundle.css, the ts import fails, shrug
+index-compiled.css
diff --git a/package.json b/package.json
@@ -4,11 +4,14 @@
   "main": "main.bundle.js",
   "license": "UNLICENSED",
   "scripts": {
+    "build": "./build.sh",
     "lint": "yarn run lint:prettier:check && yarn run lint:types:check",
     "lint:prettier:check": "prettier . --check",
     "lint:prettier:write": "prettier . --write",
     "lint:types:check": "tsc --noEmit --skipLibCheck",
     "postinstall": "yarn run electron-rebuild",
+    "prestart": "tailwindcss -i ./src/index.css -o ./src/index-compiled.css",
+    "prebuild": "tailwindcss -i ./src/index.css -o ./src/index-compiled.css",
     "start": "node ./scripts/dev.js",
     "test": "mocha -r esm -r ts-node/register src/**/*.test.ts",
     "test:one": "mocha -r ts-node/register -r esm"
@@ -25,6 +28,11 @@
   "devDependencies": {
     "@electron/packager": "^18.1.3",
     "@electron/rebuild": "^3.4.1",
+    "@radix-ui/react-popover": "^1.0.7",
+    "@radix-ui/react-separator": "^1.0.3",
+    "@radix-ui/react-slot": "^1.0.2",
+    "@radix-ui/react-toolbar": "^1.0.4",
+    "@radix-ui/react-tooltip": "^1.0.7",
     "@types/better-sqlite3": "^5.4.0",
     "@types/chai": "^4.2.11",
     "@types/klaw": "^3.0.1",
@@ -34,9 +42,12 @@
     "@types/react": "^18.2.48",
     "@types/react-dom": "^18.2.18",
     "@types/rehype-react": "^4.0.0",
-    "@udecode/plate": "^6.0.0",
+    "@udecode/cn": "^29.0.1",
+    "@udecode/plate": "^30.1.2",
+    "@udecode/plate-caption": "^30.1.2",
     "chai": "^4.2.0",
     "chai-json-schema-ajv": "^5.2.4",
+    "class-variance-authority": "^0.7.0",
     "date-fns": "^2.28.0",
     "electron": "^28.1.4",
     "emotion": "^10.0.27",
@@ -45,6 +56,7 @@
     "evergreen-ui": "^7.1.9",
     "klaw": "^3.0.0",
     "lodash": "^4.17.21",
+    "lucide-react": "^0.314.0",
     "luxon": "^1.24.1",
     "mobx": "^5.15.4",
     "mobx-react-lite": "^2.0.7",
@@ -59,15 +71,17 @@
     "remark-gfm": "^3.0.0",
     "remark-parse": "^8.0.3",
     "remark-rehype": "^10.0.0",
-    "remark-slate-transformer": "^0.4.1",
     "remark-stringify": "^8.1.1",
     "remark-unwrap-images": "^3.0.0",
-    "slate": "^0.66.5",
-    "slate-history": "^0.66.0",
-    "slate-hyperscript": "^0.66.0",
-    "slate-react": "^0.66.7",
+    "slate": "^0.101.5",
+    "slate-history": "^0.100.0",
+    "slate-hyperscript": "^0.100.0",
+    "slate-react": "^0.101.5",
     "source-map-loader": "^1.0.0",
     "styled-components": "^5.3.1",
+    "tailwind-merge": "^2.2.1",
+    "tailwindcss": "^3.4.1",
+    "tailwindcss-animate": "^1.0.7",
     "ts-mdast": "^1.0.0",
     "ts-node": "^10.3.0",
     "typescript": "^5.3.3",

diff --git a/src/components/icons.tsx b/src/components/icons.tsx
@@ -0,0 +1,265 @@
+// NOTE: We also have the evergreen-ui Icons, which is what we use in the app
+// These were added to support latest plate versions, which use Lucide
+// icons in all their components. Will either prefer these throughou,
+// or migrate the plate icons to use evergreens
+// https://platejs.org/docs/components/installation/manual
+import React from "react";
+import { cva } from "class-variance-authority";
+import {
+  AlignCenter,
+  AlignJustify,
+  AlignLeft,
+  AlignRight,
+  Baseline,
+  Bold,
+  Check,
+  ChevronDown,
+  ChevronRight,
+  ChevronsUpDown,
+  Code2,
+  Combine,
+  Edit2,
+  ExternalLink,
+  Eye,
+  FileCode,
+  GripVertical,
+  Heading1,
+  Heading2,
+  Heading3,
+  Heading4,
+  Heading5,
+  Heading6,
+  Image,
+  Indent,
+  Italic,
+  Keyboard,
+  Link2,
+  Link2Off,
+  List,
+  ListOrdered,
+  LucideProps,
+  MessageSquare,
+  MessageSquarePlus,
+  Minus,
+  Moon,
+  MoreHorizontal,
+  Outdent,
+  PaintBucket,
+  Pilcrow,
+  Plus,
+  Quote,
+  RectangleHorizontal,
+  RectangleVertical,
+  RotateCcw,
+  Search,
+  Settings,
+  Smile,
+  Strikethrough,
+  Subscript,
+  SunMedium,
+  Superscript,
+  Table,
+  Text,
+  Trash,
+  Twitter,
+  Underline,
+  Ungroup,
+  WrapText,
+  X,
+} from "lucide-react";
+
+import type { LucideIcon } from "lucide-react";
+
+export type Icon = LucideIcon;
+
+const borderAll = (props: LucideProps) => (
+  <svg
+    viewBox="0 0 24 24"
+    height="48"
+    width="48"
+    focusable="false"
+    role="img"
+    fill="currentColor"
+    xmlns="http://www.w3.org/2000/svg"
+    {...props}
+  >
+    <path d="M3 6a3 3 0 0 1 3-3h12a3 3 0 0 1 3 3v12a3 3 0 0 1-3 3H6a3 3 0 0 1-3-3V6zm10 13h5a1 1 0 0 0 1-1v-5h-6v6zm-2-6H5v5a1 1 0 0 0 1 1h5v-6zm2-2h6V6a1 1 0 0 0-1-1h-5v6zm-2-6H6a1 1 0 0 0-1 1v5h6V5z" />
+  </svg>
+);
+
+const borderBottom = (props: LucideProps) => (
+  <svg
+    viewBox="0 0 24 24"
+    height="48"
+    width="48"
+    focusable="false"
+    role="img"
+    fill="currentColor"
+    xmlns="http://www.w3.org/2000/svg"
+    {...props}
+  >
+    <path d="M13 5a1 1 0 1 0 0-2h-2a1 1 0 1 0 0 2h2zm-8 6a1 1 0 1 0-2 0v2a1 1 0 1 0 2 0v-2zm-2 7a1 1 0 1 1 2 0 1 1 0 0 0 1 1h12a1 1 0 0 0 1-1 1 1 0 1 1 2 0 3 3 0 0 1-3 3H6a3 3 0 0 1-3-3zm17-8a1 1 0 0 0-1 1v2a1 1 0 1 0 2 0v-2a1 1 0 0 0-1-1zM7 4a1 1 0 0 0-1-1 3 3 0 0 0-3 3 1 1 0 0 0 2 0 1 1 0 0 1 1-1 1 1 0 0 0 1-1zm11-1a1 1 0 1 0 0 2 1 1 0 0 1 1 1 1 1 0 1 0 2 0 3 3 0 0 0-3-3z" />
+  </svg>
+);
+
+const borderLeft = (props: LucideProps) => (
+  <svg
+    viewBox="0 0 24 24"
+    height="48"
+    width="48"
+    focusable="false"
+    role="img"
+    fill="currentColor"
+    xmlns="http://www.w3.org/2000/svg"
+    {...props}
+  >
+    <path d="M6 21a1 1 0 1 0 0-2 1 1 0 0 1-1-1V6a1 1 0 0 1 1-1 1 1 0 0 0 0-2 3 3 0 0 0-3 3v12a3 3 0 0 0 3 3zm7-16a1 1 0 1 0 0-2h-2a1 1 0 1 0 0 2h2zm6 6a1 1 0 1 1 2 0v2a1 1 0 1 1-2 0v-2zm-5 9a1 1 0 0 1-1 1h-2a1 1 0 1 1 0-2h2a1 1 0 0 1 1 1zm4-17a1 1 0 1 0 0 2 1 1 0 0 1 1 1 1 1 0 1 0 2 0 3 3 0 0 0-3-3zm-1 17a1 1 0 0 0 1 1 3 3 0 0 0 3-3 1 1 0 1 0-2 0 1 1 0 0 1-1 1 1 1 0 0 0-1 1z" />
+  </svg>
+);
+
+const borderNone = (props: LucideProps) => (
+  <svg
+    viewBox="0 0 24 24"
+    height="48"
+    width="48"
+    focusable="false"
+    role="img"
+    fill="currentColor"
+    xmlns="http://www.w3.org/2000/svg"
+    {...props}
+  >
+    <path d="M14 4a1 1 0 0 1-1 1h-2a1 1 0 1 1 0-2h2a1 1 0 0 1 1 1zm-9 7a1 1 0 1 0-2 0v2a1 1 0 1 0 2 0v-2zm14 0a1 1 0 1 1 2 0v2a1 1 0 1 1-2 0v-2zm-6 10a1 1 0 1 0 0-2h-2a1 1 0 1 0 0 2h2zM7 4a1 1 0 0 0-1-1 3 3 0 0 0-3 3 1 1 0 0 0 2 0 1 1 0 0 1 1-1 1 1 0 0 0 1-1zm11-1a1 1 0 1 0 0 2 1 1 0 0 1 1 1 1 1 0 1 0 2 0 3 3 0 0 0-3-3zM7 20a1 1 0 0 1-1 1 3 3 0 0 1-3-3 1 1 0 1 1 2 0 1 1 0 0 0 1 1 1 1 0 0 1 1 1zm11 1a1 1 0 1 1 0-2 1 1 0 0 0 1-1 1 1 0 1 1 2 0 3 3 0 0 1-3 3z" />
+  </svg>
+);
+
+const borderRight = (props: LucideProps) => (
+  <svg
+    viewBox="0 0 24 24"
+    height="48"
+    width="48"
+    focusable="false"
+    role="img"
+    fill="currentColor"
+    xmlns="http://www.w3.org/2000/svg"
+    {...props}
+  >
+    <path d="M13 5a1 1 0 1 0 0-2h-2a1 1 0 1 0 0 2h2zm-8 6a1 1 0 1 0-2 0v2a1 1 0 1 0 2 0v-2zm9 9a1 1 0 0 1-1 1h-2a1 1 0 1 1 0-2h2a1 1 0 0 1 1 1zM6 3a1 1 0 0 1 0 2 1 1 0 0 0-1 1 1 1 0 0 1-2 0 3 3 0 0 1 3-3zm1 17a1 1 0 0 1-1 1 3 3 0 0 1-3-3 1 1 0 1 1 2 0 1 1 0 0 0 1 1 1 1 0 0 1 1 1zm11 1a1 1 0 1 1 0-2 1 1 0 0 0 1-1V6a1 1 0 0 0-1-1 1 1 0 1 1 0-2 3 3 0 0 1 3 3v12a3 3 0 0 1-3 3z" />
+  </svg>
+);
+
+const borderTop = (props: LucideProps) => (
+  <svg
+    viewBox="0 0 24 24"
+    height="48"
+    width="48"
+    focusable="false"
+    role="img"
+    fill="currentColor"
+    xmlns="http://www.w3.org/2000/svg"
+    {...props}
+  >
+    <path d="M3 6a1 1 0 0 0 2 0 1 1 0 0 1 1-1h12a1 1 0 0 1 1 1 1 1 0 1 0 2 0 3 3 0 0 0-3-3H6a3 3 0 0 0-3 3zm2 5a1 1 0 1 0-2 0v2a1 1 0 1 0 2 0v-2zm14 0a1 1 0 1 1 2 0v2a1 1 0 1 1-2 0v-2zm-5 9a1 1 0 0 1-1 1h-2a1 1 0 1 1 0-2h2a1 1 0 0 1 1 1zm-8 1a1 1 0 1 0 0-2 1 1 0 0 1-1-1 1 1 0 1 0-2 0 3 3 0 0 0 3 3zm11-1a1 1 0 0 0 1 1 3 3 0 0 0 3-3 1 1 0 1 0-2 0 1 1 0 0 1-1 1 1 1 0 0 0-1 1z" />
+  </svg>
+);
+
+export const Icons = {
+  add: Plus,
+  alignCenter: AlignCenter,
+  alignJustify: AlignJustify,
+  alignLeft: AlignLeft,
+  alignRight: AlignRight,
+  arrowDown: ChevronDown,
+  bg: PaintBucket,
+  blockquote: Quote,
+  bold: Bold,
+  borderAll,
+  borderBottom,
+  borderLeft,
+  borderNone,
+  borderRight,
+  borderTop,
+  check: Check,
+  chevronRight: ChevronRight,
+  chevronsUpDown: ChevronsUpDown,
+  clear: X,
+  close: X,
+  code: Code2,
+  codeblock: FileCode,
+  color: Baseline,
+  column: RectangleVertical,
+  combine: Combine,
+  ungroup: Ungroup,
+  comment: MessageSquare,
+  commentAdd: MessageSquarePlus,
+  delete: Trash,
+  dragHandle: GripVertical,
+  editing: Edit2,
+  emoji: Smile,
+  externalLink: ExternalLink,
+  h1: Heading1,
+  h2: Heading2,
+  h3: Heading3,
+  h4: Heading4,
+  h5: Heading5,
+  h6: Heading6,
+  image: Image,
+  indent: Indent,
+  italic: Italic,
+  kbd: Keyboard,
+  lineHeight: WrapText,
+  link: Link2,
+  minus: Minus,
+  more: MoreHorizontal,
+  ol: ListOrdered,
+  outdent: Outdent,
+  paragraph: Pilcrow,
+  refresh: RotateCcw,
+  row: RectangleHorizontal,
+  search: Search,
+  settings: Settings,
+  strikethrough: Strikethrough,
+  subscript: Subscript,
+  superscript: Superscript,
+  table: Table,
+  text: Text,
+  trash: Trash,
+  ul: List,
+  underline: Underline,
+  unlink: Link2Off,
+  viewing: Eye,
+
+  // www
+  gitHub: (props: LucideProps) => (
+    <svg viewBox="0 0 438.549 438.549" {...props}>
+      <path
+        fill="currentColor"
+        d="M409.132 114.573c-19.608-33.596-46.205-60.194-79.798-79.8-33.598-19.607-70.277-29.408-110.063-29.408-39.781 0-76.472 9.804-110.063 29.408-33.596 19.605-60.192 46.204-79.8 79.8C9.803 148.168 0 184.854 0 224.63c0 47.78 13.94 90.745 41.827 128.906 27.884 38.164 63.906 64.572 108.063 79.227 5.14.954 8.945.283 11.419-1.996 2.475-2.282 3.711-5.14 3.711-8.562 0-.571-.049-5.708-.144-15.417a2549.81 2549.81 0 01-.144-25.406l-6.567 1.136c-4.187.767-9.469 1.092-15.846 1-6.374-.089-12.991-.757-19.842-1.999-6.854-1.231-13.229-4.086-19.13-8.559-5.898-4.473-10.085-10.328-12.56-17.556l-2.855-6.57c-1.903-4.374-4.899-9.233-8.992-14.559-4.093-5.331-8.232-8.945-12.419-10.848l-1.999-1.431c-1.332-.951-2.568-2.098-3.711-3.429-1.142-1.331-1.997-2.663-2.568-3.997-.572-1.335-.098-2.43 1.427-3.289 1.525-.859 4.281-1.276 8.28-1.276l5.708.853c3.807.763 8.516 3.042 14.133 6.851 5.614 3.806 10.229 8.754 13.846 14.842 4.38 7.806 9.657 13.754 15.846 17.847 6.184 4.093 12.419 6.136 18.699 6.136 6.28 0 11.704-.476 16.274-1.423 4.565-.952 8.848-2.383 12.847-4.285 1.713-12.758 6.377-22.559 13.988-29.41-10.848-1.14-20.601-2.857-29.264-5.14-8.658-2.286-17.605-5.996-26.835-11.14-9.235-5.137-16.896-11.516-22.985-19.126-6.09-7.614-11.088-17.61-14.987-29.979-3.901-12.374-5.852-26.648-5.852-42.826 0-23.035 7.52-42.637 22.557-58.817-7.044-17.318-6.379-36.732 1.997-58.24 5.52-1.715 13.706-.428 24.554 3.853 10.85 4.283 18.794 7.952 23.84 10.994 5.046 3.041 9.089 5.618 12.135 7.708 17.705-4.947 35.976-7.421 54.818-7.421s37.117 2.474 54.823 7.421l10.849-6.849c7.419-4.57 16.18-8.758 26.262-12.565 10.088-3.805 17.802-4.853 23.134-3.138 8.562 21.509 9.325 40.922 2.279 58.24 15.036 16.18 22.559 35.787 22.559 58.817 0 16.178-1.958 30.497-5.853 42.966-3.9 12.471-8.941 22.457-15.125 29.979-6.191 7.521-13.901 13.85-23.131 18.986-9.232 5.14-18.182 8.85-26.84 11.136-8.662 2.286-18.415 4.004-29.263 5.146 9.894 8.562 14.842 22.077 14.842 40.539v60.237c0 3.422 1.19 6.279 3.572 8.562 2.379 2.279 6.136 2.95 11.276 1.995 44.163-14.653 80.185-41.062 108.068-79.226 27.88-38.161 41.825-81.126 41.825-128.906-.01-39.771-9.818-76.454-29.414-110.049z"
+      ></path>
+    </svg>
+  ),
+  logo: (props: LucideProps) => (
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" {...props}>
+      <path
+        fill="currentColor"
+        d="M11.572 0c-.176 0-.31.001-.358.007a19.76 19.76 0 0 1-.364.033C7.443.346 4.25 2.185 2.228 5.012a11.875 11.875 0 0 0-2.119 5.243c-.096.659-.108.854-.108 1.747s.012 1.089.108 1.748c.652 4.506 3.86 8.292 8.209 9.695.779.25 1.6.422 2.534.525.363.04 1.935.04 2.299 0 1.611-.178 2.977-.577 4.323-1.264.207-.106.247-.134.219-.158-.02-.013-.9-1.193-1.955-2.62l-1.919-2.592-2.404-3.558a338.739 338.739 0 0 0-2.422-3.556c-.009-.002-.018 1.579-.023 3.51-.007 3.38-.01 3.515-.052 3.595a.426.426 0 0 1-.206.214c-.075.037-.14.044-.495.044H7.81l-.108-.068a.438.438 0 0 1-.157-.171l-.05-.106.006-4.703.007-4.705.072-.092a.645.645 0 0 1 .174-.143c.096-.047.134-.051.54-.051.478 0 .558.018.682.154.035.038 1.337 1.999 2.895 4.361a10760.433 10760.433 0 0 0 4.735 7.17l1.9 2.879.096-.063a12.317 12.317 0 0 0 2.466-2.163 11.944 11.944 0 0 0 2.824-6.134c.096-.66.108-.854.108-1.748 0-.893-.012-1.088-.108-1.747-.652-4.506-3.859-8.292-8.208-9.695a12.597 12.597 0 0 0-2.499-.523A33.119 33.119 0 0 0 11.573 0zm4.069 7.217c.347 0 .408.005.486.047a.473.473 0 0 1 .237.277c.018.06.023 1.365.018 4.304l-.006 4.218-.744-1.14-.746-1.14v-3.066c0-1.982.01-3.097.023-3.15a.478.478 0 0 1 .233-.296c.096-.05.13-.054.5-.054z"
+      />
+    </svg>
+  ),
+  moon: Moon,
+  sun: SunMedium,
+  twitter: Twitter,
+};
+
+export const iconVariants = cva("", {
+  variants: {
+    variant: {
+      toolbar: "h-5 w-5",
+      menuItem: "mr-2 h-5 w-5",
+    },
+    size: {
+      sm: "mr-2 h-4 w-4",
+      md: "mr-2 h-6 w-6",
+    },
+  },
+  defaultVariants: {},
+});