RFC: Support file blocks
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
Files should support
@file
@owner
@copyright
@description
@license
This is enough to encode standard header information in a structured way.
Alternatively the "owner" block can be replaced with "author". I went for the former because author is typically conveyed within the copyright tag which could encourage redundant information. On the other hand, owner could be understood with similar semantics to a CODEOWNERS file.
File doc support is especially important when a large number of exporting modules are named index.js these days.
The generated AST should represent the association between exported values and the file's top block.
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
Start by reviewing the TSDoc syntax and generated AST areas responsible for file documentation and exported-value associations. Resolve whether the block uses owner or author, define how the file's top block is represented in the AST, and confirm that standard header fields can be encoded without ambiguity.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100