[*] Chore: Fix all new lint warnings, plus manual exports clean-up

etrepum commented 2 weeks ago

Description

Runs @lexical/eslint-plugin over the source to resolve all new warnings
Manually fix up names that were shadowed
Manually fix up invariants, flow types, and docs for renamed and deprecated public API
Manually fix up internal usage of newly deprecated APIs

Newly deprecated APIs (exports still available):

@lexical/link toggleLink - renamed to $toggleLink
@lexical/offset createChildrenArray - renamed to $createChildrenArray
@lexical/selection trimTextContentFromAnchor - renamed to $trimTextContentFromAnchor

Test Plan

Manually verify that the public API is stable in code review, either through no change or through a @deprecated alias
Manually verify that the flow types for any renamed or added public APIs are changed accordingly
All tests still pass

Review notes:

This is a really big PR if you read through the automated stuff. It could be reviewed in pieces:

Configuration change (first commit) - updateEditor is basically editor.update and should be considered a lexical provider
Automated npm run lint -- --fix (second commit) - this is completely automated and probably does not need close review
Manual fix-ups (almost everything after the second commit) - worth a close look
Doc improvements (last relevant commit) - adds {@link $newName} around deprecations for better typedoc ux, and removes unused markdown partial plugin
Flaky collab test mitigation? (not so relevant commit) adds some stuff to maybe help address collab tests that seem flaky. It seemed to help a bit locally, hard to tell whether it it's an solid improvement in CI or not until a lot of test runs have happened.

vercel[bot] commented 2 weeks ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
lexical	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 10, 2024 1:32pm
lexical-playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 10, 2024 1:32pm

etrepum commented 1 week ago

Pretty sure the test failure is just a flaky test, I can't repro locally on my mac and the tests succeeded earlier

This is the end of the output of my local CI=true npm run test-e2e-collab-ci-firefox

[1]   1) [firefox] › packages/lexical-playground/__tests__/regression/4697-repeated-table-selection.spec.mjs:21:3 › Regression test #4697 › repeated table selection results in table selection 
[1] 
[1]     Error: expect(received).toEqual(expected) // deep equality
[1] 
[1]     Expected: 1
[1]     Received: 2
[1] 
[1]        at packages/lexical-playground/__tests__/utils/index.mjs:267
[1] 
[1]       265 |     }
[1]       266 |     if (coordinates.anchor.y !== undefined) {
[1]     > 267 |       expect(_anchor.y).toEqual(coordinates.anchor.y);
[1]           |                         ^
[1]       268 |     }
[1]       269 |   }
[1]       270 |   if (coordinates.focus) {
[1] 
[1]         at assertTableSelectionCoordinates (/Users/bob/src/lexical/packages/lexical-playground/__tests__/utils/index.mjs:267:25)
[1]         at /Users/bob/src/lexical/packages/lexical-playground/__tests__/regression/4697-repeated-table-selection.spec.mjs:49:5
[1] 
[1]   Slow test file: [firefox] › packages/lexical-playground/__tests__/e2e/Markdown.spec.mjs (1.6m)
[1]   Slow test file: [firefox] › packages/lexical-playground/__tests__/e2e/Tables.spec.mjs (1.5m)
[1]   Slow test file: [firefox] › packages/lexical-playground/__tests__/e2e/List.spec.mjs (1.2m)
[1]   Slow test file: [firefox] › packages/lexical-playground/__tests__/e2e/Links.spec.mjs (1.1m)
[1]   Slow test file: [firefox] › packages/lexical-playground/__tests__/e2e/Navigation.spec.mjs (59.1s)
[1]   Consider splitting slow test files to speed up parallel execution
[1]   1 flaky
[1]     [firefox] › packages/lexical-playground/__tests__/regression/4697-repeated-table-selection.spec.mjs:21:3 › Regression test #4697 › repeated table selection results in table selection 
[1]   79 skipped
[1]   362 passed (4.1m)
[1] npm run test-e2e-collab-firefox exited with code 0

ivailop7 commented 6 days ago

@etrepum ok, I'm ready to get this one through. Rebase to latest main and I'll approve and merge it. Hope your 'ONCL' offer still stands.