loopbackio / loopbackio/loopback-next

Error when running `npm run tsdocs`

Offen
#10,205 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

bug
Vorherrschende Sprache
TypeScript
Sterne
5.1k
Forks
1.1k
Ø Merge
2 T. 21 Std.
Gemergte PRs (30 T.)
27

Beschreibung

Describe the bug

Currently the release of loopback-next modules is blocked by the error when running the command npm run tsdocs as part of the release process.

Here is the error:

> @loopback/typeorm
Analysis will use the bundled TypeScript version 5.2.2
Error: Symbol not found for identifier: EventEmitter
    at AstSymbolTable._analyzeChildTree (/SOME_PATH/loopback-next/node_modules/@microsoft/api-extractor/lib/analyzer/AstSymbolTable.js:293:39)
    at AstSymbolTable._analyzeChildTree (/SOME_PATH/loopback-next/node_modules/@microsoft/api-extractor/lib/analyzer/AstSymbolTable.js:377:18)
    at AstSymbolTable._analyzeChildTree (/SOME_PATH/loopback-next/node_modules/@microsoft/api-extractor/lib/analyzer/AstSymbolTable.js:377:18)
    at AstSymbolTable._analyzeChildTree (/SOME_PATHloopback-next/node_modules/@microsoft/api-extractor/lib/analyzer/AstSymbolTable.js:377:18)
    at AstSymbolTable._analyzeChildTree (/SOME_PATHloopback-next/node_modules/@microsoft/api-extractor/lib/analyzer/AstSymbolTable.js:377:18)
    at AstSymbolTable._analyzeChildTree (/SOME_PATH/loopback-next/node_modules/@microsoft/api-extractor/lib/analyzer/AstSymbolTable.js:377:18)
    at AstSymbolTable._analyzeChildTree (/SOME_PATH/loopback-next/node_modules/@microsoft/api-extractor/lib/analyzer/AstSymbolTable.js:377:18)
    at AstSymbolTable._analyzeChildTree (/SOME_PATH/loopback-next/node_modules/@microsoft/api-extractor/lib/analyzer/AstSymbolTable.js:377:18)
    at AstSymbolTable._analyzeChildTree (/SOME_PATH/loopback-next/node_modules/@microsoft/api-extractor/lib/analyzer/AstSymbolTable.js:377:18)
    at AstSymbolTable._analyzeChildTree (/SOME_PATH/loopback-next/node_modules/@microsoft/api-extractor/lib/analyzer/AstSymbolTable.js:377:18)
    at AstSymbolTable._analyzeAstSymbol (/SOME_PATH/loopback-next/node_modules/@microsoft/api-extractor/lib/analyzer/AstSymbolTable.js:247:18)
    at AstSymbolTable.analyze (/SOME_PATH/loopback-next/node_modules/@microsoft/api-extractor/lib/analyzer/AstSymbolTable.js:113:25)
    at /SOME_PATH/loopback-next/node_modules/@microsoft/api-extractor/lib/analyzer/ExportAnalyzer.js:247:62
    at Map.forEach (<anonymous>)
    at ExportAnalyzer._collectAllExportsRecursive (/SOME_PATH/loopback-next/node_modules/@microsoft/api-extractor/lib/analyzer/ExportAnalyzer.js:236:48)
    at ExportAnalyzer._collectAllExportsRecursive (/SOME_PATH/loopback-next/node_modules/@microsoft/api-extractor/lib/analyzer/ExportAnalyzer.js:260:22)

I've tried a few things but still wasn't able to identify the problem:

  1. force showVerboseMessages to be true in https://github.com/loopbackio/loopback-next/blob/master/packages/tsdocs/src/monorepo-api-extractor.ts#L258C5-L258C24 -> no effect
  2. added showDiagnostics: true, before the line specified above -> it printed more info but it didn't mention where the error could be coming from.
  3. When searching for similar errors, someone suggested (I lost the location where I saw that) to delete the folder node_modules/@microsoft/api-extractor/node_modules/typescript. But it didn't help either.

Since it's blocking the release of LB4 modules, we could possibly remove the api-extractor scripts. We would not have the latest API docs but at least we have the modules published while we're figuring this out.

@loopbackio/loopback-maintainers, thoughts?

Logs

No response

Additional information

No response

Reproduction

https://github.com/loopbackio/loopback-next

  • run npm run tsdocs

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Führe npm run tsdocs im Repository loopback-next aus und reproduziere den Fehler in @loopback/typeorm. Lies zunächst packages/tsdocs/src/monorepo-api-extractor.ts, insbesondere die Konfiguration rund um die referenzierte Zeile, und untersuche den EventEmitter-Symbolsfehler von API Extractor. Die Aufgabe ist abgeschlossen, wenn der Befehl erfolgreich beendet wird und die API-Dokumentation für das Release generiert werden kann.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
node.js, typescript
Bereich
build-system, documentation, release
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.