Merge pull request #1853 from counterfact/copilot/add-branded-string-utility-function

Add `ForwardSlashPath` branded type and forward-slash path utilities

Author: pmcelhaney

.changeset/add-forward-slash-path-utility.md

@@ -0,0 +1,5 @@
+---
+"counterfact": patch
+---
+
+Add `toForwardSlashPath` utility function and `ForwardSlashPath` branded type. All path normalization that previously used inline `.replaceAll("\\", "/")` now goes through this single, centralized function, making Windows path handling easier to find and reason about.

bin/counterfact.js

@@ -162,6 +162,14 @@ const { loadConfigFile } = await import(
   )
 );
 
+const { pathResolve } = await import(
+  resolve(
+    nativeTs
+      ? "../src/util/forward-slash-path.js"
+      : "../dist/util/forward-slash-path.js",
+  )
+);
+
 const DEFAULT_PORT = 3100;
 
 const debug = createDebug("counterfact:bin:counterfact");
@@ -314,9 +322,9 @@ async function main(source, destination) {
     source = options.spec;
   }
 
-  const destinationPath = nodePath.resolve(destination).replaceAll("\\", "/");
+  const destinationPath = pathResolve(destination);
 
-  const basePath = nodePath.resolve(destinationPath).replaceAll("\\", "/");
+  const basePath = pathResolve(destinationPath);
 
   // If no action-related option is provided, default to all options
 

src/app.ts

@@ -1,5 +1,4 @@
 import fs, { rm } from "node:fs/promises";
-import nodePath from "node:path";
 
 import { createHttpTerminator, type HttpTerminator } from "http-terminator";
 
@@ -19,6 +18,7 @@ import { Transpiler } from "./server/transpiler.js";
 import { CodeGenerator } from "./typescript-generator/code-generator.js";
 import { writeScenarioContextType } from "./typescript-generator/generate.js";
 import { runtimeCanExecuteErasableTs } from "./util/runtime-can-execute-erasable-ts.js";
+import { pathJoin } from "./util/forward-slash-path.js";
 
 export { loadOpenApiDocument } from "./server/load-openapi-document.js";
 
