Use the 'path.url' Context for everything in Validator

Author: srawlins

lib/src/validator.dart

@@ -37,6 +37,8 @@ class Validator {
       : _origin = path.normalize(origin),
         _hrefs = _packageGraph.allHrefs;
 
+  static path.Context get _urlPath => path.url;
+
   /// Don't call this method more than once, and only after you've
   /// generated all docs for the Package.
   void validateLinks() {
@@ -51,7 +53,7 @@ class Validator {
   }
 
   void _collectLinks(String pathToCheck, [String? source, String? fullPath]) {
-    fullPath ??= path.join(_origin, pathToCheck);
+    fullPath ??= _urlPath.join(_origin, pathToCheck);
 
     final pageLinks = _getLinksAndBaseHref(fullPath);
     if (pageLinks == null) {
@@ -75,14 +77,14 @@ class Validator {
     // the stack without this.
     final toVisit = <(String newPathToCheck, String newFullPath)>{};
     final pathDirectory = baseHref == null
-        ? path.dirname(pathToCheck)
-        : '${path.dirname(pathToCheck)}/$baseHref';
+        ? _urlPath.dirname(pathToCheck)
+        : '${_urlPath.dirname(pathToCheck)}/$baseHref';
 
     for (final href in links) {
       final uri = Uri.tryParse(href);
       if (uri == null || !uri.hasAuthority && !uri.hasFragment) {
-        var linkPath = path.normalize(path.url.join(pathDirectory, href));
-        var newFullPath = path.join(_origin, linkPath);
+        var linkPath = _urlPath.normalize(_urlPath.join(pathDirectory, href));
+        var newFullPath = _urlPath.join(_origin, linkPath);
         if (!_visited.contains(newFullPath)) {
           toVisit.add((linkPath, newFullPath));
           _visited.add(newFullPath);
@@ -97,13 +99,13 @@ class Validator {
   }
 
   void _checkForOrphans() {
-    final staticAssets = path.join(_origin, 'static-assets', '');
-    final indexJson = path.join(_origin, 'index.json');
+    final staticAssets = _urlPath.join(_origin, 'static-assets', '');
+    final indexJson = _urlPath.join(_origin, 'index.json');
     var foundIndexJson = false;
 
     void checkDirectory(Folder dir) {
       for (final child in dir.getChildren()) {
-        final fullPath = path.normalize(child.path);
+        final fullPath = _urlPath.normalize(child.path);
         if (_visited.contains(fullPath)) {
           continue;
         }
@@ -114,12 +116,12 @@ class Validator {
         if (fullPath.startsWith(staticAssets)) {
           continue;
         }
-        if (path.equals(fullPath, indexJson)) {
+        if (_urlPath.equals(fullPath, indexJson)) {
           foundIndexJson = true;
           _onCheckProgress.add(fullPath);
           continue;
         }
-        final relativeFullPath = path.relative(fullPath, from: _origin);
+        final relativeFullPath = _urlPath.relative(fullPath, from: _origin);
         if (!_writtenFiles.contains(relativeFullPath)) {
           // This isn't a file we wrote (this time); don't claim we did.
           _warn(PackageWarning.unknownFile, fullPath, _origin);
@@ -144,8 +146,8 @@ class Validator {
   }
 
   void _checkSearchIndex() {
-    final fullPath = path.join(_origin, 'index.json');
-    final indexPath = path.join(_origin, 'index.html');
+    final fullPath = _urlPath.join(_origin, 'index.json');
+    final indexPath = _urlPath.join(_origin, 'index.html');
     final file = _config.resourceProvider.getFile(fullPath);
     if (!file.exists) {
       return;
@@ -160,11 +162,11 @@ class Validator {
     found.add(indexPath);
     for (var entry in jsonData.cast<Map<String, dynamic>>()) {
       if (entry.containsKey('href')) {
-        var href =
-            path.joinAll([_origin, ...path.url.split(entry['href'] as String)]);
+        var href = _urlPath
+            .joinAll([_origin, ..._urlPath.split(entry['href'] as String)]);
         if (path.extension(href).isEmpty) {
           // An aliased link to an `index.html` file.
-          href = path.url.join(href, 'index.html');
+          href = _urlPath.join(href, 'index.html');
         }
         if (!_visited.contains(href)) {
           _warn(PackageWarning.brokenLink, href, _origin,
@@ -212,8 +214,8 @@ class Validator {
             !uri.startsWith('ftp:'))
         .map((uri) =>
             // An aliased link to an `index.html` file.
-            path.extension(uri).isEmpty
-                ? path.url.join(uri, 'index.html')
+            _urlPath.extension(uri).isEmpty
+                ? _urlPath.join(uri, 'index.html')
                 : uri)
         .toSet();
     var refreshTag = doc
@@ -239,12 +241,12 @@ class Validator {
     final referredFromElements = <Locatable>{};
 
     // Make all paths relative to origin.
-    if (path.isWithin(origin, warnOn)) {
-      warnOn = path.relative(warnOn, from: origin);
+    if (_urlPath.isWithin(origin, warnOn)) {
+      warnOn = _urlPath.relative(warnOn, from: origin);
     }
     if (referredFrom != null) {
-      if (path.isWithin(origin, referredFrom)) {
-        referredFrom = path.relative(referredFrom, from: origin);
+      if (_urlPath.isWithin(origin, referredFrom)) {
+        referredFrom = _urlPath.relative(referredFrom, from: origin);
       }
       final hrefReferredFrom = _hrefs[referredFrom];
       // Source paths are always relative.