Configuration option to parse out all unescaped unknown @<tag> blocks
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
Currently something like this:
/**
* foo summary
*
* @custom foo
*/
export interface B {}
Leads to parsing @custom foo as part of the summary text.
Could there be a mode to treat any line-starting unescaped @<valid_tag_name> as an unknown tag block? It would parse as simply:
- the name of the unknown tag
- the content of the tag (first line and following lines until end or next tag)
A use-case for this would be a doc tool listing the unknown tags with relative niceness, e.g.
##### Unknown Tag 1
<content>
##### Unknown Tag 2
<content>
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points. Start by locating the TypeScript doc-comment parser and its handling of unknown tags; done means the requested mode separates each unescaped line-starting tag into its name and following content.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100