microsoft / ts-parsec

Writing a custom parser is a fairly common need. Although there are already parser combinators in others languages, TypeScript provides a powerful and well-structured foundation for building this. Common parser combinators’ weakness are error handling and ambiguity resolving, but these are ts-parsec’s important features. Additionally, ts-parsec provides a very easy to use programming interface, that could help people to build programming-language-scale parsers in just a few hours. This technology has already been used in Microsoft/react-native-tscodegen.
Other
353 stars 18 forks source link

Maybe use JSDoc/TSDoc? #27

Closed Bikossor closed 1 year ago

Bikossor commented 3 years ago

I would like to suggest implementing JSDoc/TSDoc so that when working with the framework you don't always have to look in the documentation but that some of this information is already in the code.

ZihanChen-MSFT commented 1 year ago

Thanks for your suggestion, but in my opinion, this library is not that easy to work by trying this and that, without reading the document. All you need to do is start by the sample, and learn all combinators. It is very important to learn all combinators before parse your text, so that you are able to write the most optimized parser for your syntax.

So I think I would just let all the information staying in the document for now.