{"repo":"pgilad/leasot","free":true,"listed":false,"github":"https://github.com/pgilad/leasot","clone":"git clone https://github.com/pgilad/leasot.git","description":"Parse and output TODOs and FIXMEs from comments in your files","language":"TypeScript","stars":819,"topics":["javascript","parse","extract","todo","fixme","comments","automation","productivity","hacktoberfest"],"license":"MIT","category":"productivity","readme_excerpt":"Leasot Intelligently parse and output TODOs and FIXMEs from comments in your files Easily extract, collect and report TODOs and FIXMEs in your code. This project uses regex in order to extract your todos from comments. Comment format TODO: add some info - Spaces are optional. - Colon is optional. - Must be in a comment (line or block) in its own line ( some code(); //TODO: do something is not supported). - Can be prefixed with a @ (i.e. @TODO). - Spaces are trimmed around comment text. - Supported default types are TODO and FIXME - case-insensitive. - Additional types can be added (using tags in cli and customTags in leasot.parse ) - New extensions can be associated with bundled parsers as many languages have overlapping syntax - Supports both leading and trailing references. Examples: - // TODO(tregusti): Make this better - // TODO: Text /tregusti Supported languages 49+ languages are supported, pull requests for additional language support is most welcomed! Usage in command line Command line help Usage in NPM scripts Use leasot -x in order to prevent exiting with a non-zero exit code. This is a good solution if you plan to run leasot in a CI tool to generate todos. Programmatic Installation Programmatic Examples Leasot with build tools - gulp-todo - broccoli-leasot - todo-webpack-plugin API See main exported functions Mainly, you should be using 2 functions: - parse for parsing file contents - report for reporting the todos Type documentation Built-in Reporters See built-in","default_branch":null,"files":null,"tree":[],"storefront":"/r/pgilad","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/pgilad/leasot/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}