@cspell/url 10.4.0-alpha.1 → 10.4.1

package/dist/index.d.ts

@@ -1,14 +1,11 @@
-//#region src/dataUrl.d.mts
 /**
  * Try to determine the base name of a URL.
  * @param url
  * @returns the base name of a URL, including the trailing `/` if present.
  */
-declare function urlBasename(url: string | URL): string;
-declare function isDataURL(url: string | URL): boolean;
-//#endregion
-//#region src/defaultFileUrlBuilder.d.mts
-declare function encodePathChars(filepath: string): string;
+export declare function urlBasename(url: string | URL): string;
+export declare function isDataURL(url: string | URL): boolean;
+export declare function encodePathChars(filepath: string): string;
 /**
  * Normalize a file path for use in a URL.
  * ```js
@@ -18,7 +15,7 @@ declare function encodePathChars(filepath: string): string;
  * @param filePath
  * @returns a normalized file path for use as a relative path in a URL.
  */
-declare function normalizeFilePathForUrl(filePath: string): string;
+export declare function normalizeFilePathForUrl(filePath: string): string;
 /**
  * Try to make a file URL.
  * - if filenameOrUrl is already a URL, it is returned as is.
@@ -27,28 +24,24 @@ declare function normalizeFilePathForUrl(filePath: string): string;
  * @param relativeTo - optional URL, if given, filenameOrUrl will be parsed as relative.
  * @returns a URL
  */
-declare function toFileURL(filenameOrUrl: string | URL, relativeTo?: string | URL): URL;
+export declare function toFileURL(filenameOrUrl: string | URL, relativeTo?: string | URL): URL;
 /**
  * Converts a file path to a URL and adds a trailing slash.
  * @param dir - url to a directory
  * @returns a URL
  */
-declare function toFileDirURL(dir: string | URL): URL;
-//#endregion
-//#region src/fileUrl.d.mts
+export declare function toFileDirURL(dir: string | URL): URL;
 /**
  * @param url - URL or string to check if it is a file URL.
  * @returns true if the URL is a file URL.
  */
-declare function isFileURL(url: URL | string): boolean;
+export declare function isFileURL(url: URL | string): boolean;
 /**
  * Convert a URL into a string. If it is a file URL, convert it to a path.
  * @param url - URL
  * @returns path or href
  */
