Microsoft/TypeScript

parse jsdocs @property at top level

Open

#46,053 opened on Sep 24, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (6,726 forks)batch import
Experience EnhancementHelp WantedSuggestion

Repository metrics

Stars
 (48,455 stars)
PR merge metrics
 (Avg merge 6d 17h) (9 merged PRs in 30d)

Description

Suggestion

"currently @property is only parsed as a child of @typedef. It would be more consistent to parse it at the top-level too"

💻 Use Cases

/**
 * Controls the alignment of text when printed.
 *
 * @property left - Left-aligns the text.
 * @property right - Right-aligns the text.
 * @property center - Centers the text horizontally.
 */
type TextAlignment = 'left' | 'right' | 'center';

Contributor guide

Research direction
Investigate the JSDoc parser in the TypeScript compiler to understand how @property is currently handled within @typedef, then extend it to allow @property at the top level of a comment.
Tech stack
typescript
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptJSDoc
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50