Skip to content

@/RoboShield: Migrate rich text editor from Slate to Lexical #1122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
May 8, 2025
Merged

@/RoboShield: Migrate rich text editor from Slate to Lexical #1122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
ca4dcd8
Add richtext-lexical package
m453h Apr 24, 2025
106563f
Add lexical editor with default configs
m453h Apr 24, 2025
bd69b30
Add data migration
m453h Apr 25, 2025
19d0a41
Implement recommended Richtext parser from Lexical editor
m453h May 2, 2025
9c99abf
Add typography props for components
m453h May 2, 2025
52ac7f8
Correct TypeScript type mismatches
m453h May 2, 2025
e506700
Fix formatting issues
m453h May 2, 2025
48793b9
Improve component naming convention
m453h May 5, 2025
7b02970
Rename payload migration to include descriptive name
m453h May 5, 2025
0d3b59f
Remove defaulting to h1 as heading type in styleConvertor
m453h May 5, 2025
4af755a
Add note on SlateToLexicalFeature
m453h May 6, 2025
eaa0ebe
Set link props text color to text.secondary
m453h May 6, 2025
dde48a1
Allow description hero text to use flexible font variants
m453h May 6, 2025
244c9d9
Fix formatting issues on generated payload types and importMap
m453h May 6, 2025
a648cde
Remove condition to process links in styleConvertor
m453h May 6, 2025
b2fbfa8
Refractor styleconverter function
m453h May 6, 2025
47960e5
Fix formatting issues
m453h May 6, 2025
bfb0081
Add to TODO note on plan to remove SlateToLexicalFeature
m453h May 6, 2025
3fd879f
Merge main into ft/migrate_to_lexical_rich_text_editor
m453h May 8, 2025
06f384d
Merge branch 'main' into ft/migrate_to_lexical_rich_text_editor
m453h May 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions apps/roboshield/migrations/20250425_082829_slate_to_lexical.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import { MigrateDownArgs, MigrateUpArgs } from "@payloadcms/db-mongodb";
import { migrateSlateToLexical } from "@payloadcms/richtext-lexical/migrate";

export async function up({
payload,
req,
session,
}: MigrateUpArgs): Promise<void> {
payload.logger.info(`Starting slate to lexical migration process...`);
await migrateSlateToLexical({ payload });
}

export async function down({
payload,
req,
session,
}: MigrateDownArgs): Promise<void> {
// Migration code
}
6 changes: 6 additions & 0 deletions apps/roboshield/migrations/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
import * as migration_20250422_064614_migration from "./20250422_064614_migration";
import * as migration_20250425_082829_slate_to_lexical from "./20250425_082829_slate_to_lexical";

