Redux: Documenter l'état de l'application

Créé le 11 janv. 2017 · 3Commentaires · Source: reduxjs/redux

Je travaille sur une application web React / Redux. Au début du projet, j'avais une très bonne compréhension de l'état de mon application. Mais, au fur et à mesure que la base de code grandit, j'ai tendance à mettre de plus en plus d'attributs sur l'état de l'application via des réducteurs. Le problème ici est que si une nouvelle personne rejoint mon projet, elle peut ne pas avoir une connaissance claire de tous les attributs qui sont déjà là dans l'état.

Pour le moment, j'utilise simplement un objet commenté dans un fichier appelé state.js pour décrire tous les attributs de l'état.

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

La question est la suivante : existe-t-il un meilleur moyen de documenter la structure de l'état de mon application afin qu'elle soit facile à comprendre ? Quelle approche utilisez-vous les gars?

Source

vraa

👍6

Commentaire le plus utile

En fonction de votre structure, je pense que wp-calypso fait un excellent travail là-dessus. Ils ont des sélecteurs, des réducteurs, des constantes, des actions et un fichier README.md qui contient la plupart de la documentation, tous dans le même répertoire. Regardez ci-dessous!

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

Vérifie-les!

JacobSoderblom le 17 janv. 2017

👍3

Tous les 3 commentaires

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

Vérifie-les!

JacobSoderblom le 17 janv. 2017

👍3

@JacobSoderblom c'est intéressant. Peut-être qu'une approche similaire avec une complexité et une structure réduites fonctionnera pour les applications à petite échelle. Merci.

vraa le 17 janv. 2017

Vous pouvez toujours utiliser un outil de développement Redux, comme redux-devtools ou redux-devtools-extension pour parcourir l'arborescence d'état. Vous pouvez également simplement JSON.stringify l'état à tout moment (je suggère de mettre le magasin sur window pour le rendre accessible via votre console) pour voir à quoi cela ressemble.