Everyday useUsage courant

xstyle                        # the current directory, recursive, every known language
xstyle src/core/Engine.cpp    # one file
xstyle -r src include         # these directories (recursive with -r)
xstyle -e build,*.gen.hpp     # skip more paths (folder name, path prefix or glob)

With no path the current directory is scanned recursively. Hidden folders, build*, cmake-build-*, third_party, extern, vendor, node_modules and the generated_* files are always skipped.

Each issue is printed with its file, line and column (a terminal link), the rule broken, its fix level and the fix proposed; the summary counts the issues by severity and by rule.

xstyle                        # le dossier courant, récursif, tous les langages connus
xstyle src/core/Engine.cpp    # un fichier
xstyle -r src include         # ces dossiers (récursif avec -r)
xstyle -e build,*.gen.hpp     # ignorer d'autres chemins (nom de dossier, préfixe ou glob)

Sans chemin, le dossier courant est parcouru récursivement. Les dossiers cachés, build*, cmake-build-*, third_party, extern, vendor, node_modules et les fichiers generated_* sont toujours ignorés.

Chaque problème est affiché avec son fichier, sa ligne et sa colonne (un lien du terminal), la règle enfreinte, son niveau de fix et la correction proposée ; le résumé compte les problèmes par sévérité et par règle.

xstyle --fix                           # every safe fix ([auto-fix])
xstyle --fix CPP-NULL,G-TRAILING src   # only these rules, only in src
xstyle -f -n -c CPP -r src/core        # preview (dry run) of the C++ fixes of one directory
xstyle --fix --force                   # also the [force-fix] ones: check with -n first
xstyle --fix --dangerous-force         # also the [danger-fix] ones: guessed, can be wrong
xstyle --fix --header default          # missing file headers with the XARTANIA banner, no question

The logic of the code is never touched; review the result with git diff. How the fix loop works.

xstyle --fix                           # toutes les corrections sûres ([auto-fix])
xstyle --fix CPP-NULL,G-TRAILING src   # seulement ces règles, seulement dans src
xstyle -f -n -c CPP -r src/core        # aperçu (dry run) des corrections C++ d'un dossier
xstyle --fix --force                   # aussi les [force-fix] : vérifier avec -n d'abord
xstyle --fix --dangerous-force         # aussi les [danger-fix] : devinées, peuvent être fausses
xstyle --fix --header default          # en-têtes manquants avec la bannière XARTANIA, sans question

La logique du code n'est jamais touchée ; relire le résultat avec git diff. Comment marche la boucle de correction.

xstyle -o report.md             # .txt, .md or .json, nothing in the terminal
xstyle -s major -o report.json  # major and above, for a script

--format text|md|json forces the format when the extension does not tell it.

xstyle -o report.md             # .txt, .md ou .json, rien dans le terminal
xstyle -s major -o report.json  # major et plus, pour un script

--format text|md|json force le format quand l'extension ne le dit pas.

xstyle --rtk (or XSTYLE_RTK=1) prints what an assistant needs and nothing else: about 5 times fewer tokens.

# >file then line:col CODE severity(U/M/m/n) fix(a=auto f=--force d=--dangerous-force q=asked -=manual) ...
>a.hpp
3:33 CPP-THIS m a
* CPP-THIS Member accessed without this-> => int get(void) const {return this->_name;};
= 1 issues in 1 files: U0 M0 m1 n0 | fix a1 f0 d0 q0 -0 | xstyle --fix

A legend line, >file once, one line:col CODE severity fix line per issue, the message and fix of each rule once in a * CODE line, the summary on one line. No color, link, source line nor table.

xstyle --rtk (ou XSTYLE_RTK=1) n'affiche que ce dont un assistant a besoin : environ 5 fois moins de tokens.

# >file then line:col CODE severity(U/M/m/n) fix(a=auto f=--force d=--dangerous-force q=asked -=manual) ...
>a.hpp
3:33 CPP-THIS m a
* CPP-THIS Member accessed without this-> => int get(void) const {return this->_name;};
= 1 issues in 1 files: U0 M0 m1 n0 | fix a1 f0 d0 q0 -0 | xstyle --fix

Une ligne de légende, >fichier une fois, une ligne ligne:col CODE sévérité fix par problème, le message et la correction de chaque règle une seule fois dans une ligne * CODE, le résumé sur une ligne. Ni couleur, ni lien, ni ligne de source, ni tableau.