feat: initial commit

chenasraf · chenasraf · commit 3617ad396724 · 2024-04-09T14:30:51.000+03:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,9 @@
+[*]
+tab_width = 2
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,2 @@
+templates/
+scaffolds/
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,15 @@
+# These are supported funding model platforms
+
+github: chenasraf
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: casraf
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom:
+  [
+    'https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=TSH3C3ABGQM22&currency_code=ILS&source=url'
+  ]
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,13 @@
+# https://dart.dev/guides/libraries/private-files
+# Created by `dart pub`
+.dart_tool/
+
+# Avoid committing pubspec.lock for library packages; see
+# https://dart.dev/guides/libraries/private-files#pubspeclock.
+pubspec.lock
+
+# secrets
+.env
+
+# docs
+doc/
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,2 @@
+templates/
+scaffolds/
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,15 @@
+{
+  "printWidth": 100,
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "overrides": [
+    {
+      "files": "*.md",
+      "options": {
+        "printWidth": 100,
+        "proseWrap": "always"
+      }
+    }
+  ]
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,3 @@
+## 0.5.0
+
+- Initial version.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2023 Chen Asraf
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,69 @@
+# 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();
+
+print(coloredText);
+// ==> ColoredText("Hello, ", 0:0, , ()), ColoredText("world", 32:0, , ()), ColoredText("!", 0:0, , ())]
+
+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, ', fgColor: 0, bgColor: 0),
+  ColorToken(
+    text: 'world',
+    fgColor: 32,
+    bgColor: 0,
+    styles: {StyleByte.underline},
+  ),
+  ColorToken(text: '!', fgColor: 0, bgColor: 0),
+];
+
+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++;
+}
+```
+
+## 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!
+
+<a href='https://ko-fi.com/casraf' target='_blank'>
+  <img height='36' style='border:0px;height:36px;'
+    src='https://cdn.ko-fi.com/cdn/kofi1.png?v=3'
+    alt='Buy Me a Coffee at ko-fi.com' />
+</a>
+
+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.
diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -0,0 +1,30 @@
+# This file configures the static analysis results for your project (errors,
+# warnings, and lints).
+#
+# This enables the 'recommended' set of lints from `package:lints`.
+# This set helps identify many issues that may lead to problems when running
+# or consuming Dart code, and enforces writing Dart using a single, idiomatic
+# style and format.
+#
+# If you want a smaller set of lints you can change this to specify
+# 'package:lints/core.yaml'. These are just the most critical lints
+# (the recommended set includes the core lints).
+# The core lints are also what is used by pub.dev for scoring packages.
+
+include: package:lints/recommended.yaml
+
+# Uncomment the following section to specify additional rules.
+
+# linter:
+#   rules:
+#     - camel_case_types
+
+# analyzer:
+#   exclude:
+#     - path/to/excluded/files/**
+
+# For more information about the core and recommended set of lints, see
+# https://dart.dev/go/core-lints
+
+# For additional information about configuring this file, see
+# https://dart.dev/guides/language/analysis-options
diff --git a/example/example.dart b/example/example.dart
@@ -0,0 +1,50 @@
+import 'package:terminal_color_parser/terminal_color_parser.dart';
+
+void main(List<String> args) async {
+  final coloredText = ColorParser('Hello, \x1B[32mworld\x1B[0m!').parse();
+
+  print(coloredText);
+  // ==> ColoredText("Hello, ", 0:0, , ()), ColoredText("world", 32:0, , ()), ColoredText("!", 0:0, , ())]
+
+  var i = 0;
+  for (final token in coloredText) {
+    dbg(i, token);
+    i++;
+  }
+
+  print('');
+  print('');
+
+  // Construct your own colored text
+  final tokens = [
+    ColorToken(text: 'Hello, ', fgColor: 0, bgColor: 0),
+    ColorToken(
+      text: 'world',
+      fgColor: 32,
+      bgColor: 0,
+      styles: {TermStyle.underline},
+    ),
+    ColorToken(text: '!', fgColor: 0, bgColor: 0),
+  ];
+
+  i = 0;
+  for (final token in tokens) {
+    dbg(i, token);
+    i++;
+  }
+
+  print('');
+  print(tokens.map((t) => t.formatted).join(''));
+}
+
+void dbg(int i, ColorToken token) {
+  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}');
+}
+
diff --git a/lib/src/consts.dart b/lib/src/consts.dart
@@ -0,0 +1,102 @@
+class Consts {
+  /// A newline character.
+  static const newline = '\n';
+
+  /// A carriage return character.
+  static const cr = '\r';
+
+  /// A form feed character.
+  static const lf = '\n';
+
+  /// An escape character.
+  static const esc = '\x1B';
+
+  /// The pattern to match color codes.
+  static const colorPatternRaw = r'\[\d*m';
+
+  /// The byte to indicate reset text.
+  static const resetByte = 0;
+
+  /// The byte to indicate bold text.
+  static const boldByte = 1;
+
+  /// The byte to indicate dim text.
+  static const dimByte = 2;
+
+  /// The byte to indicate italic text.
+  static const italicByte = 3;
+
+  /// The byte to indicate underlined text.
+  static const underlineByte = 4;
+
+  /// The byte to indicate slow blinking text.
+  static const slowBlinkByte = 5;
+
+  /// The byte to indicate rapid blinking text.
+  static const rapidBlinkByte = 6;
+
+  /// The byte to indicate inverse text.
+  static const inverseByte = 7;
+
+  /// The byte to indicate concealed text.
+  static const concealByte = 8;
+
+  /// The byte to indicate strikethrough text.
+  static const strikeoutByte = 9;
+
+  /// The byte to indicate a font change.
+  static const fontByte = 10;
+
+  /// Map of style bytes to their corresponding integer values.
+  static final codeMap = <TermStyle, int>{
+    TermStyle.reset: resetByte,
+    TermStyle.bold: boldByte,
+    TermStyle.dim: dimByte,
+    TermStyle.italic: italicByte,
+    TermStyle.underline: underlineByte,
+    TermStyle.slowBlink: slowBlinkByte,
+    TermStyle.rapidBlink: rapidBlinkByte,
+    TermStyle.inverse: inverseByte,
+    TermStyle.conceal: concealByte,
+    TermStyle.strikeout: strikeoutByte,
+    TermStyle.font: fontByte,
+  };
+}
+
+/// Enum representing the different style bytes.
+/// This is an incomplete, but representative list.
+enum TermStyle {
+  /// Reset all styles.
+  reset,
+
+  /// Bold text.
+  bold,
+
+  /// Dim/low intensity text.
+  dim,
+
+  /// Italic text.
+  italic,
+
+  /// Underlined text.
+  underline,
+
+  /// Slow blinking text.
+  slowBlink,
+
+  /// Rapid blinking text.
+  rapidBlink,
+
+  /// Inverse text colors (swap foreground and background colors).
+  inverse,
+
+  /// Concealed text (hidden).
+  conceal,
+
+  /// Strikethrough text.
+  strikeout,
+
+  /// Change font.
+  font,
+}
+
diff --git a/lib/src/interfaces.dart b/lib/src/interfaces.dart
@@ -0,0 +1,24 @@
+/// An interface for reading data of type T.
+abstract class IReader<T> {
+  /// Reads the next element of type T from the data source.
+  /// Returns the element read, or null if the end of the data source is reached.
+  T? read();
+
+  /// Peeks at the next element of type T from the data source without advancing the position.
+  /// Returns the element peeked at, or null if the end of the data source is reached.
+  T? peek();
+
+  /// Returns the total length of the data source.
+  int get length;
+
+  /// Returns the current index position in the data source.
+  int get index;
+
+  /// Returns true if the end of the data source has been reached, false otherwise.
+  bool get isDone;
+
+  /// Sets the current index position in the data source to the specified value.
+  ///
+  /// @param originalIndex The index position to set.
+  void setPosition(int originalIndex);
+}
diff --git a/lib/src/parser.dart b/lib/src/parser.dart
diff --git a/lib/src/reader.dart b/lib/src/reader.dart
diff --git a/lib/src/token.dart b/lib/src/token.dart
diff --git a/lib/terminal_color_parser.dart b/lib/terminal_color_parser.dart
diff --git a/pubspec.yaml b/pubspec.yaml
diff --git a/test/color_parser_test.dart b/test/color_parser_test.dart

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## 0.5.0`
	`2`	`+`
	`3`	`+- Initial version.`