search

tact-lang / tact

Tact compiler main repository
https://tact-lang.org
MIT License
280 stars 56 forks source link

Add documentation comments to Zod schema of `tact.config.json` #215

Open novusnota opened 3 months ago

novusnota commented 3 months ago

This would add helpful descriptions in editors supporting tsserver (as it automatically sources such comments and adds them in on hover).

File that needs doc comments: parseConfig.ts See example of descriptions: configSchema.json JSDoc discussion in Zod: https://github.com/colinhacks/zod/issues/200

novusnota commented 3 months ago

Besides, it would be nice to comment exported APIs of the @tact-lang/compiler, because at the moment one can only guess what each does, without going deep into compilers code.

For example, I had to manually figure out the difference between the check() and verify() functions, because their signature tells very little and TS projects have a poor go-to-definition by design (you'll only going to see types, not source).

As far as I've gathered by now, former checks Tact contracts for syntax errors (mostly), while the latter checks the generated .pkg file. Would've been nice to have all that info in on-hover comments.

 

Additionally, once #183 improves, it would be nice to update the relevent page in docs (or even make it into a sub-section for tool makers): https://docs.tact-lang.org/book/programmatic