Comment utiliser GraphQL Formatter en français

À quoi sert cet outil ?

GraphQL Formatter accepte le texte d’une requête GraphQL ou d’un schéma GraphQL. Son comportement actuel impose toutefois une distinction importante : une entrée vide ou composée uniquement d’espaces aboutit à un résultat vide, tandis qu’une demande de mise en forme contenant du texte échoue avant de renvoyer un texte formaté. Cet outil est donc surtout utile pour vérifier le comportement d’une entrée vide ou pour constater cette limite avant d’intégrer un autre flux de travail.

Procédure

1. Préparez votre contenu sous forme de texte : une requête GraphQL ou un schéma GraphQL. Évitez de transmettre une valeur d’un autre type. Après la sélection éventuelle d’un nom d’entrée compatible, une valeur qui n’est pas une chaîne échoue au lieu d’être formatée.

2. Pour une vérification de l’entrée vide, laissez le champ sans contenu ou saisissez uniquement des espaces. Cette branche renvoie un texte formaté vide. Les valeurs fournies pour le mode et l’indentation restent alors telles quelles, sans normalisation, et les tailles d’entrée et de sortie sont nulles.

3. Si vous testez une entrée non vide, vous pouvez utiliser le mode par défaut beautify. Une indentation de deux espaces par niveau est la valeur par défaut lorsque cette entrée atteint l’étape de normalisation. Une valeur d’indentation négative, supérieure à huit ou impossible à convertir revient à deux espaces. La valeur minify sélectionne la voie de minification ; les autres valeurs suivent la voie d’embellissement.

4. Lancez le traitement et examinez le résultat plutôt que de supposer qu’un texte GraphQL sera renvoyé. Avec le comportement actuel, une chaîne non vide qui passe les contrôles de type et de taille échoue pendant le traitement, aussi bien avec beautify qu’avec minify. Une entrée dont l’encodage UTF-8 dépasse 1 000 000 d’octets échoue également au lieu d’être formatée.

Comprendre le résultat et ses limites

Un résultat vide avec des tailles d’entrée et de sortie à zéro correspond à l’entrée vide ou composée d’espaces ; il ne constitue pas une requête GraphQL mise en forme. Pour une requête ou un schéma contenant du texte, l’absence de texte formaté est le résultat attendu dans l’état actuel du traitement, et non la preuve que le document est incorrect.

Le traitement ne doit pas être interprété comme une validation, une analyse syntaxique, une exécution ou une confirmation de la validité de GraphQL. Même la voie minify, qui prévoit de supprimer certains commentaires commençant par le caractère #, de réduire les espaces et d’ajuster ceux autour de plusieurs signes, n’aboutit pas à un résultat pour une entrée ordinaire non vide. Il faut donc conserver la source séparément et ne pas remplacer un document de travail par une sortie supposée formatée.

Exemple pratique

Une personne veut vérifier le comportement de l’outil avant de lui transmettre une requête GraphQL réelle et saisit trois espaces comme contenu.

Laissez l’entrée composée uniquement d’espaces, conservez les valeurs de mode et d’indentation proposées, puis lancez le traitement.

Le résultat contient un texte formaté vide ; les tailles d’entrée et de sortie indiquées valent 0, tandis que le mode et l’indentation restent les valeurs fournies.

Limites

• Les requêtes et schémas non vides n’aboutissent actuellement pas à un texte formaté, quel que soit le chemin de mise en forme sélectionné.
• Le résultat ne doit pas être utilisé comme validation GraphQL ; la voie de minification prévoit des transformations de texte, mais échoue avant de renvoyer une sortie pour une entrée ordinaire non vide.

Erreurs fréquentes

• Cause : une valeur non textuelle est transmise, ou une valeur principale fausse est remplacée par un alias contenant une valeur non compatible. Correction : transmettez directement une chaîne contenant la requête ou le schéma GraphQL et vérifiez le type de la valeur utilisée.
• Cause : le contenu dépasse 1 000 000 d’octets en encodage UTF-8. Correction : réduisez le contenu avant l’envoi, puis contrôlez de nouveau sa taille.

Questions fréquentes

GraphQL Formatter formate-t-il une requête non vide ?

Une entrée vide ou composée uniquement d’espaces est acceptée et produit un texte formaté vide. Une requête ou un schéma contenant du texte échoue actuellement avant le renvoi d’un résultat formaté.

Le résultat prouve-t-il que mon GraphQL est valide ?

Non. Le traitement ne confirme ni la validité, ni la syntaxe, ni l’exécution d’un document GraphQL. Un résultat vide correspond à la branche d’entrée vide, pas à une validation réussie.

Que se passe-t-il si je choisis minify ?

La valeur minify sélectionne la voie de minification, tandis que les autres valeurs suivent la voie d’embellissement. Pour une entrée ordinaire non vide, ces deux voies échouent avant de renvoyer un texte formaté.