Improve types

[allmtz]

-Created the UnitDataStructure type to improve type safety when adding a new unit to units.ts

-Narrowed the possible values of CreatureType to only valid combinations of creature.realm + creature.level

[vercel]

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

Name	Status	Preview	Updated (UTC)
ancientbeast	✅ Ready (Inspect)	Visit Preview	Jul 26, 2023 5:26am

[ghost]

👇 Click on the image for a new way to code review

Legend

[allmtz]

I believe the linter error is due Prettier not supporting the satisfies keyword until version 2.8. The project is using Prettier 2.5.1.

I could try silencing the linter or bumping the version, @DreadKnight which would you prefer?

[andretchen0]

@allmtz, I'm all for bumping Prettier versions if that's what it takes.

But I wonder if this ...

] as const satisfies UnitDataStructure;

... is doing what you want.

satisfies is new to me, so I could be wrong, and if so, apologies in advance.

Edit: It was the as const that confused me. Carry on!

[allmtz]

But I think what this tells TS is "treat this as if it satisfies UnitDataStructure."

I believe satisfies is a little different from as. From the TS handbook:

"The new satisfies operator lets us validate that the type of an expression matches some type, without changing the resulting type of that expression."

It's super useful since it allows for type checking whenever creating a new unit. I checked to make sure there was no casting and doing something like name: 0 throws an error.

But I wonder if this ...

] as const satisfies UnitDataStructure;

... is doing what you want.

Using satisfies lets us keep the literal as const inferences TS makes while also type checking. I played around with using only type definitions without satisfies, but this has the downside of losing all the inferences. For example, Realm in types.ts gets inferred as a string instead of "-" | "A" | "G" | "L" | "S" | "P" | "W" | "E".

[DreadKnight]

I believe the linter error is due Prettier not supporting the satisfies keyword until version 2.8. The project is using Prettier 2.5.1.

I could try silencing the linter or bumping the version, @DreadKnight which would you prefer?

@allmtz You can bump the dependencies just fine as long as they don't trigger a chain reaction. If that happens you'll have to deal with it as well ideally.

[andretchen0]

But I think what this tells TS is "treat this as if it satisfies UnitDataStructure."

I believe satisfies is a little different from as. From the TS handbook:

"The new satisfies operator lets us validate that the type of an expression matches some type, without changing the resulting type of that expression."

It's super useful since it allows for type checking whenever creating a new unit. I checked to make sure there was no casting and doing something like name: 0 throws an error.

But I wonder if this ...

] as const satisfies UnitDataStructure;

... is doing what you want.

Using satisfies lets us keep the literal as const inferences TS makes while also type checking. I played around with using only type definitions without satisfies, but this has the downside of losing all the inferences. For example, Realm in types.ts gets inferred as a string instead of "-" | "A" | "G" | "L" | "S" | "P" | "W" | "E".

Cool. I look forward to checking it out.

[allmtz]

@DreadKnight, I wanted to bring up my comment in #2441 regarding the usage of '1' versus 1. Before I begin implementing these types in game.ts, I'd appreciate some clarification on which one you prefer to use.

[DreadKnight]

@DreadKnight, I wanted to bring up my comment in #2441 regarding the usage of '1' versus 1. Before I begin implementing these types in game.ts, I'd appreciate some clarification on which one you prefer to use.

@allmtz My issue before was that there was no consistency between the number, so you had one extra version in your array thingy after. But you could go for the no commas version overall, except the string one for Dark Priests I guess, would simplify editing and such a bit.