Add support for NO_COLOR environment variable #835

New Issue

Closed

opened 2024-03-03 12:30:02 +00:00 by bubbleguuum · 10 comments

bubbleguuum commented 2024-03-03 12:30:02 +00:00

Copy Link

What I'd like to do and why

For details see:

https://no-color.org/

Other notes / implementation ideas

No response

### What I'd like to do and why For details see: https://no-color.org/ ### Other notes / implementation ideas _No response_

witten commented 2024-03-03 17:21:27 +00:00

Owner

Copy Link

Makes sense to me! In the meantime, check out these docs on disabling color if you haven't already.

Makes sense to me! In the meantime, check out [these docs on disabling color](https://torsion.org/borgmatic/docs/how-to/set-up-backups/#colored-output) if you haven't already.

shivansh02 commented 2024-03-03 20:40:14 +00:00

Copy Link

Seems straightforward, I can do this.

Seems straightforward, I can do this.

👍 1

witten added the

good first issue

label 2024-03-03 23:42:27 +00:00

shivansh02 commented 2024-03-04 03:18:26 +00:00

Copy Link

@witten Should I give preference to PY_COLORS or NO_COLOR in case both are set?
Please refer to should_do_markup in logger.py.

@witten Should I give preference to `PY_COLORS` or `NO_COLOR` in case both are set? Please refer to `should_do_markup` in `logger.py`.

witten commented 2024-03-04 03:35:26 +00:00

Owner

Copy Link

Good question! I'd recommend preferring NO_COLOR just because it seems a little more popular in a global GitHub search.

Some related background reading is here: https://github.com/Textualize/rich/issues/343

Good question! I'd recommend preferring `NO_COLOR` just because it seems a little more popular in a global GitHub search. Some related background reading is here: https://github.com/Textualize/rich/issues/343

👍 1

witten referenced this issue from a commit 2024-03-04 21:51:15 +00:00

Support for NO_COLOR environment variable (#835).

witten referenced this issue from a commit 2024-03-04 21:51:15 +00:00

Add NO_COLOR support to NEWS (#835).

witten commented 2024-03-11 20:30:22 +00:00

Owner

Copy Link

Released in borgmatic 1.8.9!

Released in borgmatic 1.8.9!

👍 1

witten closed this issue 2024-03-12 03:59:58 +00:00

bubbleguuum commented 2024-03-13 14:48:59 +00:00

Author

Copy Link

Minor nitpick: if NO_COLOR is defined and empty it disables color while according to spec it should not:

~> NO_COLOR= borgmatic list
ANSWER:borgmatic.actions.list:kimsufi: Listing archives

The spec from no-color.org:

Command-line software which adds ANSI color to its output by default should check for a NO_COLOR environment variable that, when present and not an empty string (regardless of its value), prevents the addition of ANSI color.

Also, without color, lines are prefixed with some text (in that example: ANSWER:borgmatic.actions.list) not present with color. I suppose it is intended since -nc results in the same output but was a bit surprised to see these prefixes.

Minor nitpick: if NO_COLOR is defined and empty it disables color while according to spec it should not: ``` ~> NO_COLOR= borgmatic list ANSWER:borgmatic.actions.list:kimsufi: Listing archives ``` The spec from no-color.org: Command-line software which adds ANSI color to its output by default should check for a NO_COLOR environment variable that, when present **and not an empty string** (regardless of its value), prevents the addition of ANSI color. Also, without color, lines are prefixed with some text (in that example: `ANSWER:borgmatic.actions.list`) not present with color. I suppose it is intended since -nc results in the same output but was a bit surprised to see these prefixes.

witten commented 2024-03-13 16:24:45 +00:00

Owner

Copy Link

Good catch! Thank you for pointing this out.

Good catch! Thank you for pointing this out.

witten referenced this issue from a commit 2024-03-13 16:35:40 +00:00

Fix handling of the NO_COLOR environment variable to ignore an empty value (#835).

witten commented 2024-03-13 16:35:44 +00:00

Owner

Copy Link

This has been fixed in main!

This has been fixed in main!

bubbleguuum commented 2024-03-13 19:34:24 +00:00

Author

Copy Link

Thanks !

I created a PR to the no-color git repo, so borgmatic become listed on no-color.org:

https://github.com/jcs/no_color/pull/279

Thanks ! I created a PR to the no-color git repo, so borgmatic become listed on no-color.org: https://github.com/jcs/no_color/pull/279

👍 1

witten commented 2024-03-13 19:42:45 +00:00

Owner

Copy Link

Awesome, thank you!

Awesome, thank you!

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

main

spot-check

1.8.10

1.8.9

1.8.8

1.8.7

1.8.6

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.15

1.7.14

1.7.13

1.7.12

1.7.11

1.7.10

1.7.9

1.7.8

1.7.7

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.24

1.5.23

1.5.22

1.5.21

1.5.20

1.5.19

1.5.18

1.5.17

1.5.16

1.5.15

1.5.14

1.5.13

1.5.12

1.5.11

1.5.10

1.5.9

1.5.8

1.5.7

1.5.7.dev0

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.22

1.4.21

1.4.20

1.4.19

1.4.18

1.4.17

1.4.16

1.4.15

1.4.14

1.4.13

1.4.12

1.4.11

1.4.10

1.4.9

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.26

1.3.25

1.3.24

1.3.23

1.3.22

1.3.21

1.3.20

1.3.19

1.3.18

1.3.17

1.3.16

1.3.15

1.3.14

1.3.13

1.3.12

1.3.11

1.3.10

1.3.9

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.18

1.2.17

1.2.16

1.2.15

1.2.14

1.2.13

1.2.12

1.2.11

1.2.10

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.15

1.1.14

1.1.13

1.1.12

1.1.11

1.1.10

1.1.9

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.3

1.0.2

1.0.1

1.0.0

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

Labels

Clear labels   

bug

  

data loss

  

design finalized

  

good first issue

  

new feature area

  

question / support

  

security

  

waiting for response

No Label

bug

data loss

design finalized

good first issue

new feature area

question / support

security

waiting for response

Milestone

Clear milestone

No items

No Milestone

Assignees

Clear assignees

No Assignees

3 Participants

Notifications

Subscribe

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: borgmatic-collective/borgmatic#835

No description provided.