[RFC] Typings / TypeScript

[thescientist13]

Type of Change

• New Feature Request
• Documentation / Website
• Improvement / Suggestion
• Bug
• Other (please clarify below)

Summary

For a build system like this, which is essentially a custom gluing together of various open source tools, and in turn building up a custom domain model of terms / objects like:

• compilation
• context
• graph
• scaffold
• etc

One option is to document with something like JSDoc, another option is to use types. 😄

Details

Introducing a type system might really help add a lot of consistency and continuity to the project and since it's a command line tool, should hopefully obviate the need to have to do any transpiling, but would need to be runnable in a runtime that supports TS. (possibly using ts-node?)

Anyway, creating interface for things like compilation and context could go a long way towards hardening the build process and development / debugging easier.

[thescientist13]

I guess another way to look at this is allowing users to write their apps in TypeScript? I suppose if the project was written in TypeScript though, it would probably be a good time as any to add it in userland too (assuming it's a viable option?)

[thescientist13]

typescript-graphql-type-safety

[thescientist13]

probably wont be able to work on something like this for a while, so moving to Trello board for now, and will reopen when the time comes for this, probably later on towards the end of 2021, and would likely want to couple this with moving all require NodeJS calls to use import instead, which could be a breaking change.

But also concerned from a consumer perspective if this would make it harder to debug. I know from my POV as an author, having the same code from the repo right there in node_modules has helped with a ton of debugging and testing. Maybe sourcemaps fixes this, or types?