Can recipe parameters be made mandatory?

[gabro]

In my (admittedly limited) experience with the recipe API, I find myself wanting the parameters of a recipe to be mandatory.

E.g.

// Button.css.ts

export const buttonRecipe = recipe({
  variants: {
    size: {
      large: { height: "48px" },
      small: { height: "32px" }
    }
  }
})

// Button.tsx
import { buttonRecipe } from "./Button.css";

export function Button(props: { size: "large" | "small" }) {
  return <button className={buttonReceipe()} /> // this is a bug, I forgot to set 'size' and TypeScript is not complaining
}

I would expect the type of a parameter to be optional only when a defaultVariant is provided.

So two questions here:

• what's the rationale behind making recipe parameters optional?
• is there a way to make this stricter?

Thanks!

[markdalgleish]

Just had a go at implementing this: #469

[markdalgleish]

We were following Stitches' lead here, and I'm trying to avoid a breaking change. Worth considering though.

[gabro]

I totally understand the desire not to introduce breaking changes, so no arguments there.

My 2 cents about the default (in case it's something you want to consider changing anyway): when the default is optional, forgetting to pass a value or to use the propose requiredVariants option can result in a silent bug.
Conversely, if parameters are mandatory by default, forgetting to pass a value will result in a type error, at which point one may decide to use an api like optionalVariants (the inverse of requiredVariants) to relax the constraint.
This way it would be much harder to accidentally introduce a bug, and it feels more on brand with the general philosophy of this library (which favors strictness)

[markdalgleish]

Yep, I agree that it feels more on brand for us to be stricter by default. Might chat with the rest of the team about alternative APIs.

[gabro]

Thanks for considering it.
Incidentally, I found that a few days ago the same question was raised for stitches stitchesjs/stitches#861

[kylemh]

Hilariously fun to see identical conclusions reached in similar libraries with none of the same people in the convo ❤️