Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

General Feedback #16

Closed
RichiCoder1 opened this issue May 19, 2020 · 4 comments
Closed

General Feedback #16

RichiCoder1 opened this issue May 19, 2020 · 4 comments

Comments

@RichiCoder1
Copy link
Contributor

Howdy! Stumbled across this project and thing it's a really cool way to open up WASM to NodeJS and also web. Had a few bits of feedback if that's ok:

  • Would ya'll be interested in adding typescript definitions and/or typescriptify this project? Or would ya'll prefer not to maintain that?
  • It's the smallest of nits, but loadPolicy instead of load_policy for example to be a bit more javascript-y?

I'd also be willing to help with #13, have set up quite a few packages & js builds recently.

@patrick-east
Copy link
Contributor

Thanks @RichiCoder1 !

Would ya'll be interested in adding typescript definitions and/or typescriptify this project? Or would ya'll prefer not to maintain that?

Seems like it would be nice for consumers that want to use the library in their typescript application. As far as the mechanics of this, if we don't rewrite what we have in typescript we would have to manually keep the typescript definitions up to date? Or can we automatically generate them? Just trying to get an idea of how much there is to maintain.

It's the smallest of nits, but loadPolicy instead of load_policy for example to be a bit more javascript-y?

No strong preference here. I'm not sure how many folks are using the module, but we could make a major version bump and get everything to conform to a standard (along with having some automated lint/style checker to enforce it)

I'd also be willing to help with #13, have set up quite a few packages & js builds recently.

Awesome! Would welcome the help. Actions are already enabled for the repo so feel free to open up a PR with workflow definitions, if there is any other configuration required on the repo we can sort it out as needed.

@RichiCoder1
Copy link
Contributor Author

Seems like it would be nice for consumers that want to use the library in their typescript application. As far as the mechanics of this, if we don't rewrite what we have in typescript we would have to manually keep the typescript definitions up to date? Or can we automatically generate them? Just trying to get an idea of how much there is to maintain.

Yup! With recent versions of typescript you can generate type definitions using JSDoc. It's not 100% fidelity, but this lib isn't doing anything (currently) that would need to more esoteric types since it has such a small API. I could do a quick PR to do the JSDoc and then once CI is up and running, can wire up the def generation.

No strong preference here. I'm not sure how many folks are using the module, but we could make a major version bump and get everything to conform to a standard (along with having some automated lint/style checker to enforce it)

That'd be my recommendation. Makes it feel more native before it goes a lot of use.

Awesome! Would welcome the help. Actions are already enabled for the repo so feel free to open up a PR with workflow definitions, if there is any other configuration required on the repo we can sort it out as needed.

Will do! Once I open the PR, you'll likely need to kick it for it to run since I'm not a repo contributer. Also will just do the lint & test since publish is best left to ya'll.

@patrick-east
Copy link
Contributor

Closing this out now that #17 merged

@RichiCoder1
Copy link
Contributor Author

Excellent! Work on the actions PR next this weekend

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants