microsoft / microsoft/TypeScript

If node_modules is excluded by default, it should not be part of a confusing documentation example

Aperta
#30,632 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Docs
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

Hi,
This is not a code issue but documentation that leads to confusion. By default node_modules folder is excluded for tsc. This is good (I guess), but the following documentation https://www.typescriptlang.org/docs/handbook/tsconfig-json.html has an example using node_modules as a folder to exclude. Personally I think this example was very badly picked because it leads to think that you need to exclude "node_modules" explicitly (which I was doind in all my projects for that reason). You need to read the full document to notice that. It is confusing.

PS: This led to confusion as you can see in other typescript project (https://github.com/TypeStrong/ts-loader/issues/278)

Thanks for the great typescript thing by the way!

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Inizia dalla pagina del manuale di tsconfig.json collegata nell’issue e analizza l’esempio che usa node_modules in exclude. Rivedi l’esempio o la relativa spiegazione in modo che i lettori non deducano che node_modules debba essere escluso esplicitamente, quindi verifica che la documentazione circostante rimanga accurata.

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

Valutazione

Stack tecnologico
typescript
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
Meno di un'ora
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.