chore: manage typescript at workspace root #36

bhongy · 2023-06-19T08:06:22Z

Changes

centralize typescript-related devDependencies to project root for version consistency
centralize tsconfig to root and have package-specific tsconfig extends it for consistency
make typescript config more strict especially around detecting null and undefined
fix type errors
typecheck test folders
add Turbo task typecheck which runs tsc in typechecking mode
set up Github Action to run typecheck task

Verification
Checked the produced index.d.ts and index.js files and they're equivalent to the output produced on the main branch.

core/dist/index.d.ts exact same output
core/dist/index.js equivalent output (seems like munged variable names are swapped but it produces the same result), note "use strict" is removed
react/dist/index.d.ts exact same output
react/dist/index.js comparable output; expected the changes how we handle null and undefined in context.tsx and useForm.ts.

changeset-bot · 2023-06-19T08:06:25Z

🦋 Changeset detected

Latest commit: 9ef1967

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@formspree/react	Patch
@formspree/core	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2023-06-19T08:06:26Z

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

Name	Status	Preview	Comments	Updated (UTC)
formspree-react-demo	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 22, 2023 3:37am

bhongy · 2023-06-19T08:07:30Z

package.json

@@ -22,6 +23,7 @@
    "lint-staged": "^13.2.2",
    "prettier": "^2.8.8",
    "sort-package-json": "^2.4.1",
-    "turbo": "latest"
+    "turbo": "latest",
+    "typescript": "^5.1.3"


Note: cra-demo still uses 4.7.4; to be upgraded in a follow-up PR

bhongy · 2023-06-19T08:07:56Z

packages/formspree-core/forms.d.ts

@@ -1,2 +0,0 @@
-// @ts-nocheck


This file is not referenced from anywhere.

bhongy · 2023-06-19T08:08:30Z

packages/formspree-core/src/core.ts

