[webview_flutter] Fix typos in tests and documentation (#3572)

bparrishMines · web-flow · commit 75ede70ca5f0 · 2023-04-07T02:10:30.000Z
[webview_flutter] Fix typos in tests and documentation
diff --git a/packages/webview_flutter/webview_flutter/CHANGELOG.md b/packages/webview_flutter/webview_flutter/CHANGELOG.md
@@ -1,6 +1,7 @@
 ## NEXT
 
 * Updates minimum Flutter version to 3.3.
+* Fixes common typos in tests and documentation.
 
 ## 4.0.7
 
diff --git a/packages/webview_flutter/webview_flutter/lib/src/legacy/webview.dart b/packages/webview_flutter/webview_flutter/lib/src/legacy/webview.dart
@@ -142,7 +142,7 @@ class WebView extends StatefulWidget {
   /// Which gestures should be consumed by the web view.
   ///
   /// It is possible for other gesture recognizers to be competing with the web view on pointer
-  /// events, e.g if the web view is inside a [ListView] the [ListView] will want to handle
+  /// events, e.g. if the web view is inside a [ListView] the [ListView] will want to handle
   /// vertical drags. The web view will claim gestures that are recognized by any of the
   /// recognizers on this list.
   ///
@@ -180,7 +180,7 @@ class WebView extends StatefulWidget {
   ///
   /// To asynchronously invoke the message handler which will print the message to standard output.
   ///
-  /// Adding a new JavaScript channel only takes affect after the next page is loaded.
+  /// Adding a new JavaScript channel only takes effect after the next page is loaded.
   ///
   /// Set values must not be null. A [JavascriptChannel.name] cannot be the same for multiple
   /// channels in the list.
diff --git a/packages/webview_flutter/webview_flutter/lib/src/webview_controller.dart b/packages/webview_flutter/webview_flutter/lib/src/webview_controller.dart
@@ -247,7 +247,7 @@ class WebViewController {
   /// to asynchronously invoke the message handler which will print the message
   /// to standard output.
   ///
-  /// Adding a new JavaScript channel only takes affect after the next page is
+  /// Adding a new JavaScript channel only takes effect after the next page is
   /// loaded.
   ///
   /// A channel [name] cannot be the same for multiple channels.
diff --git a/packages/webview_flutter/webview_flutter/lib/src/webview_widget.dart b/packages/webview_flutter/webview_flutter/lib/src/webview_widget.dart
@@ -105,7 +105,7 @@ class WebViewWidget extends StatelessWidget {
   /// Specifies which gestures should be consumed by the web view.
   ///
   /// It is possible for other gesture recognizers to be competing with the web
-  /// view on pointer events, e.g if the web view is inside a [ListView] the
+  /// view on pointer events, e.g. if the web view is inside a [ListView] the
   /// [ListView] will want to handle vertical drags. The web view will claim
   /// gestures that are recognized by any of the recognizers on this list.
   ///
diff --git a/packages/webview_flutter/webview_flutter_android/CHANGELOG.md b/packages/webview_flutter/webview_flutter_android/CHANGELOG.md
@@ -1,6 +1,7 @@
 ## NEXT
 
 * Bumps androidx.webkit:webkit from 1.6.0 to 1.6.1.
+* Fixes common typos in tests and documentation.
 
 ## 3.4.5
 
diff --git a/packages/webview_flutter/webview_flutter_android/lib/src/android_webview_api_impls.dart b/packages/webview_flutter/webview_flutter_android/lib/src/android_webview_api_impls.dart
@@ -563,7 +563,7 @@ class JavaScriptChannelFlutterApiImpl extends JavaScriptChannelFlutterApi {
         .getInstanceWithWeakReference(instanceId) as JavaScriptChannel?;
     assert(
       instance != null,
-      'InstanceManager does not contain an JavaScriptChannel with instanceId: $instanceId',
+      'InstanceManager does not contain a JavaScriptChannel with instanceId: $instanceId',
     );
     instance!.postMessage(message);
   }
@@ -617,11 +617,11 @@ class WebViewClientFlutterApiImpl extends WebViewClientFlutterApi {
         .getInstanceWithWeakReference(webViewInstanceId) as WebView?;
     assert(
       instance != null,
-      'InstanceManager does not contain an WebViewClient with instanceId: $instanceId',
+      'InstanceManager does not contain a WebViewClient with instanceId: $instanceId',
     );
     assert(
       webViewInstance != null,
-      'InstanceManager does not contain an WebView with instanceId: $webViewInstanceId',
+      'InstanceManager does not contain a WebView with instanceId: $webViewInstanceId',
     );
     if (instance!.onPageFinished != null) {
       instance.onPageFinished!(webViewInstance!, url);
@@ -636,11 +636,11 @@ class WebViewClientFlutterApiImpl extends WebViewClientFlutterApi {
         .getInstanceWithWeakReference(webViewInstanceId) as WebView?;
     assert(
       instance != null,
-      'InstanceManager does not contain an WebViewClient with instanceId: $instanceId',
+      'InstanceManager does not contain a WebViewClient with instanceId: $instanceId',
     );
     assert(
       webViewInstance != null,
-      'InstanceManager does not contain an WebView with instanceId: $webViewInstanceId',
+      'InstanceManager does not contain a WebView with instanceId: $webViewInstanceId',
     );
     if (instance!.onPageStarted != null) {
       instance.onPageStarted!(webViewInstance!, url);
@@ -661,11 +661,11 @@ class WebViewClientFlutterApiImpl extends WebViewClientFlutterApi {
         .getInstanceWithWeakReference(webViewInstanceId) as WebView?;
     assert(
       instance != null,
-      'InstanceManager does not contain an WebViewClient with instanceId: $instanceId',
+      'InstanceManager does not contain a WebViewClient with instanceId: $instanceId',
     );
     assert(
       webViewInstance != null,
-      'InstanceManager does not contain an WebView with instanceId: $webViewInstanceId',
+      'InstanceManager does not contain a WebView with instanceId: $webViewInstanceId',
     );
     // ignore: deprecated_member_use_from_same_package
     if (instance!.onReceivedError != null) {
@@ -691,11 +691,11 @@ class WebViewClientFlutterApiImpl extends WebViewClientFlutterApi {
         .getInstanceWithWeakReference(webViewInstanceId) as WebView?;
     assert(
       instance != null,
-      'InstanceManager does not contain an WebViewClient with instanceId: $instanceId',
+      'InstanceManager does not contain a WebViewClient with instanceId: $instanceId',
     );
     assert(
       webViewInstance != null,
-      'InstanceManager does not contain an WebView with instanceId: $webViewInstanceId',
+      'InstanceManager does not contain a WebView with instanceId: $webViewInstanceId',
     );
     if (instance!.onReceivedRequestError != null) {
       instance.onReceivedRequestError!(
@@ -718,11 +718,11 @@ class WebViewClientFlutterApiImpl extends WebViewClientFlutterApi {
         .getInstanceWithWeakReference(webViewInstanceId) as WebView?;
     assert(
       instance != null,
-      'InstanceManager does not contain an WebViewClient with instanceId: $instanceId',
+      'InstanceManager does not contain a WebViewClient with instanceId: $instanceId',
     );
     assert(
       webViewInstance != null,
-      'InstanceManager does not contain an WebView with instanceId: $webViewInstanceId',
+      'InstanceManager does not contain a WebView with instanceId: $webViewInstanceId',
     );
     if (instance!.requestLoading != null) {
       instance.requestLoading!(
@@ -744,11 +744,11 @@ class WebViewClientFlutterApiImpl extends WebViewClientFlutterApi {
         .getInstanceWithWeakReference(webViewInstanceId) as WebView?;
     assert(
       instance != null,
-      'InstanceManager does not contain an WebViewClient with instanceId: $instanceId',
+      'InstanceManager does not contain a WebViewClient with instanceId: $instanceId',
     );
     assert(
       webViewInstance != null,
-      'InstanceManager does not contain an WebView with instanceId: $webViewInstanceId',
+      'InstanceManager does not contain a WebView with instanceId: $webViewInstanceId',
     );
     if (instance!.urlLoading != null) {
       instance.urlLoading!(webViewInstance!, url);
@@ -798,7 +798,7 @@ class DownloadListenerFlutterApiImpl extends DownloadListenerFlutterApi {
         .getInstanceWithWeakReference(instanceId) as DownloadListener?;
     assert(
       instance != null,
-      'InstanceManager does not contain an DownloadListener with instanceId: $instanceId',
+      'InstanceManager does not contain a DownloadListener with instanceId: $instanceId',
     );
     instance!.onDownloadStart(
       url,
@@ -858,11 +858,11 @@ class WebChromeClientFlutterApiImpl extends WebChromeClientFlutterApi {
         .getInstanceWithWeakReference(webViewInstanceId) as WebView?;
     assert(
       instance != null,
-      'InstanceManager does not contain an WebChromeClient with instanceId: $instanceId',
+      'InstanceManager does not contain a WebChromeClient with instanceId: $instanceId',
     );
     assert(
       webViewInstance != null,
-      'InstanceManager does not contain an WebView with instanceId: $webViewInstanceId',
+      'InstanceManager does not contain a WebView with instanceId: $webViewInstanceId',
     );
     if (instance!.onProgressChanged != null) {
       instance.onProgressChanged!(webViewInstance!, progress);
diff --git a/packages/webview_flutter/webview_flutter_android/lib/src/instance_manager.dart b/packages/webview_flutter/webview_flutter_android/lib/src/instance_manager.dart
@@ -90,7 +90,7 @@ class InstanceManager {
   /// Returns the identifier associated with the removed instance. Otherwise,
   /// `null` if the instance was not found in this manager.
   ///
-  /// This does not remove the the strong referenced instance associated with
+  /// This does not remove the strong referenced instance associated with
   /// [instance]. This can be done with [remove].
   int? removeWeakReference(Copyable instance) {
     final int? identifier = getIdentifier(instance);
@@ -112,7 +112,7 @@ class InstanceManager {
   /// it was removed. Returns `null` if [identifier] was not associated with
   /// any strong reference.
   ///
-  /// This does not remove the the weak referenced instance associtated with
+  /// This does not remove the weak referenced instance associated with
   /// [identifier]. This can be done with [removeWeakReference].
   T? remove<T extends Copyable>(int identifier) {
     return _strongInstances.remove(identifier) as T?;
diff --git a/packages/webview_flutter/webview_flutter_android/lib/src/weak_reference_utils.dart b/packages/webview_flutter/webview_flutter_android/lib/src/weak_reference_utils.dart
@@ -9,7 +9,7 @@
 /// final JavascriptChannelRegistry javascriptChannelRegistry = ...
 ///
 /// final WKScriptMessageHandler handler = WKScriptMessageHandler(
-///   didReceiveScriptMessage: withWeakRefenceTo(
+///   didReceiveScriptMessage: withWeakReferenceTo(
 ///     javascriptChannelRegistry,
 ///     (WeakReference<JavascriptChannelRegistry> weakReference) {
 ///       return (
diff --git a/packages/webview_flutter/webview_flutter_android/test/android_webview_controller_test.dart b/packages/webview_flutter/webview_flutter_android/test/android_webview_controller_test.dart
@@ -210,7 +210,7 @@ void main() {
       )).called(1);
     });
 
-    test('loadFlutterAsset when asset does not exists', () async {
+    test('loadFlutterAsset when asset does not exist', () async {
       final MockWebView mockWebView = MockWebView();
       final MockFlutterAssetManager mockAssetManager =
           MockFlutterAssetManager();
diff --git a/packages/webview_flutter/webview_flutter_android/test/legacy/webview_android_widget_test.dart b/packages/webview_flutter/webview_flutter_android/test/legacy/webview_android_widget_test.dart
@@ -393,7 +393,7 @@ void main() {
       });
 
       testWidgets(
-          'loadFlutterAsset throws ArgumentError when asset does not exists',
+          'loadFlutterAsset throws ArgumentError when asset does not exist',
           (WidgetTester tester) async {
         await buildWidget(tester);
         const String assetKey = 'test_assets/index.html';
diff --git a/packages/webview_flutter/webview_flutter_platform_interface/CHANGELOG.md b/packages/webview_flutter/webview_flutter_platform_interface/CHANGELOG.md
@@ -1,6 +1,7 @@
 ## NEXT
 
 * Updates minimum Flutter version to 3.3.
+* Fixes common typos in tests and documentation.
 
 ## 2.1.0
 
diff --git a/packages/webview_flutter/webview_flutter_platform_interface/lib/src/legacy/platform_interface/webview_platform.dart b/packages/webview_flutter/webview_flutter_platform_interface/lib/src/legacy/platform_interface/webview_platform.dart
@@ -37,7 +37,7 @@ abstract class WebViewPlatform {
   ///
   /// `gestureRecognizers` specifies which gestures should be consumed by the web view.
   /// It is possible for other gesture recognizers to be competing with the web view on pointer
-  /// events, e.g if the web view is inside a [ListView] the [ListView] will want to handle
+  /// events, e.g. if the web view is inside a [ListView] the [ListView] will want to handle
   /// vertical drags. The web view will claim gestures that are recognized by any of the
   /// recognizers on this list.
   /// When `gestureRecognizers` is empty or null, the web view will only handle pointer events for gestures that
diff --git a/packages/webview_flutter/webview_flutter_platform_interface/lib/src/legacy/types/javascript_channel.dart b/packages/webview_flutter/webview_flutter_platform_interface/lib/src/legacy/types/javascript_channel.dart
@@ -29,7 +29,7 @@ class JavascriptChannel {
   /// The name must start with a letter or underscore(_), followed by any combination of those
   /// characters plus digits.
   ///
-  /// Note that any JavaScript existing `window` property with this name will be overriden.
+  /// Note that any JavaScript existing `window` property with this name will be overridden.
   ///
   /// See also [WebView.javascriptChannels] for more details on the channel registration mechanism.
   final String name;
diff --git a/packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/platform_webview_widget_creation_params.dart b/packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/platform_webview_widget_creation_params.dart
@@ -73,7 +73,7 @@ class PlatformWebViewWidgetCreationParams {
   /// web view.
   ///
   /// It is possible for other gesture recognizers to be competing with the web
-  /// view on pointer events, e.g if the web view is inside a [ListView] the
+  /// view on pointer events, e.g. if the web view is inside a [ListView] the
   /// [ListView] will want to handle vertical drags. The web view will claim
   /// gestures that are recognized by any of the recognizers on this list.
   ///
diff --git a/packages/webview_flutter/webview_flutter_wkwebview/CHANGELOG.md b/packages/webview_flutter/webview_flutter_wkwebview/CHANGELOG.md
@@ -1,6 +1,7 @@
 ## NEXT
 
 * Updates minimum Flutter version to 3.3.
+* Fixes common typos in tests and documentation.
 
 ## 3.2.3
 
diff --git a/packages/webview_flutter/webview_flutter_wkwebview/example/integration_test/legacy/webview_flutter_test.dart b/packages/webview_flutter/webview_flutter_wkwebview/example/integration_test/legacy/webview_flutter_test.dart
@@ -1293,7 +1293,7 @@ class CopyableObjectWithCallback with Copyable {
 class ClassWithCallbackClass {
   ClassWithCallbackClass() {
     callbackClass = CopyableObjectWithCallback(
-      withWeakRefenceTo(
+      withWeakReferenceTo(
         this,
         (WeakReference<ClassWithCallbackClass> weakReference) {
           return () {
diff --git a/packages/webview_flutter/webview_flutter_wkwebview/example/integration_test/webview_flutter_test.dart b/packages/webview_flutter/webview_flutter_wkwebview/example/integration_test/webview_flutter_test.dart
@@ -1199,7 +1199,7 @@ class CopyableObjectWithCallback with Copyable {
 class ClassWithCallbackClass {
   ClassWithCallbackClass() {
     callbackClass = CopyableObjectWithCallback(
-      withWeakRefenceTo(
+      withWeakReferenceTo(
         this,
         (WeakReference<ClassWithCallbackClass> weakReference) {
           return () {
diff --git a/packages/webview_flutter/webview_flutter_wkwebview/ios/Classes/FWFGeneratedWebKitApis.h b/packages/webview_flutter/webview_flutter_wkwebview/ios/Classes/FWFGeneratedWebKitApis.h
@@ -402,7 +402,7 @@ extern void FWFWKWebViewConfigurationHostApiSetup(
 /// The codec used by FWFWKWebViewConfigurationFlutterApi.
 NSObject<FlutterMessageCodec> *FWFWKWebViewConfigurationFlutterApiGetCodec(void);
 
-/// Handles callbacks from an WKWebViewConfiguration instance.
+/// Handles callbacks from a WKWebViewConfiguration instance.
 ///
 /// See https://developer.apple.com/documentation/webkit/wkwebviewconfiguration?language=objc.
 @interface FWFWKWebViewConfigurationFlutterApi : NSObject
@@ -479,7 +479,7 @@ extern void FWFWKScriptMessageHandlerHostApiSetup(
 /// The codec used by FWFWKScriptMessageHandlerFlutterApi.
 NSObject<FlutterMessageCodec> *FWFWKScriptMessageHandlerFlutterApiGetCodec(void);
 
-/// Handles callbacks from an WKScriptMessageHandler instance.
+/// Handles callbacks from a WKScriptMessageHandler instance.
 ///
 /// See https://developer.apple.com/documentation/webkit/wkscriptmessagehandler?language=objc.
 @interface FWFWKScriptMessageHandlerFlutterApi : NSObject
@@ -507,7 +507,7 @@ extern void FWFWKNavigationDelegateHostApiSetup(
 /// The codec used by FWFWKNavigationDelegateFlutterApi.
 NSObject<FlutterMessageCodec> *FWFWKNavigationDelegateFlutterApiGetCodec(void);
 
-/// Handles callbacks from an WKNavigationDelegate instance.
+/// Handles callbacks from a WKNavigationDelegate instance.
 ///
 /// See https://developer.apple.com/documentation/webkit/wknavigationdelegate?language=objc.
 @interface FWFWKNavigationDelegateFlutterApi : NSObject
@@ -670,7 +670,7 @@ extern void FWFWKUIDelegateHostApiSetup(id<FlutterBinaryMessenger> binaryMesseng
 /// The codec used by FWFWKUIDelegateFlutterApi.
 NSObject<FlutterMessageCodec> *FWFWKUIDelegateFlutterApiGetCodec(void);
 
-/// Handles callbacks from an WKUIDelegate instance.
+/// Handles callbacks from a WKUIDelegate instance.
 ///
 /// See https://developer.apple.com/documentation/webkit/wkuidelegate?language=objc.
 @interface FWFWKUIDelegateFlutterApi : NSObject
diff --git a/packages/webview_flutter/webview_flutter_wkwebview/lib/src/common/weak_reference_utils.dart b/packages/webview_flutter/webview_flutter_wkwebview/lib/src/common/weak_reference_utils.dart
@@ -9,7 +9,7 @@
 /// final JavascriptChannelRegistry javascriptChannelRegistry = ...
 ///
 /// final WKScriptMessageHandler handler = WKScriptMessageHandler(
-///   didReceiveScriptMessage: withWeakRefenceTo(
+///   didReceiveScriptMessage: withWeakReferenceTo(
 ///     javascriptChannelRegistry,
 ///     (WeakReference<JavascriptChannelRegistry> weakReference) {
 ///       return (
@@ -25,7 +25,7 @@
 ///   ),
 /// );
 /// ```
-S withWeakRefenceTo<T extends Object, S extends Object>(
+S withWeakReferenceTo<T extends Object, S extends Object>(
   T reference,
   S Function(WeakReference<T> weakReference) onCreate,
 ) {
diff --git a/packages/webview_flutter/webview_flutter_wkwebview/lib/src/common/web_kit.g.dart b/packages/webview_flutter/webview_flutter_wkwebview/lib/src/common/web_kit.g.dart
@@ -932,7 +932,7 @@ class WKWebViewConfigurationHostApi {
   }
 }
 
-/// Handles callbacks from an WKWebViewConfiguration instance.
+/// Handles callbacks from a WKWebViewConfiguration instance.
 ///
 /// See https://developer.apple.com/documentation/webkit/wkwebviewconfiguration?language=objc.
 abstract class WKWebViewConfigurationFlutterApi {
@@ -1272,7 +1272,7 @@ class _WKScriptMessageHandlerFlutterApiCodec extends StandardMessageCodec {
   }
 }
 
-/// Handles callbacks from an WKScriptMessageHandler instance.
+/// Handles callbacks from a WKScriptMessageHandler instance.
 ///
 /// See https://developer.apple.com/documentation/webkit/wkscriptmessagehandler?language=objc.
 abstract class WKScriptMessageHandlerFlutterApi {
@@ -1394,7 +1394,7 @@ class _WKNavigationDelegateFlutterApiCodec extends StandardMessageCodec {
   }
 }
 
-/// Handles callbacks from an WKNavigationDelegate instance.
+/// Handles callbacks from a WKNavigationDelegate instance.
 ///
 /// See https://developer.apple.com/documentation/webkit/wknavigationdelegate?language=objc.
 abstract class WKNavigationDelegateFlutterApi {
@@ -2454,7 +2454,7 @@ class _WKUIDelegateFlutterApiCodec extends StandardMessageCodec {
   }
 }
 
-/// Handles callbacks from an WKUIDelegate instance.
+/// Handles callbacks from a WKUIDelegate instance.
 ///
 /// See https://developer.apple.com/documentation/webkit/wkuidelegate?language=objc.
 abstract class WKUIDelegateFlutterApi {
diff --git a/packages/webview_flutter/webview_flutter_wkwebview/lib/src/foundation/foundation.dart b/packages/webview_flutter/webview_flutter_wkwebview/lib/src/foundation/foundation.dart
@@ -279,7 +279,7 @@ class NSObject with Copyable {
   /// Otherwise, use [NSObject.dispose] to release the associated Objective-C
   /// object manually.
   ///
-  /// See [withWeakRefenceTo].
+  /// See [withWeakReferenceTo].
   /// {@endtemplate}
   final void Function(
     String keyPath,
diff --git a/packages/webview_flutter/webview_flutter_wkwebview/lib/src/legacy/web_kit_webview_widget.dart b/packages/webview_flutter/webview_flutter_wkwebview/lib/src/legacy/web_kit_webview_widget.dart
@@ -130,7 +130,7 @@ class WebKitWebViewPlatformController extends WebViewPlatformController {
 
   /// Methods for handling navigation changes and tracking navigation requests.
   @visibleForTesting
-  late final WKNavigationDelegate navigationDelegate = withWeakRefenceTo(
+  late final WKNavigationDelegate navigationDelegate = withWeakReferenceTo(
     this,
     (WeakReference<WebKitWebViewPlatformController> weakReference) {
       return webViewProxy.createNavigationDelegate(
@@ -199,7 +199,7 @@ class WebKitWebViewPlatformController extends WebViewPlatformController {
 
     webView = webViewProxy.createWebView(
       configuration,
-      observeValue: withWeakRefenceTo(
+      observeValue: withWeakReferenceTo(
         callbacksHandler,
         (WeakReference<WebViewPlatformCallbacksHandler> weakReference) {
           return (
@@ -437,7 +437,7 @@ class WebKitWebViewPlatformController extends WebViewPlatformController {
         (String channelName) {
           final WKScriptMessageHandler handler =
               webViewProxy.createScriptMessageHandler(
-            didReceiveScriptMessage: withWeakRefenceTo(
+            didReceiveScriptMessage: withWeakReferenceTo(
               javascriptChannelRegistry,
               (WeakReference<JavascriptChannelRegistry> weakReference) {
                 return (
diff --git a/packages/webview_flutter/webview_flutter_wkwebview/lib/src/webkit_webview_controller.dart b/packages/webview_flutter/webview_flutter_wkwebview/lib/src/webkit_webview_controller.dart
diff --git a/packages/webview_flutter/webview_flutter_wkwebview/pigeons/web_kit.dart b/packages/webview_flutter/webview_flutter_wkwebview/pigeons/web_kit.dart
diff --git a/packages/webview_flutter/webview_flutter_wkwebview/test/legacy/web_kit_webview_widget_test.dart b/packages/webview_flutter/webview_flutter_wkwebview/test/legacy/web_kit_webview_widget_test.dart
diff --git a/packages/webview_flutter/webview_flutter_wkwebview/test/webkit_navigation_delegate_test.dart b/packages/webview_flutter/webview_flutter_wkwebview/test/webkit_navigation_delegate_test.dart
