reactjs / reactjs/react-docgen
Monorepo support is missing
Personne n'a encore pris cette issue.
- Langage dominant
- TypeScript
- Étoiles
- 3.8k
- Forks
- 316
- Merge moyen
- 5 h 7 min
- PR mergées (30 j)
- 4
Description
We are working in a huge monorepo setup with hundreds of packages. Now if an interface is imported from an "external" package - just another package that i'm currently scoped into - it won't pick up this file and parse it. This results in missing properties that basically would be delivered by this imported interface/type.
Could be fixed with a patch in the makeFsImporter.ts but i didn't made a pull request yet - i just tried it out very specifically for our own repository, but it would need further work to make a generic solution out of it:
function resolveImportedValue(
path: ImportPath,
name: string,
file: FileState,
seen = new Set<string>(),
): NodePath | null {
// Bail if no filename was provided for the current source file.
// Also never traverse into react itself.
let source = path.node.source?.value;
let { filename } = file.opts;
// Customization: add support to resolve packages from blocks, segments, and libraries in iso monorepo
if (
(typeof filename === "string" && source?.startsWith("@blocks")) ||
source?.startsWith("@segments") ||
source?.startsWith("@libraries")
) {
filename = `${getRepoRoot(filename as string)}/${source.replace("@", "")}/src/index.ts`;
source = "./index";
}
// Customization: end
if (!source || !filename || source === "react") {
return null;
}
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez dans makeFsImporter.ts, en particulier dans resolveImportedValue, et suivez la manière dont les interfaces et les types importés sont résolus pour les fichiers d’un monorepo. Généralisez le comportement de résolution de paquets signalé au-delà de l’exemple @blocks, @segments et @libraries afin que les paquets externes dans des monorepos avec scope soient analysés et que leurs propriétés soient incluses.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- tooling
- Type d'issue
- Fonctionnalité
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 38/100