styleguidist/react-styleguidist

Replace doctrine with another JSDoc parser

Open

#1,708 opened on Oct 31, 2020

View on GitHub
 (12 comments) (2 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
help wanted

Repository metrics

Stars
 (11,091 stars)
PR merge metrics
 (PR metrics pending)

Description

As part of the Webpack 5 investigation it was discovered doctrine uses some node modules which WP5 no longer polyfills by default. Doctrine itself is end of life and no longer supported. It would be good for styleguidist to move off it permanently and replace it with another solution.

Doctrine is used in these places: https://github.com/styleguidist/react-styleguidist/search?q=doctrine

Contributor guide

Research direction
Identify all files using doctrine (via search results) and replace with a modern JSDoc parser like comment parser or jsdoc parser. Ensure compatibility with Webpack 5 and existing tests.
Tech stack
typescriptnodejs
Domain
build systemdeveloper experience
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65