documentationjs / documentationjs/documentation
Support for ".js.flow” style workflow?
- Lingua principale
- JavaScript
- Stelle
- 5.8k
- Fork
- 481
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
Curious.
Is there currently a way to get proper documentation from a ".js.flow" based project workflow, as documented [here](https://flowtype.org/docs/declarations.html#declaration-files)?
My personal library project is organised in the following manner:
- Per function/class module files (``puts.js`` in this specific case) with the following syntax:
```js
/**
* This is a function
*/
function puts(str) {
// do some stuff
}
module.exports = puts;
```
- A ``main.js`` cumulating all the existing modules, exposing them as one
```js
module.exports = {
puts: require("./src/puts")
}
```
- A ``main.js.flow`` declaring all the typings.
```js
declare export function puts(str: string): void;
```
What I expect to see is something akin to
> puts(str: string)
**Parameters**
str (string)
What ``documentation build main.js -f html -o docs`` actually produces is:
> puts(str: any)
**Parameters**
str (any)
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Riproduci il problema con i file puts.js, main.js e main.js.flow mostrati usando `documentation build main.js -f html -o docs`. Poi traccia il modo in cui il comando di documentazione legge le dichiarazioni e confronta l'output generato di `puts(str: any)` con il tipo string previsto. Il lavoro è completato quando il workflow .js.flow produce la documentazione dei parametri tipizzati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript
- Ambito
- documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 30/100