Distinguish between URL paths and file paths at the type level #881
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| import fs, {type MakeDirectoryOptions, type Stats, type WatchListener, type WriteFileOptions} from "node:fs"; | ||
| import fsp, {type FileHandle} from "node:fs/promises"; | ||
| import {FilePath, unFilePath} from "./brandedPath.js"; | ||
|
|
||
| export const constants = fsp.constants; | ||
|
|
||
| export function access(path: FilePath, mode?: number): Promise<void> { | ||
| return fsp.access(unFilePath(path), mode); | ||
| } | ||
|
|
||
| export function accessSync(path: FilePath, mode?: number): void { | ||
| return fs.accessSync(unFilePath(path), mode); | ||
| } | ||
|
|
||
| export function copyFile(source: FilePath, destination: FilePath, flags?: number): Promise<void> { | ||
| return fsp.copyFile(unFilePath(source), unFilePath(destination), flags); | ||
| } | ||
|
|
||
| export function readFile(path: FilePath, encoding?: undefined): Promise<Buffer>; | ||
| export function readFile(path: FilePath, encoding: BufferEncoding): Promise<string>; | ||
| export function readFile(path: FilePath, encoding?: BufferEncoding | undefined): Promise<string | Buffer> { | ||
| return fsp.readFile(unFilePath(path), encoding); | ||
| } | ||
|
|
||
| export function readFileSync(path: FilePath, encoding: BufferEncoding): string { | ||
| return fs.readFileSync(unFilePath(path), encoding); | ||
| } | ||
|
|
||
| export function writeFile(path: FilePath, data: string | Buffer, options?: WriteFileOptions): Promise<void> { | ||
| return fsp.writeFile(unFilePath(path), data, options); | ||
| } | ||
|
|
||
| export function writeFileSync(path: FilePath, data: string | Buffer, options?: WriteFileOptions): void { | ||
| return fs.writeFileSync(unFilePath(path), data, options); | ||
| } | ||
|
|
||
| export async function mkdir(path: FilePath, options?: MakeDirectoryOptions): Promise<FilePath | undefined> { | ||
| const rv = await fsp.mkdir(unFilePath(path), options); | ||
| return rv ? FilePath(rv) : undefined; | ||
| } | ||
|
|
||
| export function readdir(path: FilePath): Promise<string[]> { | ||
| return fsp.readdir(unFilePath(path)); | ||
| } | ||
|
|
||
| export function stat(path: FilePath): Promise<Stats> { | ||
| return fsp.stat(unFilePath(path)); | ||
| } | ||
|
|
||
| export function open(path: FilePath, flags: string | number, mode?: number): Promise<FileHandle> { | ||
| return fsp.open(unFilePath(path), flags, mode); | ||
| } | ||
|
|
||
| export function rename(oldPath: FilePath, newPath: FilePath): Promise<void> { | ||
| return fsp.rename(unFilePath(oldPath), unFilePath(newPath)); | ||
| } | ||
|
|
||
| export function renameSync(oldPath: FilePath, newPath: FilePath): void { | ||
| return fs.renameSync(unFilePath(oldPath), unFilePath(newPath)); | ||
| } | ||
|
|
||
| export function unlink(path: FilePath): Promise<void> { | ||
| return fsp.unlink(unFilePath(path)); | ||
| } | ||
|
|
||
| export function unlinkSync(path: FilePath): void { | ||
| return fs.unlinkSync(unFilePath(path)); | ||
| } | ||
|
|
||
| export function existsSync(path: FilePath): boolean { | ||
| return fs.existsSync(unFilePath(path)); | ||
| } | ||
|
|
||
| export function readdirSync(path: FilePath): FilePath[] { | ||
| return fs.readdirSync(unFilePath(path)) as unknown as FilePath[]; | ||
| } | ||
|
|
||
| export function statSync(path: FilePath): Stats { | ||
| return fs.statSync(unFilePath(path)); | ||
| } | ||
|
|
||
| export function watch(path: FilePath, listener?: WatchListener<string>): fs.FSWatcher { | ||
| return fs.watch(unFilePath(path), listener); | ||
| } | ||
|
|
||
| export function utimes(path: FilePath, atime: Date, mtime: Date): Promise<void> { | ||
| return fsp.utimes(unFilePath(path), atime, mtime); | ||
| } | ||
|
|
||
| export function utimesSync(path: FilePath, atime: Date, mtime: Date): void { | ||
| return fs.utimesSync(unFilePath(path), atime, mtime); | ||
| } | ||
|
|
||
| export function createReadStream(path: FilePath): fs.ReadStream { | ||
| return fs.createReadStream(unFilePath(path)); | ||
| } | ||
|
|
||
| export function rm(path: FilePath, options?: {force?: boolean; recursive?: boolean}): Promise<void> { | ||
| return fsp.rm(unFilePath(path), options); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| import osPath from "node:path"; | ||
| import posixPath from "node:path/posix"; | ||
|
|
||
| // including "unknown &" here improves type error message | ||
| type BrandedString<T> = unknown & | ||
| Omit<string, "replace" | "slice"> & {__type: T} & { | ||
| replace: (search: string | RegExp, replace: string) => BrandedString<T>; | ||
| slice: (start?: number, end?: number) => BrandedString<T>; | ||
| }; | ||
|
|
||
| export type FilePath = BrandedString<"FilePath">; | ||
| export type UrlPath = BrandedString<"UrlPath">; | ||
|
|
||
| export function FilePath(path: string | FilePath): FilePath { | ||
| if (osPath.sep === "\\") { | ||
| path = path.replaceAll("/", osPath.sep); | ||
| } else if (osPath.sep === "/") { | ||
| path = path.replaceAll("\\", osPath.sep); | ||
| } | ||
| return path as unknown as FilePath; | ||
| } | ||
|
|
||
| export function UrlPath(path: string | UrlPath): UrlPath { | ||
| path = path.replaceAll("\\", posixPath.sep); | ||
| return path as unknown as UrlPath; | ||
| } | ||
|
|
||
| export function unFilePath(path: FilePath | string): string { | ||
| return path as unknown as string; | ||
| } | ||
|
|
||
| export function unUrlPath(path: UrlPath | string): string { | ||
| return path as unknown as string; | ||
| } | ||
|
|
||
|
Comment on lines
+28
to
+35
There was a problem hiding this comment. these no-op functions are here only for the sake of typing (or, untyping), there should be a better way to do this with typescript only? There was a problem hiding this comment. One thing that I was disappointed about was that I couldn't figure out how to safely tell TypeScript that I think if we wanted to eliminate these functions, we'd have to inline the I agree though that I would prefer some better way to do this, like maybe a "type level function". I don't know of one though. There was a problem hiding this comment. All of the wrapping worries me, but I can't express why. It feels excessive or invasive maybe? I'm definitely wishing we didn't have to do it. There was a problem hiding this comment. This pattern, of having a new type that is just an existing type with a new name is something that I've used in other languages. In those languages there are often nice features built into the language that help make this easier, like implicit conversion, operator overloading, and monad-style-map. TypeScript doesn't really give us any of those things, so it is all a bit clunky. I could imagine taking out most of these wrappers now (except for the places where we need slash conversion). I don't know how we would prevent new changes to the code base from getting it wrong in the future. Maybe just test coverage and Windows in CI? That feels much less robust than TypeScript to me. |
||
| export function filePathToUrlPath(path: FilePath): UrlPath { | ||
| if (osPath.sep === "/") return path as unknown as UrlPath; | ||
| return urlJoin(...(path.split(osPath.sep) as string[])); | ||
| } | ||
|
|
||
| export function urlPathToFilePath(path: UrlPath): FilePath { | ||
| if (osPath.sep === "/") return path as unknown as FilePath; | ||
| return fileJoin(...(path.split(posixPath.sep) as string[])); | ||
| } | ||
|
|
||
| // Implemenations of node:path functions: | ||
|
|
||
| export function urlJoin(...paths: (string | UrlPath)[]): UrlPath { | ||
| return posixPath.join(...(paths as string[])) as unknown as UrlPath; | ||
| } | ||
|
|
||
| export function fileJoin(...paths: (string | FilePath)[]): FilePath { | ||
| return osPath.join(...(paths as string[])) as unknown as FilePath; | ||
| } | ||
|
|
||
| export function fileRelative(from: string | FilePath, to: string | FilePath): FilePath { | ||
| return FilePath(osPath.relative(unFilePath(from), unFilePath(to))); | ||
| } | ||
|
|
||
| export function fileDirname(path: string | FilePath): FilePath { | ||
| return FilePath(osPath.dirname(unFilePath(path))); | ||
| } | ||
|
|
||
| export function urlDirname(path: string | UrlPath): UrlPath { | ||
| return UrlPath(posixPath.dirname(unUrlPath(path))); | ||
| } | ||
|
|
||
| export function fileNormalize(path: string | FilePath): FilePath { | ||
| return FilePath(osPath.normalize(unFilePath(path))); | ||
| } | ||
|
|
||
| export function urlNormalize(path: string | UrlPath): UrlPath { | ||
| return UrlPath(osPath.normalize(unUrlPath(path))); | ||
| } | ||
|
|
||
| export function fileBasename(path: string | FilePath, suffix?: string): string { | ||
| return osPath.basename(unFilePath(path), suffix); | ||
| } | ||
|
|
||
| export function urlBasename(path: string | UrlPath, suffix?: string): string { | ||
| return osPath.basename(unUrlPath(path), suffix); | ||
| } | ||
|
|
||
| export function fileExtname(path: string | FilePath | string): string { | ||
| return osPath.extname(unFilePath(path)); | ||
| } | ||
|
|
||
| export function urlExtname(path: string | UrlPath | string): string { | ||
| return osPath.extname(unUrlPath(path)); | ||
| } | ||
|
|
||
| export function fileResolve(...paths: (string | FilePath)[]): FilePath { | ||
| return FilePath(osPath.resolve(...(paths as string[]))); | ||
| } | ||
|
|
||
| export function urlResolve(...paths: (string | UrlPath)[]): UrlPath { | ||
| return UrlPath(osPath.resolve(...(paths as string[]))); | ||
| } | ||
|
|
||
| export const fileSep = osPath.sep as unknown as FilePath; | ||
| export const urlSep = posixPath.sep as unknown as UrlPath; | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this is in
dependenciesalready, we shouldn’t also need it indevDependencies.