NotificationsYou must be signed in to change notification settings
Fork928
Star10.1k

refactor: strong type for getFormHelpers name#1029

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.

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

Already on GitHub?Sign in to your account

Jump to bottom

Merged

greyscaled merged 1 commit intomainfromvapurrmaid/getFormHelpers

Apr 15, 2022

Merged

refactor: strong type for getFormHelpers name#1029

greyscaled merged 1 commit intomainfromvapurrmaid/getFormHelpers

Apr 15, 2022

Conversation

Copy link

Contributor

greyscaled commentedApr 15, 2022•
edited
Loading

Summary:

ModifygetFormHelpers so that only the keys of the generic form interface
can be passed in forname.

Details:

Keys of an object in TS can naturally be ofstring | number | symbol. I don't think
there's an easy way to re-genericize this helper and type things that gets around this,
so I took the simple path of throwing anError ontypeof !== "string".

Impact:

Minor improvement to dev experience usinggetFormHelpers (compile-time safety).

refactor: strong type for getFormHelpers name

b007377

greyscaled requested a review froma team as acode owner

April 15, 2022 17:31

greyscaled self-assigned this

Apr 15, 2022

Copy link

codecovbot commentedApr 15, 2022•
edited
Loading

Codecov Report

Merging#1029 (b007377) intomain (88e30be) willdecrease coverage by0.22%.
The diff coverage is33.33%.

@@            Coverage Diff             @@##             main    #1029      +/-   ##==========================================- Coverage   67.54%   67.32%   -0.23%==========================================  Files         259      259                Lines       15059    15061       +2       Branches      151      152       +1     ==========================================- Hits        10172    10140      -32- Misses       3873     3899      +26- Partials     1014     1022       +8

Flag	Coverage Δ
unittest-go-macos-latest	`53.58% <ø> (-0.24%)`	⬇️
unittest-go-postgres-	`66.53% <ø> (-0.12%)`	⬇️
unittest-go-ubuntu-latest	`56.12% <ø> (-0.28%)`	⬇️
unittest-go-windows-2022	`52.98% <ø> (-0.03%)`	⬇️
unittest-js	`68.10% <33.33%> (-0.10%)`	⬇️

Impacted Files	Coverage Δ
site/src/components/Form/index.ts	`89.47% <33.33%> (-10.53%)`	⬇️
pty/start_other.go	`64.70% <0.00%> (-23.53%)`	⬇️
peerbroker/dial.go	`77.04% <0.00%> (-6.56%)`	⬇️
cli/cliui/agent.go	`77.19% <0.00%> (-5.27%)`	⬇️
peer/conn.go	`76.14% <0.00%> (-5.08%)`	⬇️
coderd/parameter/compute.go	`74.07% <0.00%> (-4.45%)`	⬇️
cli/cliui/provisionerjob.go	`76.42% <0.00%> (-2.15%)`	⬇️
coderd/provisionerdaemons.go	`62.95% <0.00%> (-1.03%)`	⬇️
coderd/database/queries.sql.go	`83.65% <0.00%> (-0.21%)`	⬇️
provisioner/terraform/provision.go	`68.54% <0.00%> (+0.43%)`	⬆️
... and2 more

Continue to review full report at Codecov.

Legend -Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,? = missing data
Powered byCodecov. Last update88e30be...b007377. Read thecomment docs.

presleyp reviewed

Apr 15, 2022

View reviewed changes

site/src/components/Form/index.ts

		// getIn is a util function from Formik that gets at any depth of nesting, and is necessary for the types to work
		export const getFormHelpers = <T>(form: FormikContextType<T>, name: keyof T, error?: string): FormHelpers => {
		if (typeof name !== "string") {
		throw new Error(`name must be type of string, instead received '${typeof name}'`)