Redux: Documentar el estado de la aplicación

Creado en 11 ene. 2017 · 3Comentarios · Fuente: reduxjs/redux

Estoy trabajando en una aplicación web React / Redux. Al comienzo del proyecto, comprendí muy bien el estado de mi solicitud. Pero, a medida que crece la base del código, tiendo a poner más y más atributos al estado de la aplicación a través de reductores. El problema aquí es que, si una nueva persona se une a mi proyecto, es posible que no tenga un conocimiento claro sobre todos los atributos que ya existen en el estado.

En este momento, solo estoy usando un Objeto comentado en un archivo llamado state.js para describir todos los atributos en el estado.

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

La pregunta es: ¿Existe una mejor manera de documentar la estructura del estado de mi aplicación para que sea fácil de entender? ¿Qué enfoque usan ustedes?

Fuente

vraa

👍6

Comentario más útil

Dependiendo de su estructura, creo que wp-calypso hace un gran trabajo en eso. Tienen selectores, reductores, constantes, acciones y un archivo README.md que contiene la mayor parte de la documentación, todos ellos en el mismo directorio. ¡Mira abajo!

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

¡Échales un vistazo!

JacobSoderblom en 17 ene. 2017

👍3

Todos 3 comentarios

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

¡Échales un vistazo!

JacobSoderblom en 17 ene. 2017

👍3

@JacobSoderblom eso es interesante. Puede ser un enfoque similar con una complejidad y estructura reducidas que funcionará para aplicaciones de pequeña escala. Gracias.

vraa en 17 ene. 2017

Siempre puede usar un devtool de Redux, como redux-devtools o redux-devtools-extension para navegar por el árbol de estado. También puede simplemente JSON.stringify el estado en cualquier momento (sugiero poner la tienda en window para que sea accesible a través de su consola) para ver cómo se ve.