feat(build): packagesManager and PackageMetadata abstractions & integration tests #5940

etrepum · 2024-04-22T23:04:23Z

Extracted from #5876 to hopefully land it in smaller chunks. Addresses the infrastructure needed for #5869 (without the associated changes to scripts).

Adds some tests to sanity check packages (their package.json, the existence of flow and docs)
Generate boilerplate README.md and docs/packages/{package}.md files (npm run update-docs)
Adds build integration tests to make sure all of the examples build and run with release artifacts

This does not make any major changes to any of the other build infrastructure, I will push those PRs separately if this is reviewed & merged instead of #5876.

I've also removed lint changes and the additional build integration tests for astro, svelte and next.js to minimize this PR.

If you'd rather get this done in one go, review and merge #5876 instead which includes these changes.

vercel · 2024-04-22T23:04:28Z

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	Apr 23, 2024 7:21pm
lexical-playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 23, 2024 7:21pm

etrepum · 2024-04-23T00:18:29Z

@StyleT here's an attempt to break #5876 up. This is almost entirely an additive change (except for the small changes required for eslint rules and tsc compliance). I could move the build integration tests (basically just boilerplate projects to show that the build works with various frameworks) into their own PR if this needs to be even smaller.

StyleT · 2024-04-23T01:25:03Z

scripts/__tests__/integration/fixtures/lexical-esm-astro-react/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "lexical-esm-astro-react",


Should this and other new packages be here? If yes - why do they have actual implementation instead of being a simple stubs?

These are integration tests that see if lexical can be consumed by other projects with various bundlers and frameworks. It needs to be a whole project in order to demonstrate integration.

In the meantime I have removed these fixtures so there are fewer files to look at in the interest of expediting this

StyleT · 2024-04-23T01:27:37Z

.eslintrc.js

-    // This isn't useful in our test code
-    'react/react-in-jsx-scope': ERROR,
+    // This hasn't been necessary since React 17
+    'react/react-in-jsx-scope': OFF,


This change doesn't seem related to build scripts. As well as the some other (not scoped to /scripts/) within this file

I can back these out if it helps, I had modified these lint rules because they have not served a purpose in years and it caused problems for some of the other frameworks before I had ignored them.

I backed out these lint rule changes and the fixtures to make this smaller

This is the reason I had made those lint changes in the first place:

❯ (cd examples/react-rich; npm run build) > @lexical/react-rich-example@0.14.5 build > tsc && vite build src/App.tsx:14:1 - error TS6133: 'React' is declared but its value is never read. 14 import * as React from 'react'; ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ src/plugins/ToolbarPlugin.tsx:22:1 - error TS6133: 'React' is declared but its value is never read. 22 import * as React from 'react'; ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ src/plugins/ToolbarPlugin.tsx:60:20 - error TS6133: 'newEditor' is declared but its value is never read. 60 (_payload, newEditor) => { ~~~~~~~~~ src/plugins/TreeViewPlugin.tsx:11:1 - error TS6133: 'React' is declared but its value is never read. 11 import * as React from 'react'; ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Found 4 errors in 3 files. Errors Files 1 src/App.tsx:14 2 src/plugins/ToolbarPlugin.tsx:22 1 src/plugins/TreeViewPlugin.tsx:11

etrepum · 2024-04-23T14:46:01Z

packages/lexical-devtools/tsconfig.json

+      "@lexical/html": ["../lexical-html/src/"],
+      "@lexical/link": ["../lexical-link/src/"],
+      "@lexical/mark": ["../lexical-mark/src/"],
+      "@lexical/selection": ["../lexical-selection/src/"],
+      "@lexical/table": ["../lexical-table/src/"],
+      "@lexical/utils": ["../lexical-utils/src/"],


npm run ci-check does not pass for me without this because npm run tsc-extension will fail with resolution errors

etrepum · 2024-04-23T14:46:29Z

scripts/__tests__/integration/prepare-release.test.js

+    });
+  }
+});
+['examples', 'scripts/__tests__/integration/fixtures']


I removed the additional fixtures from this PR

StyleT · 2024-04-23T17:34:09Z

Glad to see this got smaller. I'll take another look today/tomorrow ;) Let's not forget main purpose of this: simplify new package addition. Hope these changes serve the purpose well ;)

etrepum · 2024-04-23T18:40:53Z

This is mostly just the infrastructure to make that possible. #5876 includes the actual work to make it easier to add a new package as it requires sweeping changes to all sorts of build and configuration so that new packages get picked up.

etrepum · 2024-04-23T18:45:23Z

A larger PR is preferable for me because as an external contributor I have no way to submit stacked diffs for review. Landing this work in pieces would take months and would not really help anyone add a new package in the meantime.

etrepum · 2024-04-23T18:52:31Z

scripts/npm/increment-version.js

