styleguidist/react-styleguidist

Replace doctrine with another JSDoc parser

Open

#1.708 geöffnet am 31. Okt. 2020

Auf GitHub ansehen
 (12 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)TypeScript (1.416 Forks)github user discovery
help wanted

Repository-Metriken

Stars
 (11.091 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Identifiziere alle Dateien, die doctrine verwenden (über Suchergebnisse), und ersetze sie durch einen modernen JSDoc Parser wie comment parser oder jsdoc parser. Stelle die Kompatibilität mit Webpack 5 und das Bestehen vorhandener Tests sicher.
Tech Stack
typescriptnodejs
Domain
build systemdeveloper experience
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65