refactor: PathReference -> PathRef

README.md

@@ -472,10 +472,10 @@ pb.with(() => {
 
 ## Path API
 
-The path API offers an immutable `PathReference` class, which is a similar concept to Rust's `PathBuf` struct.
+The path API offers an immutable `PathRef` class, which is a similar concept to Rust's `PathBuf` struct.
 
 ```ts
-// create a `PathReference`
+// create a `PathRef`
 let srcDir = $.path("src");
 // get information about the path
 srcDir.isDir(); // false
@@ -509,7 +509,7 @@ const srcDir = $.path("src").resolve();
 await $`echo ${srcDir}`;
 ```
 
-There are a lot of helper methods here, so check the [documentation on PathReference](https://deno.land/x/dax/src/path.ts?s=PathReference) for more details.
+There are a lot of helper methods here, so check the [documentation on PathRef](https://deno.land/x/dax/src/path.ts?s=PathRef) for more details.
 
 ## Helper functions
 

mod.ts

@@ -28,9 +28,9 @@ import {
 import { colors, fs, outdent, path as stdPath, which, whichSync } from "./src/deps.ts";
 import { wasmInstance } from "./src/lib/mod.ts";
 import { RequestBuilder, withProgressBarFactorySymbol } from "./src/request.ts";
-import { createPathReference } from "./src/path.ts";
+import { createPathRef } from "./src/path.ts";
 
-export { FsFileWrapper, PathReference } from "./src/path.ts";
+export { FsFileWrapper, PathRef } from "./src/path.ts";
 export { CommandBuilder, CommandResult } from "./src/command.ts";
 export type { CommandContext, CommandHandler, CommandPipeReader, CommandPipeWriter } from "./src/command_handler.ts";
 export type {
@@ -221,7 +221,7 @@ export interface $BuiltInProperties<TExtras extends ExtrasObject = {}> {
   /** Helper function for creating path references, which provide an easier way for
    * working with paths, directories, and files on the file system. Also, a re-export
    * of deno_std's `path` module as properties on this object. */
-  path: typeof createPathReference & typeof stdPath;
+  path: typeof createPathRef & typeof stdPath;
   /**
    * Logs with potential indentation (`$.logIndent`)
    * and output of commands or request responses.
@@ -531,7 +531,7 @@ function buildInitial$State<TExtras extends ExtrasObject>(
 
 const helperObject = {
   fs,
-  path: Object.assign(createPathReference, stdPath),
+  path: Object.assign(createPathRef, stdPath),
   cd,
   escapeArg,
   stripAnsi(text: string) {

src/command.ts

@@ -24,7 +24,7 @@ import { parseCommand, spawn } from "./shell.ts";
 import { cpCommand, mvCommand } from "./commands/cp_mv.ts";
 import { isShowingProgressBars } from "./console/progress/interval.ts";
 import { touchCommand } from "./commands/touch.ts";
-import { PathReference } from "./path.ts";
+import { PathRef } from "./path.ts";
 
 type BufferStdio = "inherit" | "null" | "streamed" | Buffer;
 
@@ -293,11 +293,11 @@ export class CommandBuilder implements PromiseLike<CommandResult> {
   }
 
   /** Sets the current working directory to use when executing this command. */
-  cwd(dirPath: string | URL | PathReference) {
+  cwd(dirPath: string | URL | PathRef) {
     return this.#newWithState((state) => {
       state.cwd = dirPath instanceof URL
         ? path.fromFileUrl(dirPath)
-        : dirPath instanceof PathReference
+        : dirPath instanceof PathRef
         ? dirPath.resolve().toString()
         : path.resolve(dirPath);
     });

src/deps.test.ts

@@ -1,4 +1,4 @@
-import { createPathReference, PathReference } from "./path.ts";
+import { createPathRef, PathRef } from "./path.ts";
 
 export {
   assert,
@@ -14,12 +14,12 @@ export { serve } from "https://deno.land/[email protected]/http/server.ts";
  * Creates a temporary directory, changes the cwd to this directory,
  * then cleans up and restores the cwd when complete.
  */
-export async function withTempDir(action: (path: PathReference) => Promise<void> | void) {
+export async function withTempDir(action: (path: PathRef) => Promise<void> | void) {
   const originalDirPath = Deno.cwd();
   const dirPath = Deno.makeTempDirSync();
   Deno.chdir(dirPath);
   try {
-    await action(createPathReference(dirPath).resolve());
+    await action(createPathRef(dirPath).resolve());
   } finally {
     try {
       await Deno.remove(dirPath, { recursive: true });