sveltedoc-parser
sveltedoc-parser copied to clipboard
alexprey
Generate a JSON documentation for a Svelte (https://github.com/sveltejs/svelte) component
Use the native `typescript` package AST Viewer: https://ts-ast-viewer.com ## Plan - [x] Pase variable definitions (private data items) - [x] Parse exported variable (public data items) - [ ] Parse...
| Version | Error rate | Avg. Parse time (ms) | Avg. Speed (B/ms) | |---------|------------|--------------------------|---------------| | [4.3.1](https://github.com/alexprey/sveltedoc-parser/releases/tag/4.3.1) | 3.44% | 2.38 | 777.65 ( -39.79) | | [4.1.0](https://github.com/alexprey/sveltedoc-parser/releases/tag/4.1.0) |...
Need to add integration tests that install library from npm package and try to parse few source files and check that is not failed. That test need to be run...
The following input of markup returns the wrong output for script blocks ``` const example = ` `; ```
I do not think anyone is using this lib with Svelte v2 anymore, so I suggest to remove support for it as it is just additional maintenance and bloat for...
It'd be helpful to expose custom properties inside a component for easier documentation. Particularly with the addition of the `` syntax. It would be even more helpful if custom properties...
https://jsdoc.app/tags-event.html The following comment must provide description for event and provide class of event ```js /** * The `close` event fired when user click to X button in the panel....
Currently in this library we use the fork of [HtmlParser2 library](https://www.npmjs.com/package/htmlparser2-svelte) base on old version 4.1.1. The original library release the [7.1.1](https://github.com/fb55/htmlparser2/releases/tag/v7.1.1) version with performance improvements and enchance attributes index...
In the following PR https://github.com/alexprey/sveltedoc-parser/pull/71 we introduce improvement for variable type inference, but it is not support more complex cases. For example, all arrays are not generic and all functions...
Add few examples of what document structure can be parsed by this package