facebook / facebook/flow

Document @flow pragmas better

Aperta
#1,382 7 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Needs docs
Lingua principale
Rust
Stelle
22.3k
Fork
1.9k
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

The docs about the `@flow` pragma are kind of hard to find without reading lots of prose. It's mentioned in http://flowtype.org/docs/five-simple-examples.html, http://flowtype.org/docs/new-project.html and http://flowtype.org/docs/existing.html, but I think it probably deserves its own section.

The last page also mentions `@flow weak` which I'm not sure still works as described.

Nothing mentions `@noflow` yet. This mode should be thought of as something like `@flow suppress`, which parses the file as a Flow file (types are parsed) but suppresses all of the errors. This differs from the pragma missing entirely, which causes Flow to ignore the file. The reason it's `@noflow` instead of `@flow suppress` is because `@noflow` is not a prefix of `@flow`, so naive tooling can look for `@flow` without having to negative-match `suppress`.

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.