-declare function toFilePathOrHref(url: URL | string): string;
-//#endregion
-//#region src/FileUrlBuilder.d.mts
+export declare function toFilePathOrHref(url: URL | string): string;
 interface ParsedPath {
   /**
    * The root of the path such as '/' or 'c:\'
@@ -84,7 +77,7 @@ interface BuilderOptions {
   path?: PathInterface | undefined;
   cwd?: URL | undefined;
 }
-declare class FileUrlBuilder {
+export declare class FileUrlBuilder {
   #private;
   private windows;
   readonly path: PathInterface;
@@ -148,22 +141,20 @@ declare class FileUrlBuilder {
   isAbsolute(filePath: string): boolean;
   isUrlLike(url: string | URL): boolean;
 }
-//#endregion
-//#region src/url.d.mts
 /**
  * Try to make a URL.
  * @param url
  * @param relativeTo - optional URL, if given, url will be parsed as relative.
  * @returns a URL
  */
-declare function toURL(url: string | URL, relativeTo?: string | URL): URL;
+export declare function toURL(url: string | URL, relativeTo?: string | URL): URL;
 /**
  * Try to determine the parent directory URL of the uri.
  * If it is not a hierarchical URL, then it will return the URL.
  * @param url - url to extract the dirname from.
  * @returns a URL
  */
-declare function urlParent(url: string | URL): URL;
+export declare function urlParent(url: string | URL): URL;
 /**
  * Alias of {@link urlParent}
  * Try to determine the parent directory URL of the uri.
@@ -171,49 +162,49 @@ declare function urlParent(url: string | URL): URL;
  * @param url - url to extract the dirname from.
  * @returns a URL
  */
-declare const urlDirname: typeof urlParent;
+export declare const urlDirname: typeof urlParent;
 /**
  * return the basename (last portion of the URL pathname) of a path. It does NOT remove the trailing slash.
  * @param path - URL pathname to extract the basename from.
  */
-declare function basenameOfUrlPathname(path: string): string;
+export declare function basenameOfUrlPathname(path: string): string;
 /**
  * @param filename - filename to check if it is a string containing a URL.
  */
-declare function isUrlLike(filename: string): boolean;
-declare function isUrlLike(filename: URL): true;
+export declare function isUrlLike(filename: string): boolean;
+export declare function isUrlLike(filename: URL): true;
 /**
  * @param filename - filename to check if it is a string containing a URL or a URL object.
  */
-declare function isUrlLike(filename: string | URL): boolean;
+export declare function isUrlLike(filename: string | URL): boolean;
 /**
  * @param filename - filename to check if it is a string containing a URL.
  */
-declare function isNotUrlLike(filename: string): boolean;
-declare function isNotUrlLike(filename: URL): false;
+export declare function isNotUrlLike(filename: string): boolean;
+export declare function isNotUrlLike(filename: URL): false;
 /**
  * @param filename - filename to check if it is a string containing a URL or a URL object.
  */
-declare function isNotUrlLike(filename: string | URL): filename is string;
+export declare function isNotUrlLike(filename: string | URL): filename is string;
 /**
  * Check if `url` is a URL instance.
  * @returns
  */
-declare function isURL(url: unknown): url is URL;
+export declare function isURL(url: unknown): url is URL;
 /**
  *
  * @param url - url to check
  * @param protocol - protocol to check against - e.g. 'file:', 'http:', 'https:'
  * @returns
  */
-declare function hasProtocol(url: string | URL, protocol: string): boolean;
+export declare function hasProtocol(url: string | URL, protocol: string): boolean;
 /**
  * Attempts to add a trailing slash to the URL pathname if it does not already have one.
  * Some If the pathname doesn't start with a `/`, a trailing slash is not added.
  * @param url - a URL
  * @returns
  */
-declare function addTrailingSlash(url: URL): URL;
+export declare function addTrailingSlash(url: URL): URL;
 /**
  * Calculate the relative path to go from `urlFrom` to `urlTo`.
  * The protocol is not evaluated. Only the `url.pathname` is used.
@@ -221,20 +212,19 @@ declare function addTrailingSlash(url: URL): URL;
  * @param urlTo
  * @returns the relative path
  */
-declare function urlRelative(urlFrom: string | URL, urlTo: string | URL): string;
+export declare function urlRelative(urlFrom: string | URL, urlTo: string | URL): string;
 /**
  * Ensure that a windows file url is correctly formatted with a capitol letter for the drive.
  *
  * @param url - URL to check.
  * @returns a new URL if modified or converted from a string.
  */
-declare function normalizeWindowsUrl(url: URL | string): URL;
+export declare function normalizeWindowsUrl(url: URL | string): URL;
 /**
  * There is a bug is NodeJS that sometimes causes UNC paths converted to a URL to be prefixed with `file:////`.
  * @param url - URL to check.
  * @returns fixed URL if needed.
  */
-declare function fixUncUrl(url: URL): URL;
-//#endregion
-export { type BuilderOptions, FileUrlBuilder, type PathInterface, addTrailingSlash, basenameOfUrlPathname, encodePathChars, fixUncUrl, hasProtocol, isDataURL, isFileURL, isNotUrlLike, isURL, isUrlLike, normalizeFilePathForUrl, normalizeWindowsUrl, toFileDirURL, toFilePathOrHref, toFileURL, toURL, urlBasename, urlDirname, urlParent, urlRelative };
+export declare function fixUncUrl(url: URL): URL;
+export type { BuilderOptions, PathInterface };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,7 +1,7 @@
 import assert from "node:assert";
 import Path from "node:path";
 import { fileURLToPath, pathToFileURL } from "node:url";
-//#region src/url.mts
+// src/url.mts
 const isURLRegEx = /^(\w[\w-]{1,63}:\/|data:|stdin:)/i;
 /**
 * Try to make a URL.
@@ -145,8 +145,7 @@ function fixUncUrl(url) {
 	if (url.href.startsWith("file:////")) return new URL(url.href.replace(/^file:\/{4}/, "file://"));
 	return url;
 }
-//#endregion
-//#region src/dataUrl.mts
+// src/dataUrl.mts
 const regMatchFilename = /filename=([^;,]*)/;
 /**
 * Try to determine the base name of a URL.
@@ -166,8 +165,7 @@ function urlBasename(url) {
 function isDataURL(url) {
 	return hasProtocol(url, "data:");
 }
-//#endregion
-//#region src/fileUrl.mts
+// src/fileUrl.mts
 const isWindows = process.platform === "win32";
 const windowsUrlPathRegExp = /^\/[a-zA-Z]:\//;
 function isWindowsPathnameWithDriveLatter(pathname) {
@@ -234,8 +232,7 @@ function fixLongPathPrefix(path) {
 	if (!hasLongPathPrefixAlt(path)) return path;
 	return uncLongPathPrefix + path.slice(4);
 }
-//#endregion
-//#region src/FileUrlBuilder.mts
+// src/FileUrlBuilder.mts
 const isWindowsPathRegEx = regExpWindowsPathDriveLetter;
 const isWindowsPathname = regExpWindowsPath;
 const percentRegEx = /%/g;
@@ -410,8 +407,7 @@ var FileUrlBuilder = class {
 		return isUrlLike(url);
 	}
 };
-//#endregion
-//#region src/defaultFileUrlBuilder.mts
+// src/defaultFileUrlBuilder.mts
 const fileUrlBuilder = new FileUrlBuilder();
 function encodePathChars(filepath) {
 	return fileUrlBuilder.encodePathChars(filepath);
@@ -447,7 +443,6 @@ function toFileURL(filenameOrUrl, relativeTo) {
 function toFileDirURL(dir) {
 	return fileUrlBuilder.toFileDirURL(dir);
 }
-//#endregion
 export { FileUrlBuilder, addTrailingSlash, basenameOfUrlPathname, encodePathChars, fixUncUrl, hasProtocol, isDataURL, isFileURL, isNotUrlLike, isURL, isUrlLike, normalizeFilePathForUrl, normalizeWindowsUrl, toFileDirURL, toFilePathOrHref, toFileURL, toURL, urlBasename, urlDirname, urlParent, urlRelative };
 
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cspell/url",
-  "version": "10.4.0-alpha.1",
+  "version": "10.4.1",
   "description": "URL parsing and manipulation utilities for cspell",
   "publishConfig": {
     "access": "public",
@@ -57,5 +57,5 @@
   "engines": {
     "node": ">=22.18.0"
   },
-  "gitHead": "628768a6e62b792e628189b41e63e12e5d3d8fe3"
+  "gitHead": "ddb1699a4bfc2766675c2c97412a813d775772eb"
 }