export const migrations = [
{
up: migration_20250422_064614_migration.up,
down: migration_20250422_064614_migration.down,
name: "20250422_064614_migration",
},
{
up: migration_20250425_082829_slate_to_lexical.up,
down: migration_20250425_082829_slate_to_lexical.down,
name: "20250425_082829_slate_to_lexical",
},
];
4 changes: 2 additions & 2 deletions apps/roboshield/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@
"@next/env": "catalog:",
"@next/third-parties": "catalog:",
"@payloadcms/db-mongodb": "catalog:payload-v3",
"@payloadcms/email-nodemailer": "catalog:payload-v3",
"@payloadcms/live-preview-react": "catalog:payload-v3",
"@payloadcms/next": "catalog:payload-v3",
"@payloadcms/plugin-cloud-storage": "catalog:payload-v3",
"@payloadcms/plugin-nested-docs": "catalog:payload-v3",
"@payloadcms/plugin-sentry": "catalog:payload-v3",
"@payloadcms/plugin-seo": "catalog:payload-v3",
"@payloadcms/richtext-slate": "catalog:payload-v3",
"@payloadcms/richtext-lexical": "catalog:payload-v3",
"@payloadcms/storage-s3": "catalog:payload-v3",
"@payloadcms/email-nodemailer": "catalog:payload-v3",
"@payloadcms/ui": "catalog:payload-v3",
"@sentry/nextjs": "catalog:",
"ace-builds": "catalog:",
Expand Down
234 changes: 205 additions & 29 deletions apps/roboshield/payload-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,27 @@ export interface Page {
| (
| {
content: {
root: {
type: string;
children: {
type: string;
version: number;
[k: string]: unknown;
}[];
direction: ("ltr" | "rtl") | null;
format:
| "left"
| "start"
| "center"
| "right"
| "end"
| "justify"
| "";
indent: number;
version: number;
};
[k: string]: unknown;
}[];
};
id?: string | null;
blockName?: string | null;
blockType: "richtext";
Expand Down Expand Up @@ -204,8 +223,27 @@ export interface Page {
name: string;
value: string;
description: {
root: {
type: string;
children: {
type: string;
version: number;
[k: string]: unknown;
}[];
direction: ("ltr" | "rtl") | null;
format:
| "left"
| "start"
| "center"
| "right"
| "end"
| "justify"
| "";
indent: number;
version: number;
};
[k: string]: unknown;
}[];
};
/**
* An icon to represent this statistic. SVG format is recommended.
*/
Expand All @@ -222,11 +260,28 @@ export interface Page {
| (
| {
title: string;
hint?:
| {
hint?: {
root: {
type: string;
children: {
type: string;
version: number;
[k: string]: unknown;
}[]
| null;
}[];
direction: ("ltr" | "rtl") | null;
format:
| "left"
| "start"
| "center"
| "right"
| "end"
| "justify"
| "";
indent: number;
version: number;
};
[k: string]: unknown;
} | null;
defaultFetchExistingRobots?: boolean | null;
existingRobotsTxt: string;
placeholder: string;
Expand All @@ -238,11 +293,28 @@ export interface Page {
}
| {
title: string;
hint?:
| {
hint?: {
root: {
type: string;
children: {
type: string;
version: number;
[k: string]: unknown;
}[]
| null;
}[];
direction: ("ltr" | "rtl") | null;
format:
| "left"
| "start"
| "center"
| "right"
| "end"
| "justify"
| "";
indent: number;
version: number;
};
[k: string]: unknown;
} | null;
crawlDelay: {
label: string;
title: string;
Expand All @@ -261,11 +333,28 @@ export interface Page {
}
| {
title: string;
hint?:
| {
hint?: {
root: {
type: string;
children: {
type: string;
version: number;
[k: string]: unknown;
}[]
| null;
}[];
direction: ("ltr" | "rtl") | null;
format:
| "left"
| "start"
| "center"
| "right"
| "end"
| "justify"
| "";
indent: number;
version: number;
};
[k: string]: unknown;
} | null;
selectPlatform: {
label: string;
title: string;
Expand All @@ -284,11 +373,28 @@ export interface Page {
}
| {
title: string;
hint?:
| {
hint?: {
root: {
type: string;
children: {
type: string;
version: number;
[k: string]: unknown;
}[]
| null;
}[];
direction: ("ltr" | "rtl") | null;
format:
| "left"
| "start"
| "center"
| "right"
| "end"
| "justify"
| "";
indent: number;
version: number;
};
[k: string]: unknown;
} | null;
aiWebCrawlers: {
label: string;
title: string;
Expand All @@ -303,23 +409,57 @@ export interface Page {
}
| {
title: string;
hint?:
| {
hint?: {
root: {
type: string;
children: {
type: string;
version: number;
[k: string]: unknown;
}[]
| null;
}[];
direction: ("ltr" | "rtl") | null;
format:
| "left"
| "start"
| "center"
| "right"
| "end"
| "justify"
| "";
indent: number;
version: number;
};
[k: string]: unknown;
} | null;
placeholder: string;
id?: string | null;
blockName?: string | null;
blockType: "site-maps";
}
| {
title: string;
hint?:
| {
hint?: {
root: {
type: string;
children: {
type: string;
version: number;
[k: string]: unknown;
}[]
| null;
}[];
direction: ("ltr" | "rtl") | null;
format:
| "left"
| "start"
| "center"
| "right"
| "end"
| "justify"
| "";
indent: number;
version: number;
};
[k: string]: unknown;
} | null;
placeholder: string;
id?: string | null;
blockName?: string | null;
Expand Down Expand Up @@ -379,8 +519,20 @@ export interface SiteHero {
}[]
| null;
heroDescription: {
root: {
type: string;
children: {
type: string;
version: number;
[k: string]: unknown;
}[];
direction: ("ltr" | "rtl") | null;
format: "left" | "start" | "center" | "right" | "end" | "justify" | "";
indent: number;
version: number;
};
[k: string]: unknown;
}[];
};
heroCallToAction?: string | null;
id?: string | null;
blockName?: string | null;
Expand Down Expand Up @@ -783,8 +935,20 @@ export interface SettingsSite {
id: string;
title: string;
description: {
root: {
type: string;
children: {
type: string;
version: number;
[k: string]: unknown;
}[];
direction: ("ltr" | "rtl") | null;
format: "left" | "start" | "center" | "right" | "end" | "justify" | "";
indent: number;
version: number;
};
[k: string]: unknown;
}[];
};
/**
* Shown on main navigation bar.
*/
Expand Down Expand Up @@ -855,8 +1019,20 @@ export interface SettingsSite {
initiative: {
title: string;
description: {
root: {
type: string;
children: {
type: string;
version: number;
[k: string]: unknown;
}[];
direction: ("ltr" | "rtl") | null;
format: "left" | "start" | "center" | "right" | "end" | "justify" | "";
indent: number;
version: number;
};
[k: string]: unknown;
}[];
};
partners?:
| {
name: string;
Expand Down
Loading
Loading