Skip to content
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.

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

feat(logger): add link #517

Merged
merged 8 commits into from Sep 16, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/mason_logger/lib/mason_logger.dart
Expand Up @@ -2,4 +2,5 @@ library mason_logger;

export 'src/io.dart';
export 'src/level.dart';
export 'src/link_wrap.dart';
export 'src/mason_logger.dart' show Logger, Progress;
8 changes: 8 additions & 0 deletions packages/mason_logger/lib/src/link_wrap.dart
@@ -0,0 +1,8 @@
/// Helper function for "wrapping" an optional message with link.
String linkWrap(String? message, Uri uri) {
Luckey-Elijah marked this conversation as resolved.
Show resolved Hide resolved
const lead = '\x1B]8;;';
const trail = '\x1B\\';

final encoded = '$lead$uri$trail${message ?? uri}$lead$trail';
return encoded;
}
18 changes: 18 additions & 0 deletions packages/mason_logger/lib/src/mason_logger.dart
Expand Up @@ -6,6 +6,9 @@ import 'package:mason_logger/mason_logger.dart';

part 'progress.dart';

/// Callback for writing to `stdout` or `stderr`.
typedef StdoutWriter = void Function(String?);

/// {@template logger}
/// A basic Logger which wraps `stdio` and applies various styles.
/// {@endtemplate}
Expand Down Expand Up @@ -49,6 +52,21 @@ class Logger {
_stdout.writeln(message);
}

/// Writes a message with a clickable link.
/// By default writes to `stdout` with [info], but any [StdoutWriter] works.
///
/// **NOTE**: Only works on supported terminal emulators. Please see this
/// [link on what is supported](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda#supporting-apps).
void link(
Luckey-Elijah marked this conversation as resolved.
Show resolved Hide resolved
String? message,
Uri uri, [
StdoutWriter? writer,
]) {
final _writer = writer ?? info;
final _message = linkWrap(message, uri);
_writer(_message);
}

/// Writes delayed message to stdout.
void delayed(String? message) => _queue.add(message);

Expand Down
32 changes: 32 additions & 0 deletions packages/mason_logger/test/src/link_wrap_test.dart
@@ -0,0 +1,32 @@
import 'package:mason_logger/mason_logger.dart';
import 'package:test/test.dart';

void main() {
group('linkWrap', () {
final uri = Uri.parse('https://github.com/felangel/mason/issues/');
const lead = '\x1B]8;;';
const trail = '\x1B\\';
test(
'builds output with correct encodings: ' r'\x1B]8;;' ' and ' r'\x1B\\',
() {
const message = 'message';

final output = linkWrap(message, uri);
final matcher = stringContainsInOrder(
[lead, '$uri', trail, message, lead, trail],
);

expect(output, matcher);
},
);

test('builds String with Uri when message is null: ', () {
Luckey-Elijah marked this conversation as resolved.
Show resolved Hide resolved
final output = linkWrap(null, uri);
final matcher = stringContainsInOrder(
[lead, '$uri', trail, '$uri', lead, trail],
);

expect(output, matcher);
});
});
}
41 changes: 41 additions & 0 deletions packages/mason_logger/test/src/mason_logger_test.dart
Expand Up @@ -22,6 +22,47 @@ void main() {
when(() => stdout.supportsAnsiEscapes).thenReturn(true);
});

group('.link', () {
final uri = Uri.parse('https://github.com/felangel/mason/issues/');

test(
'writes to stdout',
() {
IOOverrides.runZoned(
() {
const message = 'test message';
const lead = '\x1B]8;;';
const trail = '\x1B\\';

Logger().link(message, uri);
verify(
() => stdout.writeln('$lead$uri$trail$message$lead$trail'),
).called(1);
},
stdout: () => stdout,
);
},
);

test(
'writes with the provided writer',
() {
IOOverrides.runZoned(
() {
const message = 'test message';
const lead = '\x1B]8;;';
const trail = '\x1B\\';
Logger().link(message, uri, stdout.write);
verify(
() => stdout.write('$lead$uri$trail$message$lead$trail'),
).called(1);
},
stdout: () => stdout,
);
},
);
});

group('level', () {
test('is mutable', () {
final logger = Logger();
Expand Down