Référence › Commandes › Refactor

Référence › Commandes

Refactoriser

Les réécritures qui changent la façon d’écrire un modèle, mais pas ce qu’il veut dire.

Commandes : archec refactor

Ces réécritures laissent le projet identique : chacune n’écrit rien si le projet ne se construit pas à l’identique. Les anciens noms (archec move-traces, archec name-components, archec translations, archec extract-component) fonctionnent encore, avec une note.

Commande Ce qu’elle fait
archec refactor translations <main.arche> --extract <lang> [-o file] [--dry-run] Les traductions en ligne d’une langue ("Démarrer" en "Start") déplacées dans un seul fichier translations en { … }, inclus par le fichier principal. Les fichiers du modèle se lisent alors dans une seule langue. Un texte est désigné par sa place (REQ-1.text) ou, quand aucun chemin ne le désigne (une étape de séquence, une branche, une procédure), par ce qu’il dit ("texte" "text"). Les entrées sont regroupées sous le fichier d’où elles viennent. Un texte reste où il est quand il a plusieurs langues, ou quand les mêmes mots sont aussi écrits sans traduction (une entrée désignée par ses mots les traduirait aussi). Écrit seulement si le projet se construit à l’identique.
archec refactor name-components <main.arche> [--dry-run] Un composant qu’un import a nommé par son identifiant Arche (c-1793752253957) reçoit un nom tiré de son label (component flash_memory "FLASH_MEMORY" as c-1793752253957), et chaque chemin qui le désigne utilise ce nom. L’identifiant reste celui d’Arche. Écrit seulement si le projet se construit à l’identique.
archec refactor move-traces <main.arche> [--dry-run] [--list] Chaque trace écrite à part est déplacée là où elle commence : verifies sur le cas, le plan ou le scénario, satisfies sur la part, refines sur l’exigence, avec son identifiant (verifies REQ-1 as t-7). Une adresse écrite comme une chaîne devient un chemin quand elle désigne un élément du projet. Écrit seulement si le projet produit les mêmes traces. --list explique pourquoi chacune des autres reste en place.
archec refactor extract-component <main.arche> <A.b> [--name Def] [--also A.c,A.d] [--folder dir] [--dry-run] Un composant déplacé dans la bibliothèque de composants : un dossier à lui, que l’on peut copier dans d’autres projets. Rien ne change si le projet ne se construit pas à l’identique.
archec refactor move-definition <main.arche> <Name> --to <file.arche> [--kind component] [--dry-run] Une définition de premier niveau — un composant, un message, une struct, un enum, un type, une interface, une const, une exigence, un système… — coupée de son fichier avec ses lignes /// et écrite à la fin d’un autre fichier, ou dans un nouveau. include "<file>" est ajouté quand le fichier principal n’atteint pas encore la cible : dans le fichier où était la définition, ou dans le fichier principal quand la cible elle-même inclut ce fichier (pas de cycle d’include). Une définition d’un package est écrite dans package <name> { … } dans la cible, pour qu’elle garde son paquet. Un fichier d’une bibliothèque, du store ou de la bibliothèque standard n’est ni source ni cible. Le projet est compilé tel qu’il est et tel qu’il serait, en mémoire : les mêmes déclarations, les mêmes erreurs et avertissements, le même projet construit (l’ordre de ses éléments suit les fichiers, et peut changer) — sinon rien n’est écrit et la première différence est dite : un code "x.py" déplacé dans un autre dossier nommerait un autre fichier, une exigence quitterait les defaults de son fichier, un fichier que le projet n’inclut pas encore apporterait ses propres déclarations. --kind dit lequel quand deux sortes partagent le nom ; --dry-run affiche le diff. Le code généré n’a besoin de rien : une région USER CODE est nommée d’après l’élément, pas son fichier. Dans VS Code : clic droit → Move Definition to a File…, dans l’éditeur (sur la définition ou sur un de ses usages) et sur un bloc du diagramme.