`project.getGmlFile()` should take a String OR a Pathy instance, instead of just a Pathy instance.

[nutt-y]

Hello!
I have been trying to use the @bscotch/gml-parser library as a part of my project. I started with using the example in the documentation given to start a new project by doing the following:

const file  = project.getGmlFile("project.gml") // getGmlFile takes in a Pathy object not a string

// LSP information: (method) Project.getGmlFile(path: Pathy<any>): Code | undefined

The actual method contract specifies that it should use a Pathy object. Passing in a string throws this error message:

TypeError: path.relativeFrom is not a function

The documentation shows that a path to the .yyp file is needed, which differs from the actual implementation:

/ Get a GML file in its parsed state. Returns a Code instance,
// which includes various methods for querying/modifying them.
const code = project.getGmlFile(
  '/path/to/my/project/scripts/some_script/some_script.gml',
);

[adam-coster]

Whoops, thanks for reporting this! The fix here would probably be to allow a string, since that's certainly more convenient for an end user.

I'll get that sorted next time I update stitch, though that might be a while.

If you haven't found it yet, the @bscotch/path module provides that Path input type.

[nutt-y]

Thanks! Yea I ended up installing the Path module as well to continue! Thank you for making this!

[adam-coster]

Rad. I'd love to hear about what you're doing with it if you have anything you'd like to share! I mostly just assume my team is the only one using it (which also explains why it's missing some niceties and has some outdated docs...).

[nutt-y]

For sure! I used to use the Stitch extension back when I was using VSCode. I noticed that the lsp implementation is very tied with VSCode's extensions API and not usable in other text editors. What I'm trying to do is a simple, bare bones LSP that wraps the gml-parser library so that I can have some diagnostics and hover documentation when developing within Neovim. I just got started but hopefully have some resemblance of a very basic working LSP based on the library!

[adam-coster]

Gotcha! Yeah the parser package is what's ultimately doing most of the work so it's theoretically portable to any system that supports Node.js. But I developed the parser package in order to create the VSCode extension, so they're definitely tied together a bit.

Getting everything finally working was quite the nightmare, but hopefully things are re-usable enough that you'll have a headstart!

[nutt-y]

Hey! I know it's been a while but I've released the first version of the LSP that leverages the gml-parser module from Stitch. I thought you might want to give it a look! If you have any feedback please let me know! Here's the link to the repo.

[adam-coster]

Very cool, thanks for the update! In retrospect I do wish I'd made a more general LSP for this project rather than putting all of the LSP logic in the extension, BUT I had no idea what I was doing when I got started so by the time I had everything working it just was what it was. I also wish I'd found more ways to parallelize things, but it was already very hard to reason about 😅