Improves CI and documentation

Author: terrier989

.github/FUNDING.yml

@@ -1,20 +1,70 @@
 name: Dart CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+env:
+  PANA_SCORE_MAX_DIFFERENCE: 20
 
 jobs:
+  format:
+    name: Verify code formatting
+    runs-on: ubuntu-slim
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dart-lang/setup-dart@v1
+      - name: Install dependencies
+        run: dart --version && dart pub get
+      - name: Verify formatting
+        run: dart format --set-exit-if-changed .
+  lints:
+    name: Analyze source code
+    needs: [format]
+    runs-on: ubuntu-slim
+    strategy:
+      fail-fast: false
+      matrix:
+        sdk: [3.6, stable, beta, dev]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dart-lang/setup-dart@v1
+        with:
+          sdk: ${{ matrix.sdk }}
+      - name: Install dependencies
+        run: dart --version && dart pub get
+      - name: Analyze project source
+        run: dart analyze
+  package_health:
+    name: Analyze package health
+    needs: [lints]
+    runs-on: ubuntu-slim
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dart-lang/setup-dart@v1
+      - name: Install dependencies
+        run: dart --version && dart pub get && dart pub global activate pana
+      - name: Run package analyzer
+        run: dart pub global run pana --exit-code-threshold $PANA_SCORE_MAX_DIFFERENCE
   test:
-    runs-on: ${{ matrix.os }}
+    name: Run tests
+    needs: [lints]
+    runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        os: [ubuntu-latest]
-        sdk: [3.0, stable, beta, dev]
+        sdk: [stable, beta, dev]
     steps:
       - uses: actions/checkout@v3
       - uses: dart-lang/setup-dart@v1
         with:
           sdk: ${{ matrix.sdk }}
+      - uses: browser-actions/setup-chrome@v2
       - name: Install dependencies
-        run: dart pub get
-      - name: Run tests
-        run: dart test --platform vm
+        run: dart --version && dart pub get
+      - name: Run tests (VM)
+        run: dart test --platform vm
+      - name: Run tests (Chrome, JS)
+        run: dart test --platform chrome --compiler dart2js

.github/workflows/dart.yml

@@ -0,0 +1,14 @@
+name: Publish to pub.dev
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+  publish:
+    permissions:
+      id-token: write
+    uses: dart-lang/setup-dart/.github/workflows/publish.yml@v1
+    with:
+      environment: pub.dev

.github/workflows/publish.yml

@@ -1,5 +1,8 @@
+## 2.2.7
+* Improves documentation and tests.
+
 ## 2.2.6
-* Removes an unnecesary dependency.
+* Removes an unnecessary dependency.
 
 ## 2.2.5
 * Updates the library for new Dart SDK and fixes most analyzer warnings.

CHANGELOG.md

