Commit 4a9a8e7
committed
[lexical] Refactor: Port node classes to the $config() protocol
## Description
Node classes have historically declared boilerplate static methods
(`getType`, `clone`, `importJSON`, `importDOM`) that `getStaticNodeConfig`
already synthesizes at runtime from a single `$config()` instance method. This
ports the remaining node classes to `$config()` and removes the now-redundant
statics, moving each node's `importDOM` map into the `$config` `importDOM`
option while leaving `updateFromJSON`/`exportJSON`/`createDOM`/`updateDOM`
in place. (It intentionally does not adopt the separate JSON-schema
serialization work — serialization methods are unchanged.)
Ported across `lexical` (TextNode, TabNode, LineBreakNode, ParagraphNode,
RootNode, ArtificialNode), `@lexical/rich-text` (Heading, Quote),
`@lexical/link` (Link, AutoLink), `@lexical/mark`, `@lexical/hashtag`,
`@lexical/table` (Table, Row, Cell), `@lexical/code` (CodeNode,
CodeHighlightNode), `@lexical/react` and `@lexical/extension` HorizontalRule,
the playground nodes, and the examples. Decorator nodes whose constructors
take required arguments keep a minimal `clone`/`importJSON` (they must
construct with arguments). The base `LexicalNode` and the test fixtures that
exist to verify the legacy static-method path are left as-is.
Core changes:
- Abstract base classes have no concrete node `type`, so they can now declare
configuration shared with their subclasses (e.g. a `$transform` or required
state) under a well-known `Symbol.for(<ClassName>)` key, which
`getStaticNodeConfig` resolves via `Object.getOwnPropertySymbols`.
`BaseStaticNodeConfig` is a single mapped type over `string | symbol`, and
`StaticNodeConfigValue`'s `Type` parameter is widened to `string | symbol`
(a symbol-keyed config never populates the string `type` field).
- `TabNode` adds no public surface over `TextNode`, so dropping its statics
made the two structurally identical and collapsed `$isTabNode()` narrowing
to `never`. It is kept nominally distinct by refining its always-false
`canInsertTextBefore()`/`canInsertTextAfter()` to the `false` literal type —
a truthful refinement rather than a phantom brand, and without
re-introducing `declare ['constructor']`.
- Nodes relying on the synthesized `clone` need a zero-argument constructor, so
key-only/leading parameters were given explicit defaults (or redundant
pure-delegation constructors were removed) so `Node.length === 0`.
- Fixed code that relied on `TextNode` being assignable to `TabNode`:
`$getFirstCodeNodeOfLine` is now generic over its anchor type.
Tests:
- Added coverage for the abstract-class Symbol `$config` mechanism.
- Clone tests use the public `$cloneWithProperties` helper instead of manually
pairing `clone()` with `afterCloneFrom()`.
- DOM-conversion tests use a new shared `$runDOMConversion` util that drives the
editor's registered conversion cache (the paste path) rather than calling a
node's static `importDOM()` directly.
Closes #
## Test plan
### Before
Every node class carried boilerplate `static getType`/`clone`/`importJSON`/
`importDOM` declarations.
### After
`pnpm run tsc`, `pnpm run flow`, ESLint, and Prettier all pass. The full unit
suite is green: 2866 passed / 1 skipped with `--project unit`, and 860 passed
with `--project scripts-unit`.1 parent ac3814e commit 4a9a8e7
45 files changed
Lines changed: 550 additions & 697 deletions
File tree
- examples
- node-replacement/src/nodes
- vanilla-js-plugin/src/emoji-plugin
- packages
- lexical-code-core/src
- lexical-extension/src
- lexical-hashtag/src
- lexical-link/src
- __tests__/unit
- lexical-mark/src
- lexical-playground/src
- nodes
- ExcalidrawNode
- PageBreakNode
- plugins/CollapsibleExtension
- lexical-react/src
- lexical-rich-text/src
- lexical-table/src
- __tests__/unit
- lexical/src
- __tests__
- unit
- utils
- nodes
- __tests__/unit
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 3 additions & 14 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
9 | | - | |
10 | | - | |
11 | | - | |
12 | | - | |
13 | | - | |
| 8 | + | |
14 | 9 | | |
15 | 10 | | |
16 | | - | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
21 | | - | |
22 | | - | |
23 | | - | |
| 11 | + | |
| 12 | + | |
24 | 13 | | |
25 | 14 | | |
26 | 15 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
27 | | - | |
28 | | - | |
| 27 | + | |
| 28 | + | |
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
47 | 47 | | |
48 | 48 | | |
49 | 49 | | |
50 | | - | |
51 | | - | |
52 | | - | |
53 | | - | |
54 | | - | |
55 | | - | |
56 | | - | |
57 | | - | |
58 | | - | |
59 | | - | |
| 50 | + | |
| 51 | + | |
60 | 52 | | |
61 | 53 | | |
62 | 54 | | |
| |||
110 | 102 | | |
111 | 103 | | |
112 | 104 | | |
113 | | - | |
114 | | - | |
115 | | - | |
116 | | - | |
117 | | - | |
118 | | - | |
119 | 105 | | |
120 | 106 | | |
121 | 107 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
12 | 11 | | |
13 | 12 | | |
14 | 13 | | |
| |||
88 | 87 | | |
89 | 88 | | |
90 | 89 | | |
91 | | - | |
92 | | - | |
93 | | - | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
94 | 141 | | |
95 | | - | |
96 | | - | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
97 | 158 | | |
98 | 159 | | |
99 | | - | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
100 | 164 | | |
101 | 165 | | |
102 | 166 | | |
| |||
207 | 271 | | |
208 | 272 | | |
209 | 273 | | |
210 | | - | |
211 | | - | |
212 | | - | |
213 | | - | |
214 | | - | |
215 | | - | |
216 | | - | |
217 | | - | |
218 | | - | |
219 | | - | |
220 | | - | |
221 | | - | |
222 | | - | |
223 | | - | |
224 | | - | |
225 | | - | |
226 | | - | |
227 | | - | |
228 | | - | |
229 | | - | |
230 | | - | |
231 | | - | |
232 | | - | |
233 | | - | |
234 | | - | |
235 | | - | |
236 | | - | |
237 | | - | |
238 | | - | |
239 | | - | |
240 | | - | |
241 | | - | |
242 | | - | |
243 | | - | |
244 | | - | |
245 | | - | |
246 | | - | |
247 | | - | |
248 | | - | |
249 | | - | |
250 | | - | |
251 | | - | |
252 | | - | |
253 | | - | |
254 | | - | |
255 | | - | |
256 | | - | |
257 | | - | |
258 | | - | |
259 | | - | |
260 | | - | |
261 | | - | |
262 | | - | |
263 | | - | |
264 | | - | |
265 | | - | |
266 | | - | |
267 | | - | |
268 | | - | |
269 | | - | |
270 | | - | |
271 | | - | |
272 | | - | |
273 | | - | |
274 | | - | |
275 | | - | |
276 | | - | |
277 | | - | |
278 | | - | |
279 | | - | |
280 | | - | |
281 | 274 | | |
282 | 275 | | |
283 | 276 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| 17 | + | |
17 | 18 | | |
18 | 19 | | |
19 | 20 | | |
| |||
33 | 34 | | |
34 | 35 | | |
35 | 36 | | |
36 | | - | |
37 | | - | |
38 | | - | |
39 | | - | |
40 | | - | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
41 | 46 | | |
42 | 47 | | |
43 | 48 | | |
| |||
51 | 56 | | |
52 | 57 | | |
53 | 58 | | |
54 | | - | |
55 | | - | |
56 | | - | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
57 | 62 | | |
58 | 63 | | |
59 | 64 | | |
60 | | - | |
61 | | - | |
62 | | - | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
63 | 68 | | |
64 | 69 | | |
65 | 70 | | |
| |||
Lines changed: 14 additions & 22 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
10 | | - | |
11 | 10 | | |
12 | 11 | | |
13 | 12 | | |
| |||
49 | 48 | | |
50 | 49 | | |
51 | 50 | | |
52 | | - | |
53 | | - | |
54 | | - | |
55 | | - | |
56 | | - | |
57 | | - | |
58 | | - | |
59 | | - | |
60 | | - | |
61 | | - | |
62 | | - | |
63 | | - | |
64 | | - | |
65 | | - | |
66 | | - | |
67 | | - | |
68 | | - | |
69 | | - | |
70 | | - | |
71 | | - | |
72 | | - | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
73 | 65 | | |
74 | 66 | | |
75 | 67 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
21 | | - | |
| 16 | + | |
| 17 | + | |
22 | 18 | | |
23 | 19 | | |
24 | 20 | | |
| |||
27 | 23 | | |
28 | 24 | | |
29 | 25 | | |
30 | | - | |
31 | | - | |
32 | | - | |
33 | | - | |
34 | 26 | | |
35 | 27 | | |
36 | 28 | | |
| |||
0 commit comments