@@ -1,6 +1,5 @@
 import { Stripe } from '@stripe/stripe-js';
 import {
-  hasErrors,


bhongy · 2023-06-19T08:10:21Z

packages/formspree-react/src/context.tsx


 FormspreeContext.displayName = 'Formspree';

-let stripePromise: Promise<Stripe>;
+let stripePromise: Promise<Stripe | null>;


Fix type: getStripe returns Promise<Stripe | null>

bhongy · 2023-06-19T08:10:51Z

packages/formspree-react/src/context.tsx

    };

    if (props.stripePK) {
-      getStripePromise();
+      getStripePromise(props.stripePK);


Fix type: need to pass the value after type narrowing

bhongy · 2023-06-19T08:12:06Z

packages/formspree-react/src/useForm.ts

+  let stripe: Stripe | null;
+  let elements: StripeElements | null;


Fix type: the client getters for these return T | null.

bhongy · 2023-06-19T08:13:52Z

packages/formspree-react/src/useForm.ts

@@ -171,6 +168,7 @@ const useForm = (
            : undefined,
      })
      .then((result: SubmissionResponse) => {
+        // @ts-ignore: unhandled result.response is possibly null


I tried to fix as many type errors without changing the runtime behavior. It's impossible to fix these without changing the implementation to handle null better. We'll do in a follow-up PR.

bhongy · 2023-06-19T08:14:33Z

packages/formspree-react/test/ValidationError.test.tsx

@@ -64,7 +64,7 @@ it('does not render anything if the field does not have an error', () => {
          {
            field: 'name',
            message: 'is required',
-            code: 'REQUIRED',


Fix type: correct the enums.

bhongy · 2023-06-19T08:18:19Z

turbo.json

+    "topo": {
+      "dependsOn": ["^topo"]
+    },
+    "typecheck": {
+      "dependsOn": ["topo"]


https://turbo.build/repo/docs/core-concepts/monorepos/task-dependencies#dependencies-outside-of-a-task

Adding topo allows typecheck tasks in formspree-core and formspree-react to run in parallel while ensuring that changing in formspree-core will cause a cache miss in formspree-react.

An alternative is to do: "typecheck": { "dependsOn": ["^typecheck"] } but it'll cause formspree-react to always run after formspree-core.

bhongy · 2023-06-19T08:18:57Z

turbo.json

@@ -1,4 +1,6 @@
 {
+  "$schema": "https://turbo.build/schema.json",
+  "globalDependencies": ["tsconfig.json"],


If the root tsconfig.json changes, it should cause cache miss to the tasks.

This reverts commit 82138ad.

This reverts commit 91aab65.

…e to the generate typedef

bhongy · 2023-06-20T07:08:21Z

packages/formspree-react/tsconfig.json

    "declaration": true,
    "declarationDir": "dist/types",
-    "noImplicitAny": true,
-    "moduleResolution": "node",
+    "declarationMap": true,
    "jsx": "react",


Eventually, we should change this to react-jsx: https://stackoverflow.com/questions/67776707/ts-config-jsx-reactjsx-vs-react.

However, it'll produce a breaking change (generated typedef will use JSX type from react/runtime instead).

bhongy · 2023-06-22T01:31:03Z

packages/formspree-react/tsconfig.json

@@ -1,17 +1,15 @@
 {
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "@formspree/react",
+  "extends": ["../../tsconfig.json"],
  "compilerOptions": {
    "target": "es5",


This should be removed (i.e. to use root tsconfig value for consistency between core and react packages) in the future. Since it will produce a very different built index.js, we will update it as part of a breaking change release.

cc/ @colevscode

colevscode · 2023-06-22T02:44:39Z

Might be worth a patch bump, if for no other reason, updates the changelog so we can track these improvements. To do that I suggest running yarn changeset and let the changeset bot do it's thing

bhongy added 6 commits June 13, 2023 12:39

chore: run prettier on everything

d91b7fb

chore: manage typescript at workspace root

1d3c713

lint-staged: run typecheck on any .ts, .tsx change

e6d03e4

typechecking test folder

b97480f

fix typescript errors in ValidationError.test.tsx

61eeb84

tweak lint-staged to run typecheck

91aab65

vercel bot deployed to Preview June 19, 2023 08:07 View deployment

tsconfig: change lib for react

9ded1dc

vercel bot deployed to Preview June 19, 2023 08:21 View deployment

bhongy commented Jun 19, 2023

View reviewed changes

bhongy marked this pull request as ready for review June 19, 2023 08:37

bhongy requested a review from colevscode June 19, 2023 08:38

revert removal of packages/formspree-core/forms.d.ts

82138ad

vercel bot deployed to Preview June 20, 2023 02:35 View deployment

bhongy added 2 commits June 20, 2023 09:48

Revert "revert removal of packages/formspree-core/forms.d.ts"

ba7ccf2

This reverts commit 82138ad.

tsconfig: hoist lib config to root

964c474

vercel bot deployed to Preview June 20, 2023 02:49 View deployment

Revert "tweak lint-staged to run typecheck"

101abdb

This reverts commit 91aab65.

vercel bot deployed to Preview June 20, 2023 03:17 View deployment

run typecheck in github action

384067d

vercel bot deployed to Preview June 20, 2023 03:32 View deployment

run GH action only on push

114ceef

vercel bot deployed to Preview June 20, 2023 03:33 View deployment

ci: run yarn build before typecheck because we need types

da0a815

vercel bot deployed to Preview June 20, 2023 03:38 View deployment

run CI only on packages

56c9daa

vercel bot deployed to Preview June 20, 2023 03:42 View deployment

clean-up lint-staged typecheck on root (no longer needed)

a3fe73e

don't need "topo" technique in turbo.json

c28547e

vercel bot deployed to Preview June 20, 2023 03:52 View deployment

Base automatically changed from chore/run-prettier-on-everything to main June 20, 2023 04:05

Merge branch 'main' into chore/manage-typescript-at-root

3459ac2

vercel bot deployed to Preview June 20, 2023 06:30 View deployment

revert tsconfig jsx back to react to avoid introduce breaking chang…

b569ee3

…e to the generate typedef

vercel bot deployed to Preview June 20, 2023 06:44 View deployment

bhongy commented Jun 20, 2023

View reviewed changes

change @formspree/react ts target back to es5

2c1a8c0

vercel bot deployed to Preview June 22, 2023 01:24 View deployment

bhongy commented Jun 22, 2023

View reviewed changes

yarn changeset

6583192

vercel bot deployed to Preview June 22, 2023 02:57 View deployment

tweak comment in github ci workflow

d4dea02

vercel bot deployed to Preview June 22, 2023 03:19 View deployment

clean up comment

9ef1967

vercel bot deployed to Preview June 22, 2023 03:37 View deployment

colevscode approved these changes Jun 22, 2023

View reviewed changes

bhongy merged commit 07c30c5 into main Jun 22, 2023

bhongy deleted the chore/manage-typescript-at-root branch June 22, 2023 04:14

bhongy mentioned this pull request Jun 22, 2023

chore: changeset bump patch versions - core and react #38

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: manage typescript at workspace root #36

chore: manage typescript at workspace root #36

bhongy commented Jun 19, 2023 •

edited

Loading

changeset-bot bot commented Jun 19, 2023 •

edited

Loading

vercel bot commented Jun 19, 2023 •

edited

Loading

bhongy Jun 19, 2023

bhongy Jun 19, 2023

bhongy Jun 19, 2023

bhongy Jun 19, 2023

bhongy Jun 19, 2023

bhongy Jun 19, 2023

bhongy Jun 19, 2023

bhongy Jun 19, 2023

bhongy Jun 19, 2023

bhongy Jun 19, 2023

bhongy Jun 20, 2023 •

edited

Loading

bhongy Jun 22, 2023

colevscode commented Jun 22, 2023 •

edited

Loading

		let stripe: Stripe \| null;
		let elements: StripeElements \| null;

chore: manage typescript at workspace root #36

chore: manage typescript at workspace root #36

Conversation

bhongy commented Jun 19, 2023 • edited Loading

changeset-bot bot commented Jun 19, 2023 • edited Loading

🦋 Changeset detected

vercel bot commented Jun 19, 2023 • edited Loading

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

Choose a reason for hiding this comment

bhongy Jun 20, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

colevscode commented Jun 22, 2023 • edited Loading

bhongy commented Jun 19, 2023 •

edited

Loading

changeset-bot bot commented Jun 19, 2023 •

edited

Loading

vercel bot commented Jun 19, 2023 •

edited

Loading

bhongy Jun 20, 2023 •

edited

Loading

colevscode commented Jun 22, 2023 •

edited

Loading