@@ -3,13 +3,13 @@
 [![Github Actions CI](https://github.com/dint-dev/universal_html/workflows/Dart%20CI/badge.svg)](https://github.com/dint-dev/universal_html/actions)
 
 # Introduction
-A cross-platform `dart:html`:
+A cross-platform replacement for `dart:html` (or `package:web`):
   * __Eases cross-platform development__
     * You can use this package in browsers, mobile, desktop, and server-side VM, and Node.JS.
-    * Just replace `dart:html` imports with `package:universal_html/html.dart`. Normal
+    * Just replace `dart:html` / `package:web` imports with `package:universal_html/html.dart`. Normal
       _dart:html_ will continue to be used when application run in browsers.
   * __Extensive support for processing HTML and XML documents__
-    * Parse, manipulate, and print [DOM nodes](https://api.dart.dev/stable/2.19.3/dart-html/Node-class.html).
+    * Parse, manipulate, and print [DOM nodes](https://api.flutter.dev/flutter/dart-html/Node-class.html).
     * Find DOM nodes with [querySelectorAll](https://api.dart.dev/stable/2.19.3/dart-html/querySelectorAll.html)
       and other CSS query methods.
   * __EventSource streaming support__
@@ -35,12 +35,12 @@ which is documented in the relevant files.
 In `pubspec.yaml`:
 ```yaml
 dependencies:
-  universal_html: ^2.2.5
+  universal_html: ^2.2.7
 ```
 
 ## 2. Use
 ```dart
-import "package:universal_html/html.dart";
+import "package:universal_html/universal_html.dart";
 
 void main() {
   // Create a DOM tree

README.md

@@ -12,28 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-/// Cross-platform "dart:html" library.
-///
-/// You can choose from the following libraries:
-///   * `package:universal_html/html.dart`
-///   * `package:universal_html/prefer_sdk/html.dart`
-///   * `package:universal_html/prefer_universal/html.dart`
-///
-/// # Introduction
-///
-/// HTML elements and other resources for web-based applications that need to
-/// interact with the browser and the DOM (Document Object Model).
-///
-/// This library includes DOM element types, CSS styling, local storage,
-/// media, speech, events, and more.
-/// To get started,
-/// check out the [Element] class, the base class for many of the HTML
-/// DOM types.
-///
-/// For information on writing web apps with Dart, see https://webdev.dartlang.org.
+/// @nodoc
+@Deprecated('Replace with "package:universal_html/universal_html.dart.')
 library;
 
-export 'src/_sdk/html.dart'
-    if (dart.library.html) 'src/_sdk/html.dart' // Browser
-    if (dart.library.io) 'src/html.dart' // VM
-    if (dart.library.js) 'src/html.dart'; // Node.JS
+export 'universal_html.dart';

lib/html.dart

@@ -52,8 +52,7 @@ abstract class EventSourceOutsideBrowser implements EventSource {
   FutureOr<void> Function(
     EventSourceOutsideBrowser eventSource,
     HttpClientRequest request,
-  )?
-  onHttpClientRequest;
+  )? onHttpClientRequest;
 
   /// A callback called when a [HttpClientResponse] arrives (only outside
   /// browsers).
@@ -63,8 +62,7 @@ abstract class EventSourceOutsideBrowser implements EventSource {
     EventSourceOutsideBrowser eventSource,
     HttpClientRequest request,
     HttpClientResponse response,
-  )?
-  onHttpClientResponse;
+  )? onHttpClientResponse;
 
   /// Current timeout.
   Duration retryDuration = Duration(seconds: 3);

lib/src/_sdk_html_additions.dart

@@ -15,8 +15,7 @@
 import 'package:universal_html/html.dart';
 
 import 'internal_element_data_impl_others.dart'
-    if (dart.library.html) 'internal_element_data_impl_browser.dart'
-    as impl;
+    if (dart.library.html) 'internal_element_data_impl_browser.dart' as impl;
 
 /// Internal data of [Element].
 ///

lib/src/controller/internal_element_data.dart

@@ -19,8 +19,7 @@ import 'package:universal_html/html.dart';
 import 'window_behavior_impl_browser.dart'
     if (dart.library.html) 'window_behavior_impl_browser.dart' // Browser
     if (dart.library.io) 'window_behavior_impl_others.dart' // VM
-    if (dart.library.js) 'window_behavior_impl_others.dart'
-    as impl; // Node.JS
+    if (dart.library.js) 'window_behavior_impl_others.dart' as impl; // Node.JS
 
 /// Defines behavior of the browser APIs (such as navigation events).
 ///

lib/src/controller/window_behavior.dart

@@ -27,10 +27,9 @@ Document newDocument({
 
 HtmlDocument newHtmlDocument({required Window window, String? contentType}) {
   return DomParser().parseFromString(
-        '<html></html>',
-        contentType ?? 'text/html',
-      )
-      as HtmlDocument;
+    '<html></html>',
+    contentType ?? 'text/html',
+  ) as HtmlDocument;
 }
 
 Navigator newNavigator({required Window window}) {