mirror of
https://github.com/denoland/std.git
synced 2024-11-22 04:59:05 +00:00
107 lines
2.6 KiB
TypeScript
107 lines
2.6 KiB
TypeScript
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
|
|
import * as path from "../path/mod.ts";
|
|
import { basename, normalize } from "../path/mod.ts";
|
|
|
|
/**
|
|
* Test whether `src` and `dest` resolve to the same location
|
|
* @param src src file path
|
|
* @param dest dest file path
|
|
*/
|
|
export function isSamePath(
|
|
src: string | URL,
|
|
dest: string | URL,
|
|
): boolean | void {
|
|
src = toPathString(src);
|
|
dest = toPathString(dest);
|
|
|
|
return path.resolve(src) === path.resolve(dest);
|
|
}
|
|
|
|
/**
|
|
* Test whether or not `dest` is a sub-directory of `src`
|
|
* @param src src file path
|
|
* @param dest dest file path
|
|
* @param sep path separator
|
|
*/
|
|
export function isSubdir(
|
|
src: string | URL,
|
|
dest: string | URL,
|
|
sep: string = path.SEP,
|
|
): boolean {
|
|
if (src === dest) {
|
|
return false;
|
|
}
|
|
src = toPathString(src);
|
|
const srcArray = src.split(sep);
|
|
dest = toPathString(dest);
|
|
const destArray = dest.split(sep);
|
|
return srcArray.every((current, i) => destArray[i] === current);
|
|
}
|
|
|
|
export type PathType = "file" | "dir" | "symlink";
|
|
|
|
/**
|
|
* Get a human readable file type string.
|
|
*
|
|
* @param fileInfo A FileInfo describes a file and is returned by `stat`,
|
|
* `lstat`
|
|
*/
|
|
export function getFileInfoType(fileInfo: Deno.FileInfo): PathType | undefined {
|
|
return fileInfo.isFile
|
|
? "file"
|
|
: fileInfo.isDirectory
|
|
? "dir"
|
|
: fileInfo.isSymlink
|
|
? "symlink"
|
|
: undefined;
|
|
}
|
|
|
|
/**
|
|
* Walk entry for {@linkcode walk}, {@linkcode walkSync},
|
|
* {@linkcode expandGlob} and {@linkcode expandGlobSync}.
|
|
*/
|
|
export interface WalkEntry extends Deno.DirEntry {
|
|
/** Full path of the entry. */
|
|
path: string;
|
|
}
|
|
|
|
/** Create {@linkcode WalkEntry} for the `path` synchronously. */
|
|
export function createWalkEntrySync(path: string | URL): WalkEntry {
|
|
path = toPathString(path);
|
|
path = normalize(path);
|
|
const name = basename(path);
|
|
const info = Deno.statSync(path);
|
|
return {
|
|
path,
|
|
name,
|
|
isFile: info.isFile,
|
|
isDirectory: info.isDirectory,
|
|
isSymlink: info.isSymlink,
|
|
};
|
|
}
|
|
|
|
/** Create {@linkcode WalkEntry} for the `path` asynchronously. */
|
|
export async function createWalkEntry(path: string | URL): Promise<WalkEntry> {
|
|
path = toPathString(path);
|
|
path = normalize(path);
|
|
const name = basename(path);
|
|
const info = await Deno.stat(path);
|
|
return {
|
|
path,
|
|
name,
|
|
isFile: info.isFile,
|
|
isDirectory: info.isDirectory,
|
|
isSymlink: info.isSymlink,
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Convert a URL or string to a path
|
|
* @param pathUrl A URL or string to be converted
|
|
*/
|
|
export function toPathString(
|
|
pathUrl: string | URL,
|
|
): string {
|
|
return pathUrl instanceof URL ? path.fromFileUrl(pathUrl) : pathUrl;
|
|
}
|