mason_logger 0.3.0

mason_logger: ^0.3.0 copied to clipboard

• feat: add interval to ProgressAnimation (#1391)
• deps: tighten dependency constraints (#1395)
  • bumps the Dart SDK minimum version up to 3.5.0

• fix: Logger.progress spams terminal on overflow
• chore: add funding to pubspec.yaml

• refactor: upgrade pkg:win32 to ^0.5.4 (#1300)
  • bumps the Dart SDK minimum version up to 3.3.0

• fix: `The getter 'STD_HANDLE' isn't defined for the class 'WindowsTerminal' (#1298)

• fix: throw StateError when prompting with no terminal attached (#1285)
• refactor: remove deprecated methods in WindowsTerminal (#1286)

• feat: add trailing to ProgressOptions (#1247)

• chore: fix missing closing doc template
• chore: use pkg:io (#1099)

• fix: exit on Ctrl+C (#1090)

• fix: arrow keys on windows (#816)
• chore: improve lint rules
• chore: dart fix --apply
• chore(deps): upgrade dependencies

• fix: confirm gracefully handles utf8 decode errors
• docs: add topics to pubspec.yaml

• feat: add promptAny to Logger

  final logger = Logger();
  
  // Prompt for a dynamic list of values.
  final List<String> languages = logger.promptAny(
    'What are your favorite programming languages?',
  );
  
  if (languages.contains('dart')) {
    logger.info('Nice, I like dart too! 🎯');
  }
  

• fix: chooseAny renders selected results using display when specified

• feat: add LogStyle and LogTheme

  // Create a custom `LogTheme` by overriding zero or more log styles.
  final customTheme = LogTheme(
    detail: (m) => darkGray.wrap(m),
    info: (m) => m,
    success: (m) => lightGreen.wrap(m),
    warn: (m) => yellow.wrap(m),
    err: (m) => lightRed.wrap(m),
    alert: (m) => backgroundRed.wrap(white.wrap(m)),
  );
  
  // Create a logger with the custom theme
  final logger = Logger(theme: customTheme);
  
  // Use the logger
  logger.info('hello world');
  
  // Perform a one-off override
  String? myCustomStyle(String? m) => lightCyan.wrap(m);
  logger.info('custom style', style: myCustomStyle);
  

• deps: upgrade to Dart >=2.19 and very_good_analysis ^4.0.0

• fix: warn with an empty tag should not include []
• deps: upgrade to Dart >=2.17 and very_good_analysis ^3.1.0

• fix: windows progress animation

• fix: only animate progress on terminals

• fix: improve clear line mechanism for Progress API

• BREAKING feat: add generic support to chooseOne and chooseAny

  enum Shape { square, circle, triangle}
  
  void main() {
    final logger = Logger();
  
    final shape = logger.chooseOne<Shape>(
      'What is your favorite shape?',
      choices: Shape.values,
      display: (shape) => '${shape.name}',
    );
    logger.info('You chose: $shape');
  
    final shapes = logger.chooseAny<Shape>(
      'Or did you want to choose multiples?',
      choices: Shape.values,
      defaultValues: [shape],
      display: (shape) => '${shape.name}',
    );
    logger.info('You chose: $shapes');
  }
  

• feat: add ProgressOptions API

  import 'package:mason_logger/mason_logger.dart';
  
  Future<void> main() async {
    // 1. ✨ Create a custom ProgressOptions.
    const progressOptions = ProgressOptions(
      animation: ProgressAnimation(
        frames: ['🌑', '🌒', '🌓', '🌔', '🌕', '🌖', '🌗', '🌘'],
      ),
    );
  
    // 2. 💉 Inject `progressOptions` into your Logger.
    final logger = Logger(progressOptions: progressOptions);
  
    // 3. 🤤 Admire your custom progress animation.
    final progress = logger.progress('Calculating');
    await Future.delayed(const Duration(seconds: 3));
    progress.complete('Done!');
  }
  

• feat: add link API

  final logger = Logger();
  final repoLink = link(
    message: 'GitHub Repository',
    uri: Uri.parse('https://github.com/felangel/mason'),
  );
  logger.info('To learn more, visit the $repoLink.');
  

• feat: render milliseconds on progress duration
• refactor(deps): remove package:meta
• refactor: use IOOverrides

• refactor(deps): remove pkg:universal_io
• docs: fix typo in README snippet

• BREAKING: support log levels (default Level is Level.info)
• BREAKING: mark Progress() as @internal
• BREAKING: alert writes to stderr instead of stdout
• BREAKING: Progress.fail(...) writes to stdout instead of stderr
• BREAKING: remove deprecated Progress.call(...) (use Progress.complete instead).

• feat: Progress.update

  final progress = logger.progress('Calculating');
  await Future<void>.delayed(const Duration(milliseconds: 500));
  progress.update('Halfway!');
  await Future<void>.delayed(const Duration(milliseconds: 500));
  progress.complete('Done!');
  

• fix: correct J and K key mappings

• fix: chooseOne API windows compatibility
• feat: chooseAny

  /// Ask user to choose zero or more options.
  final desserts = logger.chooseAny(
    'Which desserts do you like?',
    choices: ['🍦', '🍪', '🍩'],
  );
  

• fix: write errors and warnings to stderr
  • Logger().err(...)
  • Logger().warn(...)
  • Logger().progress(...).fail(...)

• feat: chooseOne API

  final favoriteColor = logger.chooseOne(
    'What is your favorite color?',
    choices: ['red', 'green', 'blue'],
    defaultValue: 'blue',
  );
  

• feat: progress API enhancements

  final progress = Logger().progress('calculating');
  try {
    await _performCalculation();
    // Complete progress successfully.
    progress.complete();
  } catch (error, stackTrace) {
    // Terminate progress unsuccessfully.
    progress.fail();
  }
  

• fix: single line prompts are overwritten
  • when using confirm and prompt

• fix: multiline prompts are outputting twice
  • when using confirm and prompt

• feat: add write

• feat: add hidden flag to prompt
• chore: upgrade to Dart 2.16

• fix: progress string truncation
• feat: add confirm
• feat: add defaultValue to prompt
• feat: improve progress time style
• docs: update example and README

• feat: add tag to warn call

• test: 100% test coverage
• docs: README updates to include usage
• docs: include example

Dev Release

• chore: initial package (🚧 under construction 🚧)