feat: release v1.1.0

.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+    "cSpell.words": [
+        "doublestruck",
+        "figlet",
+        "fullwidth",
+        "grayscale",
+        "hardblank",
+        "hardblanks",
+        "smush",
+        "smushed",
+        "Smushes",
+        "smushing",
+        "strikethrough"
+    ]
+}

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.1.0
+- update dependencies and improve documentation
+
 ## 1.0.0
 - `enough_ascii_art` is now [null safe](https://dart.dev/null-safety/tour) #127
 - removed integration of fonts, as this is not supported by Dart

analysis_options.yaml

@@ -1,14 +1 @@
-# Defines a default set of lint rules enforced for
-# projects at Google. For details and rationale,
-# see https://github.com/dart-lang/pedantic#enabled-lints.
-include: package:pedantic/analysis_options.yaml
-
-# For lint rules and documentation, see http://dart-lang.github.io/linter/lints.
-# Uncomment to specify additional rules.
-# linter:
-#   rules:
-#     - camel_case_types
-
-analyzer:
-#   exclude:
-#     - path/to/excluded/files/**
+include: package:lints/recommended.yaml

lib/enough_ascii_art.dart

@@ -3,13 +3,12 @@
 /// Brought to you by 𝔼𝕟𝕠𝕦𝕘𝕙 𝕊𝕠𝕗𝕥𝕨𝕒𝕣𝕖
 library enough_ascii_art;
 
-import 'package:enough_ascii_art/src/figlet/figlet.dart';
-import 'package:enough_ascii_art/src/figlet/font.dart';
-import 'package:enough_ascii_art/src/unicode_font_converter.dart';
 import 'package:image/image.dart';
 import 'src/figlet/figlet.dart';
+import 'src/figlet/font.dart';
 import 'src/image_converter.dart';
 import 'src/emoticon_converter.dart';
+import 'src/unicode_font_converter.dart';
 
 export 'src/image_converter.dart';
 export 'src/emoticon_converter.dart';
@@ -25,22 +24,26 @@ const String _asciiGrayScaleCharacters = '#@%=+*:-. ';
 ///
 /// [image] the image to be converted
 /// [maxWidth] the optional maximum width of the image in characters, defaults to 80
-/// [maxHeight] the optional maximum height of th eimage in characters, defaults to null, so the image is caled linearily
-/// [charSet] the optional charset from darkest to lightest character, defaults to '#@%=+*:-. '
-/// [invert] allows to invert pixels, so that a dark pixel gets a bright characater and vise versa. This is useful when printing bight text on a dark background (console). Defaults to false.
+/// [maxHeight] the optional maximum height of th image in characters, defaults to null, so the image is called linearly
+/// [charset] the optional charset from darkest to lightest character, defaults to '#@%=+*:-. '
+/// [invert] allows to invert pixels, so that a dark pixel gets a bright character and vise versa. This is useful when printing bight text on a dark background (console). Defaults to false.
 /// [fontHeightCompensationFactor] the optional factor between 0 and 1 that is used to adjust the height of the image. Most fonts have a greater height than width, so this factor allows to compensate this. Defaults to 0.6.
-String convertImage(Image image,
-    {int maxWidth = 80,
-    int? maxHeight,
-    String charset = _asciiGrayScaleCharacters,
-    bool invert = false,
-    double fontHeightCompensationFactor = 0.6}) {
-  return ImageConverter.convertImage(image,
-      maxWidth: maxWidth,
-      maxHeight: maxHeight,
-      charset: charset,
-      invert: invert,
-      fontHeightCompensationFactor: fontHeightCompensationFactor);
+String convertImage(
+  Image image, {
+  int maxWidth = 80,
+  int? maxHeight,
+  String charset = _asciiGrayScaleCharacters,
+  bool invert = false,
+  double fontHeightCompensationFactor = 0.6,
+}) {
+  return ImageConverter.convertImage(
+    image,
+    maxWidth: maxWidth,
+    maxHeight: maxHeight,
+    charset: charset,
+    invert: invert,
+    fontHeightCompensationFactor: fontHeightCompensationFactor,
+  );
 }
 
 /// Replaces all common smileys with their ASCII representation
@@ -52,15 +55,21 @@ String convertEmoticons(String text,
   return EmoticonConverter.convertEmoticons(text, style);
 }
 
-/// Rendes the given [text] in the specified [font].
+/// Renders the given [text] in the specified [font].
 ///
-/// Optionally specify the [direction], which defaults to [FigletRenderDirection.LeftToRight]
-String renderFiglet(String text, Font font,
-    {FigletRenderDirection direction = FigletRenderDirection.LeftToRight}) {
+/// Optionally specify the [direction], which defaults to [FigletRenderDirection.leftToRight]
+String renderFiglet(
+  String text,
+  Font font, {
+  FigletRenderDirection direction = FigletRenderDirection.leftToRight,
+}) {
   return FIGlet.renderFIGure(text, font, direction: direction);
 }
 
 /// Renders the given [text] in the specified [font].
-String renderUnicode(String text, UnicodeFont font) {
+String renderUnicode(
+  String text,
+  UnicodeFont font,
+) {
   return UnicodeFontConverter.encode(text, font);
 }

lib/src/figlet/figlet.dart

@@ -2,15 +2,15 @@ import 'package:enough_ascii_art/src/figlet/renderer.dart';
 
 import 'font.dart';
 
-enum FigletRenderDirection { LeftToRight, TopToBottom }
+enum FigletRenderDirection { leftToRight, topToBottom }
 
 /// Helper class to render a FIGure
 class FIGlet {
-  /// Rendes the given [text] in the specified [font].
+  /// Renders the given [text] in the specified [font].
   ///
-  /// Optionally specify the [direction], which defaults to [FigletRenderDirection.LeftToRight]
+  /// Optionally specify the [direction], which defaults to [FigletRenderDirection.leftToRight]
   static String renderFIGure(String text, Font font,
-      {FigletRenderDirection direction = FigletRenderDirection.LeftToRight}) {
+      {FigletRenderDirection direction = FigletRenderDirection.leftToRight}) {
     var renderer = Renderer();
     return renderer.render(text, font, direction);
   }

lib/src/figlet/renderer.dart

@@ -10,8 +10,8 @@ class Renderer {
   /// [text] the text to render
   /// [font] the FIGlet font to be used for rendering
   /// [maxLineWidth] the optional maximum width for a single line, currently ignored
-  /// [horizontalLayouts] the optional rules for horizontal layouting
-  /// [verticalLayouts] the options rules for vertical layouting, currently ignored
+  /// [horizontalLayouts] the optional rules for horizontal layout
+  /// [verticalLayouts] the options rules for vertical layout, currently ignored
   String render(
     String text,
     Font font,
@@ -21,7 +21,7 @@ class Renderer {
     List<VerticalLayout>? verticalLayouts,
   }) {
     horizontalLayouts ??= font.horizontalLayouts;
-    if (direction == FigletRenderDirection.LeftToRight) {
+    if (direction == FigletRenderDirection.leftToRight) {
       return _renderLR(text, font, horizontalLayouts!);
     } else {
       return _renderTB(text, font);
@@ -78,8 +78,8 @@ class _RenderLine {
   static const int _runeRightBracket = 93; // ]
   static const int _runeLeftBrace = 123; // {
   static const int _runeRightBrace = 125; // }
-  static const int _runeLeftParenthese = 40; // (
-  static const int _runeRightParenthese = 41; // )
+  static const int _runeLeftParenthesis = 40; // (
+  static const int _runeRightParenthesis = 41; // )
   static const int _runeForwardSlash = 47; // /
   static const int _runeBackwardSlash = 92; // \
   static const int _runeSmallerThan = 60; // <
@@ -95,8 +95,8 @@ class _RenderLine {
     _runeRightBracket,
     _runeLeftBrace,
     _runeRightBrace,
-    _runeLeftParenthese,
-    _runeRightParenthese,
+    _runeLeftParenthesis,
+    _runeRightParenthesis,
     _runeSmallerThan,
     _runeLargerThan
   ];
@@ -221,10 +221,10 @@ class _RenderLine {
                       rightRune == _runeRightBrace) || // {}
                   (leftRune == _runeRightBrace &&
                       rightRune == _runeLeftBrace) || // }{
-                  (leftRune == _runeLeftParenthese &&
-                      rightRune == _runeRightParenthese) || // ()
-                  (leftRune == _runeRightParenthese &&
-                      rightRune == _runeLeftParenthese)) // )(
+                  (leftRune == _runeLeftParenthesis &&
+                      rightRune == _runeRightParenthesis) || // ()
+                  (leftRune == _runeRightParenthesis &&
+                      rightRune == _runeLeftParenthesis)) // )(
               {
                 // replace right character:
                 isLayoutRuleAppliedForLine = true;
@@ -259,7 +259,7 @@ class _RenderLine {
 
           // Universal smushing simply overrides the sub-character from the earlier FIGcharacter with the sub-character
           // from the later FIGcharacter.
-          // This produces an "overlapping" effect with some FIGfonts, wherin the latter FIGcharacter may appear to be "in front".
+          // This produces an "overlapping" effect with some FIGfonts, wherein the latter FIGcharacter may appear to be "in front".
           case HorizontalLayout.universalSmushing:
             isLayoutRuleAppliedForLine = true;
             break;

lib/src/image_converter.dart

@@ -4,13 +4,13 @@ import 'package:image/image.dart';
 class ImageConverter {
   static const String _asciiGrayScaleCharacters = '#@%=+*:-. ';
 
-  /// Converts the image to ASCII text.
+  /// Converts the [image] to ASCII text.
   ///
   /// [image] the image to be converted
-  /// [maxWidth] the optional maximum width of the image in characters, defaults to 80
-  /// [maxHeight] the optional maximum height of the image in characters, defaults to null, so the image is scaled linearily
-  /// [charSet] the optional charset from darkest to lightest character, defaults to '#@%=+*:-. '
-  /// [invert] allows to invert pixels, so that a dark pixel gets a bright characater and vise versa. This is useful when printing bight text on a dark background (console). Defaults to false.
+  /// [maxWidth] the optional maximum width of the image in characters, defaults to `80`
+  /// [maxHeight] the optional maximum height of the image in characters, defaults to null, so the image is scaled linearly
+  /// [charset] the optional charset from darkest to lightest character, defaults to '#@%=+*:-. '
+  /// [invert] allows to invert pixels, so that a dark pixel gets a bright character and vise versa. This is useful when printing bight text on a dark background (console). Defaults to false.
   /// [fontHeightCompensationFactor] the optional factor between 0 and 1 that is used to adjust the height of the image. Most fonts have a greater height than width, so this factor allows to compensate this. Defaults to 0.6.
   static String convertImage(Image image,
       {int maxWidth = 80,
@@ -35,8 +35,7 @@ class ImageConverter {
     for (var y = 0; y < scaledImage.height; y++) {
       for (var x = 0; x < scaledImage.width; x++) {
         var pixel = scaledImage.getPixel(x, y);
-        var grayscale =
-            (pixel >> 16 & 0xff) | (pixel >> 8 & 0xff) | (pixel & 0xff);
+        var grayscale = (pixel.r as int) | (pixel.g as int) | (pixel.b as int);
         var index = (grayscale * (charset.length - 1) / 255).floor();
         if (invert) {
           index = (charset.length - 1) - index;

lib/src/unicode_font_converter.dart

@@ -219,14 +219,14 @@ class UnicodeFontConverter {
     final to = _fonts[toFont]!;
     final buffer = StringBuffer();
     final characters = Characters(text);
-    characters.forEach((element) {
+    for (final element in characters) {
       final index = from.indexOf(element);
       if (index == -1) {
         buffer.write(element);
       } else {
         buffer.write(to[index]);
       }
-    });
+    }
     return buffer.toString();
   }
 

pubspec.yaml

@@ -1,15 +1,16 @@
 name: enough_ascii_art
-description: Generates ASCII art using image to ASCII, FIGlet text banner support and emoticon to text conversions.
-version: 1.0.0
+description: Generates ASCII art using image to ASCII, FIGlet text banner
+  support and emoticon to text conversions.
+version: 1.1.0
 homepage: https://github.com/Enough-Software/enough_ascii_art
 
 environment:
   sdk: '>=2.12.0 <3.0.0'
 
 dependencies:
-  image: ^3.0.5
   characters: ^1.1.0
-
+  image: ^4.0.0
+
 dev_dependencies:
-  pedantic: ^1.8.0
-  test: ^1.6.0
+  lints: ^2.0.1
+  test: ^1.22.0

test/enough_ascii_art_test.dart

@@ -1,5 +1,4 @@
 import 'package:enough_ascii_art/enough_ascii_art.dart';
-import 'package:enough_ascii_art/src/unicode_font_converter.dart';
 import 'package:test/test.dart';
 
 void main() {
@@ -21,13 +20,15 @@ void main() {
   group('Unicode font tests', () {
     test('Convert to double struck', () {
       expect(
-          UnicodeFontConverter.encode('hello world', UnicodeFont.doublestruck),
-          '𝕙𝕖𝕝𝕝𝕠 𝕨𝕠𝕣𝕝𝕕');
+        UnicodeFontConverter.encode('hello world', UnicodeFont.doublestruck),
+        '𝕙𝕖𝕝𝕝𝕠 𝕨𝕠𝕣𝕝𝕕',
+      );
     });
     test('Convert to fraktur', () {
       expect(
-          UnicodeFontConverter.encode('hello world', UnicodeFont.frakturBold),
-          '𝖍𝖊𝖑𝖑𝖔 𝖜𝖔𝖗𝖑𝖉');
+        UnicodeFontConverter.encode('hello world', UnicodeFont.frakturBold),
+        '𝖍𝖊𝖑𝖑𝖔 𝖜𝖔𝖗𝖑𝖉',
+      );
     });
   });
 }