styleguidist/react-styleguidist

Replace doctrine with another JSDoc parser

Open

#1 708 ouverte le 31 oct. 2020

Voir sur GitHub
 (12 commentaires) (2 réactions) (0 assignés)TypeScript (1 416 forks)github user discovery
help wanted

Métriques du dépôt

Stars
 (11 091 stars)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Identifiez tous les fichiers utilisant doctrine (via les résultats de recherche) et remplacez les par un analyseur JSDoc moderne comme comment parser ou jsdoc parser. Assurez la compatibilité avec Webpack 5 et la réussite des tests existants.
Stack technique
typescriptnodejs
Domaine
build systemdeveloper experience
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65