stackabletech / stackabletech/stackablectl

feat: Implement colored output (with `NO_COLOR` support)

Ouverte
#145 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Rust
Étoiles
10
Forks
5
Merge moyen
4 h 41 min
PR mergées (30 j)
4

Description

Colours sould only be enabled when the terminal supports them.
For example, when redirecting output or piping to cat, there should be no escape sequences.

I believe there needs to be a condition around the pretty method (or maybe it should be handled by tracing_subscriber::fmt):

https://github.com/stackabletech/stackable-cockpit/blob/fe37d494359d91e32ae309a9f6d382b4a486c5a0/rust/stackablectl/src/main.rs#L31

Examples:

stackablectl --log-level=DEBUG stack list > /tmp/stackablectl.stdout       # plain redirect
stackablectl --log-level=DEBUG stack list | cat > /tmp/stackablectl.stdout # pipe through cat
TERM= stackablectl --log-level=DEBUG stack list > /tmp/stackablectl.stdout # explicitly set TERM to nothing

If I open it in VIM, it looks like this:

image

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez dans rust/stackablectl/src/main.rs autour de la méthode pretty indiquée et comparez si tracing_subscriber::fmt devrait gérer la détection du terminal. Exécutez les commandes stackablectl indiquées avec une sortie redirigée et acheminée par pipe, y compris avec un TERM vide, et confirmez que la sortie non interactive ne contient aucune séquence d’échappement, tandis que la sortie d’un terminal compatible reste colorée et que NO_COLOR est respecté.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
rust
Domaine
cli
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
50/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.