feat: Grapes

[jeremyckahn]

What this PR does

This PR adds Grape crops. There are ten types of Grapes, and they grow randomly from the one Grape Seed item. In order to support this, the crop system was extended to generically support varieties.

How this change can be validated

It's easiest to set yourself up with a high level, lots of money, and no inventory limit to test this:

farmhand.setState({
  itemsSold: { carrot: 200000 },
  money: 10000000,
  inventoryLimit: -1
}) 

From there buy Grape Seeds from the Shop and go through a few harvest cycles. It would be good to keep an eye on the price events to see that the various Grape types show up there appropriately (though I've tested that and it seemed stable to me).

Questions or concerns about this change

Grapes are unlocked at level 42. Would it be worth introducing this more exotic item earlier in the game by swapping it for another, lower-tiered item?

Additional information

Gameplay screenshots

The addition of support for crop varieties touched a lot of code, so this is a rather large PR. Subsequent PRs adding new crops with varieties should not be nearly so large.

In particular, this PR updates a lot of tests. Broadly speaking, Farmhand's unit tests are overly dependent on mock item data. We probably shouldn't be doing this at all going forward. It creates needless abstraction, and much of the game's item data is stable enough to build tests on top of. It seems worth migrating tests to use real item data as we update them, and that long-term effort is started here.

This PR also introduces the use JSDoc import types. While won't be migrating to TypeScript any time in the foreseeable future, we can still enjoy the editor conveniences of rich type system. This won't prevent us from misusing types, as that's a problem that only the complete adoption of a type system can provide. JSDoc import types are just an iterative step towards a better codebase, and it will also be an ongoing improvement effort to enhance files with as we touch them. To be clear: This isn't a new development requirement, just a handy thing we can take advantage of if we feel like it as we go.

Here's what we get in an editor that's configured to take advantage of TypeScript (even though these are JavaScript files)

Screencast.from.02-02-2023.09.32.12.AM.webm

[vercel]

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

Name	Status	Preview	Comments	Updated
farmhand	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Feb 20, 2023 at 1:27AM (UTC)

[jeremyckahn]

This is taken from here.

[jeremyckahn]

Not all of the tests touched by this PR were updated to use actual item data in order to reign in the scope. Part of setting up the tests to validate crop variety logic involved fixing some mock data. This seems to support the case to move away from it completely.

[jeremyckahn]

These are the JSDoc import types I was referencing in the PR description. I plan to add these as I update the relevant parts of the codebase. We'll probably never have complete typing, but more is better than less. 🙂

[lstebner]

In particular, this PR updates a lot of tests. Broadly speaking, Farmhand's unit tests are overly dependent on mock item data. We probably shouldn't be doing this at all going forward. It creates needless abstraction, and much of the game's item data is stable enough to build tests on top of. It seems worth migrating tests to use real item data as we update them, and that long-term effort is started here.

strongly agree!

honestly everything here looks reasonable and solid. my only concern is that this is too many varieties, but no issues with the code and i think it's ultimately up to you on the number of varieties. i hope we can utilize this with more crops in the future! or maybe even some of the pre-existing ones like corn, and carrots.

as far as if we should add this earlier in the game level wise i don't necessarily think we need to. i still think we should give players the ability to level up quicker so more of them get to see more content, but i can't think of any specific advantage of having grapes earlier than something else. at least, not until we have kegs in the workshop.

[jeremyckahn]

my only concern is that this is too many varieties, but no issues with the code and i think it's ultimately up to you on the number of varieties.

Agreed. I've cut out half of them for now and this is what remains:

Screenshot

i still think we should give players the ability to level up quicker so more of them get to see more content, but i can't think of any specific advantage of having grapes earlier than something else. at least, not until we have kegs in the workshop.

💯! That all makes sense to me.