Deno/std
1
0
Fork 0
mirror of https://github.com/denoland/std.git synced 2024-11-21 20:50:22 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

feat(path/unstable): support URL input in dirname() (#5747)

Browse Source
This commit is contained in:
Yoshiya Hinosawa 2024-08-21 14:28:58 +09:00 committed by GitHub
parent 5092c7e9f1
commit 8e96c1992f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 100 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
path/dirname.ts
View File

@ -23,6 +23,29 @@ import { dirname as windowsDirname } from "./windows/dirname.ts";
* @param path Path to extract the directory from.
* @returns The directory path.
*/
export function dirname(path: string): string {
return isWindows ? windowsDirname(path) : posixDirname(path);
export function dirname(path: string): string;
/**
* Return the directory path of a file URL.
*
* @experimental **UNSTABLE**: New API, yet to be vetted.
*
* @example Usage
* ```ts
* import { dirname } from "@std/path/dirname";
* import { assertEquals } from "@std/assert";
*
* if (Deno.build.os === "windows") {
* assertEquals(dirname(new URL("file:///C:/home/user/Documents/image.png")), "C:\\home\\user\\Documents");
* } else {
* assertEquals(dirname(new URL("file:///home/user/Documents/image.png")), "/home/user/Documents");
* }
* ```
*
* @param path Path to extract the directory from.
* @returns The directory path.
*/
export function dirname(path: URL): string;
export function dirname(path: string | URL): string {
// deno-lint-ignore no-explicit-any
return isWindows ? windowsDirname(path as any) : posixDirname(path as any);
}

30
path/dirname_test.ts
View File

@ -1,7 +1,7 @@
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
// Copyright the Browserify authors. MIT License.
// Ported from https://github.com/browserify/path-browserify/
import { assertEquals } from "@std/assert";
import { assertEquals, assertThrows } from "@std/assert";
import { dirname } from "./dirname.ts";
import * as posix from "./posix/mod.ts";
import * as windows from "./windows/mod.ts";
@ -87,6 +87,20 @@ Deno.test("posix.dirname()", function () {
assertEquals(posix.dirname("/foo/bar/baz\\"), "/foo/bar");
});
Deno.test("posix.dirname() works with file URLs", () => {
assertEquals(
posix.dirname(new URL("file:///home/user/Documents/image.png")),
"/home/user/Documents",
);
// throws with non-file URLs
assertThrows(
() => posix.dirname(new URL("https://deno.land/")),
TypeError,
"Must be a file URL.",
);
});
Deno.test("windows.dirname()", function () {
for (const [name, expected] of WINDOWS_TESTSUITE) {
assertEquals(windows.dirname(name), expected);
@ -101,3 +115,17 @@ Deno.test("windows.dirname()", function () {
assertEquals(windows.dirname(name), expected);
}
});
Deno.test("windows.dirname() works with file URLs", () => {
assertEquals(
windows.dirname(new URL("file:///C:/home/user/Documents/image.png")),
"C:\\home\\user\\Documents",
);
// throws with non-file URLs
assertThrows(
() => windows.dirname(new URL("https://deno.land/")),
TypeError,
"Must be a file URL.",
);
});

24
path/posix/dirname.ts
View File

@ -4,6 +4,7 @@
import { assertArg } from "../_common/dirname.ts";
import { stripTrailingSeparators } from "../_common/strip_trailing_separators.ts";
import { isPosixPathSeparator } from "./_util.ts";
import { fromFileUrl } from "./from_file_url.ts";
/**
* Return the directory path of a `path`.
@ -32,7 +33,28 @@ import { isPosixPathSeparator } from "./_util.ts";
* @param path The path to get the directory from.
* @returns The directory path.
*/
export function dirname(path: string): string {
export function dirname(path: string): string;
/**
* Return the directory path of a file URL.
*
* @experimental **UNSTABLE**: New API, yet to be vetted.
*
* @example Usage
* ```ts
* import { dirname } from "@std/path/posix/dirname";
* import { assertEquals } from "@std/assert";
*
* assertEquals(dirname(new URL("file:///home/user/Documents/image.png")), "/home/user/Documents");
* ```
*
* @param path The file url to get the directory from.
* @returns The directory path.
*/
export function dirname(path: URL): string;
export function dirname(path: string | URL): string {
if (path instanceof URL) {
path = fromFileUrl(path);
}
assertArg(path);
let end = -1;

24
path/windows/dirname.ts
View File

@ -9,6 +9,7 @@ import {
isPosixPathSeparator,
isWindowsDeviceRoot,
} from "./_util.ts";
import { fromFileUrl } from "./from_file_url.ts";
/**
* Return the directory path of a `path`.
@ -25,7 +26,28 @@ import {
* @param path The path to get the directory from.
* @returns The directory path.
*/
export function dirname(path: string): string {
export function dirname(path: string): string;
/**
* Return the directory path of a file URL.
*
* @experimental **UNSTABLE**: New API, yet to be vetted.
*
* @example Usage
* ```ts
* import { dirname } from "@std/path/windows/dirname";
* import { assertEquals } from "@std/assert";
*
* assertEquals(dirname(new URL("file:///C:/foo/bar/baz.ext")), "C:\\foo\\bar");
* ```
*
* @param path The path to get the directory from.
* @returns The directory path.
*/
export function dirname(path: URL): string;
export function dirname(path: string | URL): string {
if (path instanceof URL) {
path = fromFileUrl(path);
}
assertArg(path);
const len = path.length;