+
 const increment = argv.i;
 const validIncrements = new Set(['minor', 'patch', 'prerelease']);
 if (!validIncrements.has(increment)) {
  console.error(`Invalid value for increment: ${increment}`);
  process.exit(1);
 }

-async function incrementVersion(increment) {
+async function incrementVersion() {
  const preId = increment === 'prerelease' ? '--preid next' : '';
  const workspaces = '';
  const command = `npm --no-git-tag-version version ${increment} --include-workspace-root true ${preId} ${workspaces}`;
  await exec(command);
 }

-incrementVersion(increment);
+incrementVersion();


This is just compliance with the monorepo lint rules. Previously this directory was included with overly general ignore rules because the folder happened to be named npm.

…s and build integration tests Extracted from facebook#5876 to hopefully land it in smaller chunks. Addresses the infrastructure needed for facebook#5869 (without the associated changes to scripts)

etrepum · 2024-04-23T23:49:54Z

Closing in favor of the larger #5876

etrepum requested review from zurfyx, fantactuka, acywatson, Fetz and ivailop7 as code owners April 22, 2024 23:04

facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Apr 22, 2024

etrepum mentioned this pull request Apr 22, 2024

Refactor build scripts and npm package process #5876

Merged

11 tasks

vercel bot deployed to Preview – lexical April 22, 2024 23:06 View deployment

vercel bot deployed to Preview – lexical-playground April 22, 2024 23:06 View deployment

etrepum force-pushed the packages-manager branch from 2a5cc10 to e9cedfa Compare April 23, 2024 00:04

vercel bot deployed to Preview – lexical April 23, 2024 00:05 View deployment

vercel bot deployed to Preview – lexical-playground April 23, 2024 00:06 View deployment

StyleT reviewed Apr 23, 2024

View reviewed changes

etrepum force-pushed the packages-manager branch from e9cedfa to 087e08e Compare April 23, 2024 14:43

vercel bot deployed to Preview – lexical April 23, 2024 14:44 View deployment

etrepum commented Apr 23, 2024

View reviewed changes

vercel bot deployed to Preview – lexical-playground April 23, 2024 14:46 View deployment

etrepum commented Apr 23, 2024

View reviewed changes

etrepum force-pushed the packages-manager branch from 087e08e to c8295c6 Compare April 23, 2024 14:51

vercel bot deployed to Preview – lexical April 23, 2024 14:52 View deployment

vercel bot deployed to Preview – lexical-playground April 23, 2024 14:54 View deployment

etrepum force-pushed the packages-manager branch from c8295c6 to eca2135 Compare April 23, 2024 15:41

vercel bot deployed to Preview – lexical April 23, 2024 15:42 View deployment

vercel bot deployed to Preview – lexical-playground April 23, 2024 15:43 View deployment

etrepum commented Apr 23, 2024

View reviewed changes

feat(build): monorepo packagesManager and PackageMetadata abstraction…

ea2bbf4

…s and build integration tests Extracted from facebook#5876 to hopefully land it in smaller chunks. Addresses the infrastructure needed for facebook#5869 (without the associated changes to scripts)

etrepum force-pushed the packages-manager branch from eca2135 to ea2bbf4 Compare April 23, 2024 19:19

vercel bot deployed to Preview – lexical April 23, 2024 19:20 View deployment

vercel bot deployed to Preview – lexical-playground April 23, 2024 19:21 View deployment

etrepum closed this Apr 23, 2024

etrepum deleted the packages-manager branch May 11, 2024 06:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(build): packagesManager and PackageMetadata abstractions & integration tests #5940

feat(build): packagesManager and PackageMetadata abstractions & integration tests #5940

etrepum commented Apr 22, 2024 •

edited

Loading

vercel bot commented Apr 22, 2024 •

edited

Loading

etrepum commented Apr 23, 2024

StyleT Apr 23, 2024

etrepum Apr 23, 2024

etrepum Apr 23, 2024

StyleT Apr 23, 2024

etrepum Apr 23, 2024

etrepum Apr 23, 2024

etrepum Apr 23, 2024

etrepum Apr 23, 2024

etrepum Apr 23, 2024

StyleT commented Apr 23, 2024

etrepum commented Apr 23, 2024

etrepum commented Apr 23, 2024

etrepum Apr 23, 2024

etrepum commented Apr 23, 2024

feat(build): packagesManager and PackageMetadata abstractions & integration tests #5940

feat(build): packagesManager and PackageMetadata abstractions & integration tests #5940

Conversation

etrepum commented Apr 22, 2024 • edited Loading

vercel bot commented Apr 22, 2024 • edited Loading

etrepum commented Apr 23, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StyleT commented Apr 23, 2024

etrepum commented Apr 23, 2024

etrepum commented Apr 23, 2024

Choose a reason for hiding this comment

etrepum commented Apr 23, 2024

etrepum commented Apr 22, 2024 •

edited

Loading

vercel bot commented Apr 22, 2024 •

edited

Loading