🚨 Fixed lint warnings

Author: Guldem

example/oauth_chopper_example.dart

@@ -1,4 +1,6 @@
-// ignore_for_file: unused_local_variable
+// ignore because its a example.
+// ignore_for_file: unused_local_variable, prefer_const_declarations,
+// ignore_for_file: prefer_const_constructors
 
 import 'package:chopper/chopper.dart';
 import 'package:oauth_chopper/oauth_chopper.dart';

lib/oauth_chopper.dart

@@ -1,4 +1,4 @@
-/// OAuthChopper for configuring OAuth authentication with [Chopper].
+/// OAuthChopper for configuring OAuth authentication with Chopper.
 ///
 /// More dartdocs go here.
 library oauth_chopper;

lib/src/oauth_authenticator.dart

@@ -20,6 +20,7 @@ class OAuthAuthenticator extends Authenticator {
 
   /// Callback for error handling.
   final OnErrorCallback? onError;
+
   /// The [OAuthChopper] instance to get the token from and
   /// to refresh the token.
   final OAuthChopper oauthChopper;

lib/src/oauth_chopper.dart

@@ -9,7 +9,7 @@ import 'package:oauth_chopper/src/storage/memory_storage.dart';
 import 'package:oauth_chopper/src/storage/oauth_storage.dart';
 
 /// {@template oauth_chopper}
-/// OAuthChopper client for configuring OAuth authentication with [Chopper].
+/// OAuthChopper client for configuring OAuth authentication with Chopper.
 ///
 /// For example:
 /// ```dart
@@ -29,7 +29,8 @@ class OAuthChopper {
     this.endSessionEndpoint,
 
     /// OAuth storage for storing credentials.
-    /// By default it will use a in memory storage [MemoryStorage]. For persisting the credentials implement a custom [OAuthStorage].
+    /// By default it will use a in memory storage [MemoryStorage].
+    /// For persisting the credentials implement a custom [OAuthStorage].
     /// See [OAuthStorage] for more information.
     OAuthStorage? storage,
   }) : _storage = storage ?? MemoryStorage();