@@ -113,9 +113,7 @@ export async function createMswHandlers(
   await fs.readFile(config.openApiPath);
   const openApiDocument = await loadOpenApiDocument(config.openApiPath);
   const modulesPath = config.basePath;
-  const compiledPathsDirectory = nodePath
-    .join(modulesPath, ".cache")
-    .replaceAll("\\", "/");
+  const compiledPathsDirectory = pathJoin(modulesPath, ".cache");
 
   const registry = new Registry();
   const contextRegistry = new ContextRegistry();
@@ -175,9 +173,10 @@ export async function counterfact(config: Config) {
 
   const nativeTs = await runtimeCanExecuteErasableTs();
 
-  const compiledPathsDirectory = nodePath
-    .join(modulesPath, nativeTs ? "routes" : ".cache")
-    .replaceAll("\\", "/");
+  const compiledPathsDirectory = pathJoin(
+    modulesPath,
+    nativeTs ? "routes" : ".cache",
+  );
 
   if (!nativeTs) {
     await rm(compiledPathsDirectory, { force: true, recursive: true });
@@ -208,7 +207,7 @@ export async function counterfact(config: Config) {
   );
 
   const transpiler = new Transpiler(
-    nodePath.join(modulesPath, "routes").replaceAll("\\", "/"),
+    pathJoin(modulesPath, "routes"),
     compiledPathsDirectory,
     "commonjs",
   );
@@ -217,7 +216,7 @@ export async function counterfact(config: Config) {
     compiledPathsDirectory,
     registry,
     contextRegistry,
-    nodePath.join(modulesPath, "scenarios").replaceAll("\\", "/"),
+    pathJoin(modulesPath, "scenarios"),
     scenarioRegistry,
   );
 

src/migrate/update-route-types.ts

@@ -3,6 +3,7 @@ import path from "node:path";
 
 import createDebug from "debug";
 
+import { toForwardSlashPath } from "../util/forward-slash-path.js";
 import {
   OperationTypeCoder,
   type SecurityScheme,
@@ -271,9 +272,7 @@ async function processRouteDirectory(
         );
       } else if (entry.name.endsWith(".ts") && entry.name !== "_.context.ts") {
         // Process TypeScript route files (skip context files)
-        const routePath = relativePath
-          .replace(/\.ts$/, "")
-          .replaceAll("\\", "/");
+        const routePath = toForwardSlashPath(relativePath.replace(/\.ts$/, ""));
         const methodMap = mapping.get(routePath);
 
         if (methodMap) {

src/server/file-discovery.ts

@@ -1,7 +1,7 @@
 import { existsSync } from "node:fs";
 import fs from "node:fs/promises";
-import nodePath from "node:path";
 
+import { toForwardSlashPath, pathJoin } from "../util/forward-slash-path.js";
 import { escapePathForWindows } from "../util/windows-escape.js";
 
 const JS_EXTENSIONS = new Set(["cjs", "cts", "js", "mjs", "mts", "ts"]);
@@ -17,7 +17,7 @@ export class FileDiscovery {
   private readonly basePath: string;
 
   public constructor(basePath: string) {
-    this.basePath = basePath.replaceAll("\\", "/");
+    this.basePath = toForwardSlashPath(basePath);
   }
 
   /**
@@ -29,9 +29,7 @@ export class FileDiscovery {
    * @throws When `basePath/directory` does not exist.
    */
   public async findFiles(directory = ""): Promise<string[]> {
-    const fullDir = nodePath
-      .join(this.basePath, directory)
-      .replaceAll("\\", "/");
+    const fullDir = pathJoin(this.basePath, directory);
 
     if (!existsSync(fullDir)) {
       throw new Error(`Directory does not exist ${fullDir}`);
@@ -42,9 +40,7 @@ export class FileDiscovery {
     const results = await Promise.all(
       entries.map(async (entry) => {
         if (entry.isDirectory()) {
-          return this.findFiles(
-            nodePath.join(directory, entry.name).replaceAll("\\", "/"),
-          );
+          return this.findFiles(pathJoin(directory, entry.name));
         }
 
         const extension = entry.name.split(".").at(-1);
@@ -53,9 +49,7 @@ export class FileDiscovery {
           return [];
         }
 
-        const fullPath = nodePath
-          .join(this.basePath, directory, entry.name)
-          .replaceAll("\\", "/");
+        const fullPath = pathJoin(this.basePath, directory, entry.name);
 
         return [escapePathForWindows(fullPath)];
       }),

src/server/module-loader.ts

@@ -1,6 +1,6 @@
 import { once } from "node:events";
 import fs from "node:fs/promises";
-import nodePath, { basename, dirname } from "node:path";
+import nodePath, { basename } from "node:path";
 
 import { type FSWatcher, watch } from "chokidar";
 import createDebug from "debug";
@@ -18,6 +18,11 @@ import { ModuleDependencyGraph } from "./module-dependency-graph.js";
 import type { Module, Registry } from "./registry.js";
 import { ScenarioRegistry } from "./scenario-registry.js";
 import { uncachedImport } from "./uncached-import.js";
+import {
+  toForwardSlashPath,
+  pathDirname,
+  pathRelative,
+} from "../util/forward-slash-path.js";
 import { unescapePathForWindows } from "../util/windows-escape.js";
 
 const { uncachedRequire } = await import("./uncached-require.cjs");
@@ -69,10 +74,13 @@ export class ModuleLoader extends EventTarget {
     scenarioRegistry?: ScenarioRegistry,
   ) {
     super();
-    this.basePath = basePath.replaceAll("\\", "/");
+    this.basePath = toForwardSlashPath(basePath);
     this.registry = registry;
     this.contextRegistry = contextRegistry;
-    this.scenariosPath = scenariosPath?.replaceAll("\\", "/");
+    this.scenariosPath =
+      scenariosPath === undefined
+        ? undefined
+        : toForwardSlashPath(scenariosPath);
     this.scenarioRegistry = scenarioRegistry;
     this.fileDiscovery = new FileDiscovery(this.basePath);
   }
@@ -98,7 +106,7 @@ export class ModuleLoader extends EventTarget {
         )
           return;
 
-        const pathName = pathNameOriginal.replaceAll("\\", "/");
+        const pathName = toForwardSlashPath(pathNameOriginal);
 
         if (pathName.includes("$.context") && eventName === "add") {
           process.stdout.write(
@@ -114,17 +122,18 @@ export class ModuleLoader extends EventTarget {
 
         const parts = nodePath.parse(pathName.replace(this.basePath, ""));
         const url = unescapePathForWindows(
-          `/${parts.dir}/${parts.name}`
-            .replaceAll("\\", "/")
-            .replaceAll(/\/+/gu, "/"),
+          toForwardSlashPath(`/${parts.dir}/${parts.name}`).replaceAll(
+            /\/+/gu,
+            "/",
+          ),
         );
 
         if (eventName === "unlink") {
           this.registry.remove(url);
           this.dispatchEvent(new Event("remove"));
           if (this.isContextFile(pathName)) {
             this.contextRegistry.remove(
-              unescapePathForWindows(parts.dir).replaceAll("\\", "/") || "/",
+              unescapePathForWindows(toForwardSlashPath(parts.dir)) || "/",
             );
           }
           return;
@@ -155,7 +164,7 @@ export class ModuleLoader extends EventTarget {
 
           if (!["add", "change", "unlink"].includes(eventName)) return;
 
-          const pathName = pathNameOriginal.replaceAll("\\", "/");
+          const pathName = toForwardSlashPath(pathNameOriginal);
 
           if (eventName === "unlink") {
             const fileKey = this.scenarioFileKey(pathName);
@@ -215,18 +224,18 @@ export class ModuleLoader extends EventTarget {
   }
 
   private scenarioFileKey(pathName: string): string {
-    const normalizedScenariosPath = (this.scenariosPath ?? "").replaceAll(
-      "\\",
-      "/",
+    const normalizedScenariosPath = toForwardSlashPath(
+      this.scenariosPath ?? "",
     );
-    const directory = dirname(
+    const directory = pathDirname(
       pathName.slice(normalizedScenariosPath.length),
-    ).replaceAll("\\", "/");
+    );
     const name = nodePath.parse(basename(pathName)).name;
     const url = unescapePathForWindows(
-      `/${nodePath.join(directory, name)}`
-        .replaceAll("\\", "/")
-        .replaceAll(/\/+/gu, "/"),
+      toForwardSlashPath(`/${nodePath.join(directory, name)}`).replaceAll(
+        /\/+/gu,
+        "/",
+      ),
     );
 
     return url.slice(1); // strip leading "/"
@@ -258,15 +267,12 @@ export class ModuleLoader extends EventTarget {
   private async loadEndpoint(pathName: string) {
     debug("importing module: %s", pathName);
 
-    const directory = dirname(pathName.slice(this.basePath.length)).replaceAll(
-      "\\",
-      "/",
-    );
+    const directory = pathDirname(pathName.slice(this.basePath.length));
 
     const url = unescapePathForWindows(
-      `/${nodePath.join(directory, nodePath.parse(basename(pathName)).name)}`
-        .replaceAll("\\", "/")
-        .replaceAll(/\/+/gu, "/"),
+      toForwardSlashPath(
+        `/${nodePath.join(directory, nodePath.parse(basename(pathName)).name)}`,
+      ).replaceAll(/\/+/gu, "/"),
     );
 
     debug(`loading pathName from dependencyGraph: ${pathName}`);
@@ -290,9 +296,10 @@ export class ModuleLoader extends EventTarget {
           importError instanceof SyntaxError ||
           String(importError).startsWith("SyntaxError:");
 
-        const displayPath = nodePath
-          .relative(process.cwd(), unescapePathForWindows(pathName))
-          .replaceAll("\\", "/");
+        const displayPath = pathRelative(
+          process.cwd(),
+          unescapePathForWindows(pathName),
+        );
 
         const message = isSyntaxError
           ? `There is a syntax error in the route file: ${displayPath}`

src/server/transpiler.ts

@@ -2,13 +2,13 @@
 
 import { once } from "node:events";
 import fs from "node:fs/promises";
-import nodePath from "node:path";
 
 import { type FSWatcher, watch as chokidarWatch } from "chokidar";
 import createDebug from "debug";
 import ts from "typescript";
 
 import { ensureDirectoryExists } from "../util/ensure-directory-exists.js";
+import { toForwardSlashPath, pathJoin } from "../util/forward-slash-path.js";
 import { CHOKIDAR_OPTIONS } from "./constants.js";
 import { convertFileExtensionsToCjs } from "./convert-js-extensions-to-cjs.js";
 
@@ -79,12 +79,13 @@ export class Transpiler extends EventTarget {
         )
           return;
 
-        const sourcePath = sourcePathOriginal.replaceAll("\\", "/");
+        const sourcePath = toForwardSlashPath(sourcePathOriginal);
 
-        const destinationPath = sourcePath
-          .replace(this.sourcePath, this.destinationPath)
-          .replaceAll("\\", "/")
-          .replace(".ts", this.extension);
+        const destinationPath = toForwardSlashPath(
+          sourcePath
+            .replace(this.sourcePath, this.destinationPath)
+            .replace(".ts", this.extension),
+        );
 
         if (["add", "change"].includes(eventName)) {
           transpiles.push(
@@ -152,13 +153,11 @@ export class Transpiler extends EventTarget {
 
     const result: string = transpileOutput.outputText;
 
-    const fullDestination = nodePath
-      .join(
-        sourcePath
-          .replace(this.sourcePath, this.destinationPath)
-          .replace(".ts", this.extension),
-      )
-      .replaceAll("\\", "/");
+    const fullDestination = pathJoin(
+      sourcePath
+        .replace(this.sourcePath, this.destinationPath)
+        .replace(".ts", this.extension),
+    );
 
     const resultWithTransformedFileExtensions =
       convertFileExtensionsToCjs(result);

src/typescript-generator/generate.ts

@@ -5,6 +5,7 @@ import nodePath from "node:path";
 import createDebug from "debug";
 
 import { ensureDirectoryExists } from "../util/ensure-directory-exists.js";
+import { pathRelative } from "../util/forward-slash-path.js";
 import { OperationCoder } from "./operation-coder.js";
 import { type SecurityScheme } from "./operation-type-coder.js";
 import { pruneRoutes } from "./prune.js";
@@ -210,9 +211,7 @@ async function walkForContextFiles(
         results,
       );
     } else if (entry.name === "_.context.ts") {
-      const relDir = nodePath
-        .relative(routesDir, currentDir)
-        .replaceAll("\\", "/");
+      const relDir = pathRelative(routesDir, currentDir);
       const routePath = relDir === "" ? "/" : `/${relDir}`;
       const depth = relDir === "" ? 0 : relDir.split("/").length;
       const importPath =

src/typescript-generator/operation-coder.ts

@@ -1,5 +1,4 @@
-import nodePath from "node:path";
-
+import { pathJoin } from "../util/forward-slash-path.js";
 import { Coder } from "./coder.js";
 import {
   OperationTypeCoder,
@@ -88,8 +87,6 @@ export class OperationCoder extends Coder {
       .at(-2)!
       .replaceAll("~1", "/");
 
-    return `${nodePath
-      .join("routes", pathString)
-      .replaceAll("\\", "/")}.types.ts`;
+    return `${pathJoin("routes", pathString)}.types.ts`;
   }
 }