Repository navigation
Return Struct Warnings #301
|
When returning a struct a warning will show if I don't define what the struct contains. Is there support in JSDocs and Stitch to define what parameters the struct contains without having to define a constructor. I'm currently documenting that a function will return Any to mask the problem. |
Replies: 1 comment 6 replies
|
Unfortunately no. I've been avoiding going too far beyond Feather syntax to try to keep as much compatibility with Feather as I can, and at least back when I was writing all of this Feather didn't have a way to document struct contents. I just write the constructors. Since they don't get referenced except as a type I'm pretty sure they don't impact the build anyway. Stitch does prove some jsdoc-like stuff for documenting struct variables within constructors, so you can in effect use empty constructors with comment-generated self variables. I think it's all in the Stitch README (which vscode also shows when you view the extension). |
|
Yeah, I certainly hope so! But stuff will get weirder before that as the new runtime adds support for JavaScript. My understanding is that they're essentially doing their own version of JavaScript (so I'm not sure what ECMA version it'll best align with). In any case, once they have that then it'll also just be a better experience to write code in JavaScript -- no idea if GameMaker plans to make it easy to add the Typescript language server or not, but Stitch could in any case. And then we'd have REAL JSDocs! |
|
That would be a nice addition to no longer be limited by feather. I am curious, do you have plans to add support for the new LTS release? 😊 |
|
At some point! I make sure it supports our current needs, and we find that GameMaker version bumps tend to break something on one platform or another, so we upgrade relatively rarely when a version comes out that passes all of our tests on all platforms. Since we're gearing up for a launch in a few weeks it'd be too risky try a version upgrade for a while. It'll be longer before we support the New Runtime versions, since those are really unreliable right now and probably will be for a while! |
|
Ah okay, I'm happy to wait until things are updated. I'm also happy to help contribute, too. Just not sure where to start. I am curious, what is the current version that Stitch supports? I looked through README but I couldn't find anything pertaining to the current IDE & Runtime it supports. |
|
It's a bit nebulous since GameMaker versioning is weird. Basically, we upgrade the version we're using periodically when one passes all tests and improves something, and then update Stitch to accommodate any breaking changes in that version. GameMaker's version numbers in their different tracks don't change in a way that allows unambiguously saying "this version is greater than that version", so we can't do things like "between version X and Y process sprite files like this..." Which means that it's never quite clear what version ranges are supported by Stitch at any given time. It's essentially "versions whose project files are compatible with the version we're currently using in production" |
Unfortunately no. I've been avoiding going too far beyond Feather syntax to try to keep as much compatibility with Feather as I can, and at least back when I was writing all of this Feather didn't have a way to document struct contents.
I just write the constructors. Since they don't get referenced except as a type I'm pretty sure they don't impact the build anyway. Stitch does prove some jsdoc-like stuff for documenting struct variables within constructors, so you can in effect use empty constructors with comment-generated self variables. I think it's all in the Stitch README (which vscode also shows when you view the extension).