https://github.com/chenasraf/terminal_color_parser_dart
Parse terminal colors for displaying in other formats. Supports ANSI and xterm256.
https://github.com/chenasraf/terminal_color_parser_dart
Last synced: 4 months ago
JSON representation
Parse terminal colors for displaying in other formats. Supports ANSI and xterm256.
- Host: GitHub
- URL: https://github.com/chenasraf/terminal_color_parser_dart
- Owner: chenasraf
- License: mit
- Created: 2024-04-09T10:42:19.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-01-10T23:12:41.000Z (over 1 year ago)
- Last Synced: 2025-07-17T13:47:22.034Z (11 months ago)
- Language: Dart
- Homepage: https://pub.dev/packages/terminal_color_parser
- Size: 34.2 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Terminal Color Parser
This package is an ANSI/xterm256 color parser. You can get the list of colored segments by creating
a `ColorParser` instance and calling `parse()` method.
```dart
import 'package:terminal_color_parser/terminal_color_parser.dart';
final coloredText = ColorParser('Hello, \x1B[32mworld\x1B[0m!').parse();
var i = 0;
for (final token in coloredText) {
print('Token #$i: ${token.formatted}');
print(' - Text: ${token.text}');
print(' - Foreground: ${token.fgColor}');
print(' - Background: ${token.bgColor}');
print(' - Bold: ${token.bold}');
print(' - Italic: ${token.italic}');
print(' - Underline: ${token.underline}');
print(' - Styles: ${token.styles}');
i++;
}
```
You can also re-format the ANSI codes by using the `formatted` property on each token.
```dart
final tokens = [
ColorToken(text: 'Hello, '),
ColorToken(
text: 'world',
fgColor: ANSIColor.fg(32), // Can also use RGBColor.fg(r, g, b)
bgColor: Color.none,
styles: {StyleByte.underline},
),
ColorToken(text: '!'),
];
var i = 0;
for (final token in coloredText) {
print('Token #$i: ${token.formatted}');
print(' - Text: ${token.text}');
print(' - Foreground: ${token.fgColor.formatted}');
print(' - Background: ${token.bgColor.formatted}');
print(' - Bold: ${token.bold}');
print(' - Italic: ${token.italic}');
print(' - Underline: ${token.underline}');
print(' - Styles: ${token.styles}');
i++;
}
```
## Contributing
I am developing this package on my free time, so any support, whether code, issues, or just stars is
very helpful to sustaining its life. If you are feeling incredibly generous and would like to donate
just a small amount to help sustain this project, I would be very very thankful!
I welcome any issues or pull requests on GitHub. If you find a bug, or would like a new feature,
don't hesitate to open an appropriate issue and I will do my best to reply promptly.