Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Generated package docs are missing most of the info

Aperta
  • Qualcosa non va?
#2,612 4 commenti 2 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Start by reproducing the missing documentation on the linked npmx.dev page for effect-web-midi and inspect its package.json exports map, especially the wildcard entrypoints. Then trace how the docs generator discovers exported symbols and their attached documentation. Done means the generated package docs include the documented exported functions across the package's entrypoints.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

back help wanted
Describe the bug

https://npmx.dev/package/effect-web-midi/

Docs generator doesn't look very deep to find the actual info about the exported symbols from the package. Due to the specific package organizational structure, many exported functions are not rendered, even though they have actual documentation attached.

https://npmx.dev/package-code/effect-web-midi/v/0.2.1/src%2Finternal%2FEMIDIAccess.ts

And it has more than one entrypoint (especially the ones with wildcards)

{
  "exports": {
    ".": {
      "types": "./dist-types/index.d.ts",
      "default": "./dist/index.js"
    },
    "./*.js": {
      "types": "./dist-types/src/*.d.ts",
      "default": "./dist/src/*.js"
    },
    "./*.ts": "./src/*.ts",
    "./*": {
      "types": "./dist-types/src/*.d.ts",
      "default": "./dist/src/*.js"
    },
    "./internal/*": null,
    "./package.json": "./package.json"
  }
}
Image
Lingua principale
TypeScript
Stelle
3.6k
Fork
533
Merge medio
4g 13h
PR unite (30g)
40

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di npmx-dev/npmx.dev

Tutte le issue di npmx-dev/npmx.dev

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.