styleguidist/react-styleguidist

Replace doctrine with another JSDoc parser

Open

#1,708 创建于 2020年10月31日

在 GitHub 查看
 (12 评论) (2 反应) (0 负责人)TypeScript (1,416 fork)github user discovery
help wanted

仓库指标

Star
 (11,091 star)
PR 合并指标
 (PR 指标待抓取)

描述

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

贡献者指南

研究方向
识别所有使用doctrine的文件（通过搜索结果），并替换为现代的JSDoc解析器，如comment parser或jsdoc parser。确保与Webpack 5的兼容性以及现有测试通过。
技术栈
typescriptnodejs
领域
build systemdeveloper experience
议题类型
重构
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65