Redux: Documentando o estado do aplicativo

Criado em 11 jan. 2017 · 3Comentários · Fonte: reduxjs/redux

Estou trabalhando em um aplicativo da web React / Redux. No início do projeto, entendi muito bem o estado do meu aplicativo. Mas, conforme a base de código cresce, eu tendo a colocar mais e mais atributos no estado do aplicativo por meio de redutores. O problema aqui é, se uma nova pessoa ingressar no meu projeto, ela pode não ter um conhecimento claro sobre todos os atributos que já existem no estado.

No momento, estou apenas usando um objeto comentado em um arquivo chamado state.js para descrever todos os atributos no estado.

/*
    APP_STATE = {
        attribute1 : '',
        attribute2 : '',
        attribute3 : [],
        attribute4 : {
            key: ''
        },
    }
*/

A questão é: há uma maneira melhor de documentar a estrutura do estado do meu aplicativo para que seja fácil de fazer sentido? Que abordagem vocês usam?

Fonte

vraa

👍6

Comentários muito úteis

Dependendo da sua estrutura, acho que wp-calypso faz um ótimo trabalho nisso. Eles têm seletores, redutores, constantes, ações e um arquivo README.md que contém a maior parte da documentação, todos no mesmo diretório. Olhe abaixo!

  product
    reducer.js
    selectors.js
    actions.js
    constants.js
    README.md

Vê-los!

JacobSoderblom em 17 jan. 2017

👍3

Todos 3 comentários

  product
    reducer.js
    selectors.js
    actions.js
    constants.js
    README.md

Vê-los!

JacobSoderblom em 17 jan. 2017

👍3

@JacobSoderblom isso é interessante. Pode ser uma abordagem semelhante com complexidade e estrutura reduzidas funcionará para aplicativos de pequena escala. Obrigado.

vraa em 17 jan. 2017

Você sempre pode usar um devtool Redux, como redux-devtools ou redux-devtools-extension para navegar na árvore de estado. Você também pode apenas JSON.stringify o estado a qualquer momento (sugiro colocar a loja em window para torná-la acessível através de seu console) para ver como fica.