Skip to content

Allow disabling colors #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adhocore merged 10 commits into from
Dec 1, 2024
Merged

Allow disabling colors #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e1d2bc8
Allow disabling colors
kodie Nov 28, 2024
e484ad6
Make a public static variable
kodie Nov 28, 2024
d30bd49
Add documentation about disabling colors to readme
kodie Nov 28, 2024
c172fce
Remove empty line
kodie Nov 28, 2024
e6097da
Don't worry about missing styles if colors are disabled
kodie Nov 28, 2024
d7dd0ec
Short-circut the missing method the same way we do line function
kodie Nov 28, 2024
dbd3078
Rename Color's variable to just as we do camelcase here
kodie Nov 28, 2024
1b56cc0
Merge branch 'main' into kodie/allow-color-disabling
adhocore Nov 30, 2024
4e37cc2
Check if NO_COLOR is set when writing to the terminal
kodie Dec 1, 2024
06c2907
Add info about NO_COLOR environment variable to readme
kodie Dec 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,6 +508,14 @@ Ahc\Cli\Output\Color::style('error', [
]);
```

#### Disable colors

```php
Ahc\Cli\Output\Color::$enabled = false;
```

Colors will be automatically disabled if the `NO_COLOR` environment variable is set to true.

### Cursor

Move cursor around, erase line up or down, clear screen.
Expand Down
10 changes: 10 additions & 0 deletions src/Output/Color.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ class Color
const GRAY = 47;
const DARKGRAY = 100;

public static bool $enabled = true;

protected string $format = "\033[:mod:;:fg:;:bg:m:txt:\033[0m";

/** @var array Custom styles */
Expand Down Expand Up @@ -138,6 +140,10 @@ public static function fg256(int $code): string
*/
public function line(string $text, array $style = []): string
{
if (!self::$enabled || getenv('NO_COLOR')) {
return $text;
}

$style += ['bg' => null, 'fg' => static::WHITE, 'bold' => 0, 'mod' => null];

$format = $style['bg'] === null
Expand Down Expand Up @@ -229,6 +235,10 @@ public function __call(string $name, array $arguments): string
}

if (!method_exists($this, $name)) {
if (!self::$enabled || getenv('NO_COLOR')) {
return $text;
}

throw new InvalidArgumentException(sprintf('Style "%s" not defined', $name));
}

Expand Down