@@ -47,36 +48,43 @@ class OAuthChopper {
   final String secret;
 
   /// OAuth storage for storing credentials.
-  /// By default it will use a in memory storage. For persisting the credentials implement a custom [OAuthStorage].
+  /// By default it will use a in memory storage. For persisting the credentials
+  /// implement a custom [OAuthStorage].
   /// See [OAuthStorage] for more information.
   final OAuthStorage _storage;
 
   /// Get stored [OAuthToken].
   Future<OAuthToken?> get token async {
     final credentialsJson = await _storage.fetchCredentials();
-    return credentialsJson != null ? OAuthToken.fromJson(credentialsJson) : null;
+    return credentialsJson != null
+        ? OAuthToken.fromJson(credentialsJson)
+        : null;
   }
 
   /// Provides an [OAuthAuthenticator] instance.
-  /// The authenticator can throw exceptions when OAuth authentication fails. If [onError] is provided exceptions will be passed to [onError] and not be thrown.
+  /// The authenticator can throw exceptions when OAuth authentication fails.
+  /// If [onError] is provided exceptions will be passed to [onError] and not be
+  /// thrown.
   OAuthAuthenticator authenticator({
-    /// When provided [onError] handles exceptions if thrown.
     OnErrorCallback? onError,
   }) =>
       OAuthAuthenticator(this, onError);
 
   /// Provides an [OAuthInterceptor] instance.
   OAuthInterceptor get interceptor => OAuthInterceptor(this);
 
-  /// Tries to refresh the available credentials and returns a new [OAuthToken] instance.
-  /// Throws an exception when refreshing fails. If the exception is a [AuthorizationException] it clears the storage.
+  /// Tries to refresh the available credentials and returns a new [OAuthToken]
+  /// instance.
+  /// Throws an exception when refreshing fails. If the exception is a
+  /// [AuthorizationException] it clears the storage.
   /// See [Credentials.refresh]
   Future<OAuthToken?> refresh() async {
     final credentialsJson = await _storage.fetchCredentials();
     if (credentialsJson == null) return null;
     final credentials = Credentials.fromJson(credentialsJson);
     try {
-      final newCredentials = await credentials.refresh(identifier: identifier, secret: secret);
+      final newCredentials =
+          await credentials.refresh(identifier: identifier, secret: secret);
       await _storage.saveCredentials(newCredentials.toJson());
       return OAuthToken.fromCredentials(newCredentials);
     } on AuthorizationException {
@@ -85,14 +93,17 @@ class OAuthChopper {
     }
   }
 
-  /// Request an [OAuthGrant] and stores the credentials in the [storage].
+  /// Request an [OAuthGrant] and stores the credentials in the
+  /// [_storage].
+  ///
   /// Currently supported grants:
   ///  - [ResourceOwnerPasswordGrant]
   ///  - [ClientCredentialsGrant]
   ///
   /// Throws an exception if the grant fails.
   Future<OAuthToken> requestGrant(OAuthGrant grant) async {
-    final credentials = await grant.handle(authorizationEndpoint, identifier, secret);
+    final credentials =
+        await grant.handle(authorizationEndpoint, identifier, secret);
 
     await _storage.saveCredentials(credentials);
 

lib/src/oauth_grant.dart

@@ -9,7 +9,11 @@ abstract interface class OAuthGrant {
   const OAuthGrant();
 
   /// Obtains credentials from an authorization server.
-  Future<String> handle(Uri authorizationEndpoint, String identifier, String secret);
+  Future<String> handle(
+    Uri authorizationEndpoint,
+    String identifier,
+    String secret,
+  );
 }
 
 /// {@template resource_owner_password_grant}
@@ -32,7 +36,11 @@ class ResourceOwnerPasswordGrant implements OAuthGrant {
   final String password;
 
   @override
-  Future<String> handle(Uri authorizationEndpoint, String identifier, String secret) async {
+  Future<String> handle(
+    Uri authorizationEndpoint,
+    String identifier,
+    String secret,
+  ) async {
     final client = await oauth.resourceOwnerPasswordGrant(
       authorizationEndpoint,
       username,
@@ -52,7 +60,11 @@ class ClientCredentialsGrant implements OAuthGrant {
   const ClientCredentialsGrant();
 
   @override
-  Future<String> handle(Uri authorizationEndpoint, String identifier, String secret) async {
+  Future<String> handle(
+    Uri authorizationEndpoint,
+    String identifier,
+    String secret,
+  ) async {
     final client = await oauth.clientCredentialsGrant(
       authorizationEndpoint,
       identifier,
@@ -88,9 +100,11 @@ class AuthorizationCodeGrant implements OAuthGrant {
   /// The specific permissions being requested from the authorization server may
   /// be specified via [scopes].
   final List<String> scopes;
+
   /// Callback used for redirect the authorizationUrl given by the authorization
   /// server.
   final Future<void> Function(Uri authorizationUri) redirect;
+
   /// Callback used for listening for the redirectUrl.
   final Future<Uri> Function(Uri redirectUri) listen;
 
@@ -114,7 +128,7 @@ class AuthorizationCodeGrant implements OAuthGrant {
     await redirect(authorizationUrl);
     final responseUrl = await listen(redirectUrl);
 
-    final oauth.Client client = await grant.handleAuthorizationResponse(
+    final client = await grant.handleAuthorizationResponse(
       responseUrl.queryParameters,
     );
 

lib/src/oauth_interceptor.dart

@@ -5,8 +5,10 @@ import 'package:oauth_chopper/oauth_chopper.dart';
 import 'package:oauth_chopper/src/extensions/request.dart';
 
 /// {@template oauth_interceptor}
-/// OAuthInterceptor is responsible for adding 'Authorization' header to requests.
-/// The header is only added if there is a token available. When no token is available no header is added.
+/// OAuthInterceptor is responsible for adding 'Authorization' header to
+/// requests.
+/// The header is only added if there is a token available. When no token is
+/// available no header is added.
 /// Its added as a Bearer token.
 /// {@endtemplate}
 class OAuthInterceptor implements RequestInterceptor {

lib/src/storage/memory_storage.dart

@@ -2,6 +2,7 @@ import 'dart:async';
 
 import 'package:oauth_chopper/oauth_chopper.dart';
 
+/// A simple in-memory storage for OAuth credentials.
 class MemoryStorage implements OAuthStorage {
   String? _credentials;
 

lib/src/storage/oauth_storage.dart

@@ -7,7 +7,8 @@ abstract interface class OAuthStorage {
   /// Fetch stored credentials.
   FutureOr<String?> fetchCredentials();
 
-  /// Save newly obtained credentials. This is called when authentication or refreshing tokens succeeds.
+  /// Save newly obtained credentials. This is called when authentication or
+  /// refreshing tokens succeeds.
   FutureOr<void> saveCredentials(String? credentialsJson);
 
   /// Clear any stored credential. This is called when authentication fails.

pubspec.yaml

@@ -12,6 +12,6 @@ dependencies:
 
 dev_dependencies:
   http: ^1.2.1
-  very_good_analysis: ^5.1.0
   mocktail: ^1.0.3
   test: ^1.25.2
+  very_good_analysis: ^5.1.0

test/oauth_authenticator_test.dart

@@ -1,3 +1,6 @@
+// ignore so the test is easier to read.
+// ignore_for_file: avoid_redundant_argument_values
+
 import 'dart:io';
 
 import 'package:chopper/chopper.dart';
@@ -28,7 +31,7 @@ void main() {
 
   test('only refresh on unauthorized and token', () async {
     // arrange
-    when(() => mockOAuthChopper.refresh()).thenAnswer((_) async => testToken);
+    when(mockOAuthChopper.refresh).thenAnswer((_) async => testToken);
     when(() => mockOAuthChopper.token).thenAnswer((_) async => testToken);
     final authenticator = OAuthAuthenticator(mockOAuthChopper, null);
     final expected = {'Authorization': 'Bearer token'};
@@ -38,13 +41,13 @@ void main() {
         await authenticator.authenticate(testRequest, unauthorizedResponse);
 
     // assert
-    verify(() => mockOAuthChopper.refresh()).called(1);
+    verify(mockOAuthChopper.refresh).called(1);
     expect(result?.headers, expected);
   });
 
   test("Don't refresh on authorized", () async {
     // arrange
-    when(() => mockOAuthChopper.refresh()).thenAnswer((_) async => testToken);
+    when(mockOAuthChopper.refresh).thenAnswer((_) async => testToken);
     when(() => mockOAuthChopper.token).thenAnswer((_) async => testToken);
     final authenticator = OAuthAuthenticator(mockOAuthChopper, null);
 
@@ -53,13 +56,13 @@ void main() {
         await authenticator.authenticate(testRequest, authorizedResponse);
 
     // assert
-    verifyNever(() => mockOAuthChopper.refresh());
+    verifyNever(mockOAuthChopper.refresh);
     expect(result, null);
   });
 
   test("Don't refresh on token not available", () async {
     // arrange
-    when(() => mockOAuthChopper.refresh()).thenAnswer((_) async => testToken);
+    when(mockOAuthChopper.refresh).thenAnswer((_) async => testToken);
     when(() => mockOAuthChopper.token).thenAnswer((_) async => null);
     final authenticator = OAuthAuthenticator(mockOAuthChopper, null);
 
@@ -68,13 +71,13 @@ void main() {
         await authenticator.authenticate(testRequest, unauthorizedResponse);
 
     // assert
-    verifyNever(() => mockOAuthChopper.refresh());
+    verifyNever(mockOAuthChopper.refresh);
     expect(result, null);
   });
 
   test("Don't add headers on failed refresh", () async {
     // arrange
-    when(() => mockOAuthChopper.refresh()).thenAnswer((_) async => null);
+    when(mockOAuthChopper.refresh).thenAnswer((_) async => null);
     when(() => mockOAuthChopper.token).thenAnswer((_) async => testToken);
     final authenticator = OAuthAuthenticator(mockOAuthChopper, null);
 
@@ -83,31 +86,34 @@ void main() {
         await authenticator.authenticate(testRequest, unauthorizedResponse);
 
     // assert
-    verify(() => mockOAuthChopper.refresh()).called(1);
+    verify(mockOAuthChopper.refresh).called(1);
     expect(result, null);
   });
 
-  test("Exception thrown if onError is null", () async {
+  test('Exception thrown if onError is null', () async {
     // arrange
-    when(() => mockOAuthChopper.refresh()).thenThrow(FormatException('failed'));
+    when(mockOAuthChopper.refresh).thenThrow(const FormatException('failed'));
     when(() => mockOAuthChopper.token).thenAnswer((_) async => testToken);
     final authenticator = OAuthAuthenticator(mockOAuthChopper, null);
 
     // act
     // assert
     expect(
-        () async =>
-            await authenticator.authenticate(testRequest, unauthorizedResponse),
-        throwsFormatException);
+      () async =>
+          await authenticator.authenticate(testRequest, unauthorizedResponse),
+      throwsFormatException,
+    );
   });
 
-  test("Exception not thrown if onError is supplied", () async {
+  test('Exception not thrown if onError is supplied', () async {
     // arrange
     FormatException? result;
-    when(() => mockOAuthChopper.refresh()).thenThrow(FormatException('failed'));
+    when(mockOAuthChopper.refresh).thenThrow(const FormatException('failed'));
     when(() => mockOAuthChopper.token).thenAnswer((_) async => testToken);
     final authenticator = OAuthAuthenticator(
-        mockOAuthChopper, (e, s) => result = e as FormatException);
+      mockOAuthChopper,
+      (e, s) => result = e as FormatException,
+    );
 
     // act
     final responseResult =