Future of Suretype - Githubissues

grantila / suretype

Typesafe JSON (Schema) validator

508 stars 9 forks source link

Future of Suretype #12

Open everhardt opened 3 years ago

everhardt commented 3 years ago

The project I'm working on is currently on Joi and Suretype looks like a very promising improvement, as it would save us from manually writing the TS interfaces, will improve performance and seems to simplify generating documentation of our API.

My main concern is about the maturity of this project and the commitment it will get. I see that it is being maintained by (almost solely) 1 person, that the last commit is 4 months old and that documentation missing. Converting our project would be quite an effort and I'm not sure we can bear maintaining a fork of Suretype should it become abandoned.

@grantila Could you maybe share the future you see for Suretype?

grantila commented 3 years ago

It's certainly not abandoned and I don't see that happening either. Yes it's been only me, although anyone is welcome to help out.

It works pretty well as is, and no updates because there hasn't been any need for any (except Doc). I'm integrating this into another net yet released project which got a bit stuck due to TypeScript bailing on too complex expressions which I hoped 4.4 would solve, but didn't. This is causing some serious architecture rethinking. And I've been away during summer.

Documentation of the API is the major thing missing, thanks for reminding me. I'll try to add that asap.

everhardt commented 3 years ago

Thanks for your swift and positive reply!

stuft2 commented 2 years ago

I would love to use this project because of its speed but it desperately needs documentation for its API.

I'm integrating this into another net yet released project which got a bit stuck due to TypeScript bailing on too complex expressions which I hoped 4.4 would solve, but didn't. This is causing some serious architecture rethinking.

Are you planning to make architectural changes to Suretype since you integrated it into another one of your projects?

grantila commented 2 years ago

Working on documentation as I write this, I just worked quite a lot making coloring/styling work in both Node and browsers.

crobinson42 commented 2 years ago

The one thing that I wish suretype/typescript was able to do better is to make the the type references more readable, ie:

I know this is the nature of the beast and mostly a Typescript concern, however, DX would be dramatically improved if the type documentation was more readable especially when there are errors, another example: