feat: expose cwdPath property via bundler, dev-server and the test-runner

Author: thetutlage

src/bundler.ts

@@ -13,8 +13,8 @@ import type tsStatic from 'typescript'
 import { cliui } from '@poppinss/cliui'
 import { fileURLToPath } from 'node:url'
 import type Hooks from '@poppinss/hooks'
-import { join, relative } from 'node:path'
 import string from '@poppinss/utils/string'
+import { join, relative } from 'node:path/posix'
 import { detectPackageManager } from '@antfu/install-pkg'
 
 import type { BundlerOptions } from './types/common.ts'
@@ -62,11 +62,6 @@ export const SUPPORTED_PACKAGE_MANAGERS: {
  * const success = await bundler.bundle()
  */
 export class Bundler {
-  /**
-   * The current working project directory path as string
-   */
-  #cwdPath: string
-
   /**
    * Reference to the TypeScript module
    */
@@ -92,12 +87,17 @@ export class Bundler {
   /**
    * The current working directory URL
    */
-  public cwd: URL
+  cwd: URL
+
+  /**
+   * The current working project directory path as string
+   */
+  cwdPath: string
 
   /**
    * Bundler configuration options including hooks and meta files
    */
-  public options: BundlerOptions
+  options: BundlerOptions
 
   /**
    * Create a new bundler instance
@@ -109,7 +109,7 @@ export class Bundler {
   constructor(cwd: URL, ts: typeof tsStatic, options: BundlerOptions) {
     this.cwd = cwd
     this.options = options
-    this.#cwdPath = fileURLToPath(this.cwd)
+    this.cwdPath = string.toUnixSlash(fileURLToPath(this.cwd))
     this.#ts = ts
   }
 
@@ -118,7 +118,7 @@ export class Bundler {
    * file path
    */
   #getRelativeName(filePath: string) {
-    return string.toUnixSlash(relative(this.#cwdPath, filePath))
+    return string.toUnixSlash(relative(this.cwdPath, filePath))
   }
 
   /**
@@ -152,14 +152,14 @@ export class Bundler {
       .map((file) => file.pattern)
       .concat(additionalFilesToCopy)
 
-    await copyFiles(metaFiles, this.#cwdPath, outDir)
+    await copyFiles(metaFiles, this.cwdPath, outDir)
   }
 
   /**
    * Detect the package manager used by the project
    */
   async #detectPackageManager(): Promise<SupportedPackageManager | null> {
-    const pkgManager = await detectPackageManager(this.#cwdPath)
+    const pkgManager = await detectPackageManager(this.cwdPath)
     if (pkgManager === 'deno') {
       return 'npm'
     }

src/dev_server.ts

@@ -83,11 +83,6 @@ export class DevServer {
     hotReloaded: false,
   }
 
-  /**
-   * File path computed from the cwd
-   */
-  #cwdPath: string
-
   /**
    * External listeners that are invoked when child process
    * gets an error or closes
@@ -223,12 +218,17 @@ export class DevServer {
   /**
    * The current working directory URL
    */
-  public cwd: URL
+  cwd: URL
+
+  /**
+   * File path computed from the cwd
+   */
+  cwdPath: string
 
   /**
    * Development server configuration options including hooks and environment variables
    */
-  public options: DevServerOptions
+  options: DevServerOptions
 
   /**
    * Create a new DevServer instance
@@ -239,8 +239,8 @@ export class DevServer {
   constructor(cwd: URL, options: DevServerOptions) {
     this.cwd = cwd
     this.options = options
-    this.#cwdPath = string.toUnixSlash(fileURLToPath(this.cwd))
-    this.#indexGenerator = new IndexGenerator(this.#cwdPath, this.ui.logger)
+    this.cwdPath = string.toUnixSlash(fileURLToPath(this.cwd))
+    this.#indexGenerator = new IndexGenerator(this.cwdPath, this.ui.logger)
   }
 
   /**
@@ -459,7 +459,7 @@ export class DevServer {
     this.ui.logger.info(`starting server in ${this.#mode} mode...`)
 
     this.#stickyPort = String(await getPort(this.cwd))
-    this.#fileSystem = new FileSystem(this.#cwdPath, tsConfig, this.options)
+    this.#fileSystem = new FileSystem(this.cwdPath, tsConfig, this.options)
 
     this.ui.logger.info('loading hooks...')
     this.#hooks = await loadHooks(this.options.hooks, [
@@ -527,7 +527,7 @@ export class DevServer {
         } else if (this.#mode === 'hmr' && this.#isHotHookMessage(message)) {
           debug('received hot-hook message %O', message)
           const absolutePath = message.path ? string.toUnixSlash(message.path) : ''
-          const relativePath = relative(this.#cwdPath, absolutePath)
+          const relativePath = relative(this.cwdPath, absolutePath)
 
           if (message.type === 'hot-hook:file-changed') {
             const { action } = message
@@ -656,7 +656,7 @@ export class DevServer {
      */
     this.#watcher = watch({
       usePolling: options?.poll ?? false,
-      cwd: this.#cwdPath,
+      cwd: this.cwdPath,
       ignoreInitial: true,
       ignored: (file, stats) => {
         if (!stats) {
@@ -689,19 +689,19 @@ export class DevServer {
 
     this.#watcher.on('add', (filePath) => {
       const relativePath = string.toUnixSlash(filePath)
-      const absolutePath = join(this.#cwdPath, relativePath)
+      const absolutePath = join(this.cwdPath, relativePath)
       this.#hooks.runner('fileAdded').run(relativePath, absolutePath, this)
     })
     this.#watcher.on('change', (filePath) => {
       const relativePath = string.toUnixSlash(filePath)
-      const absolutePath = join(this.#cwdPath, relativePath)
+      const absolutePath = join(this.cwdPath, relativePath)
       this.#hooks
         .runner('fileChanged')
         .run(relativePath, absolutePath, DevServer.#WATCHER_INFO, this)
     })
     this.#watcher.on('unlink', (filePath) => {
       const relativePath = string.toUnixSlash(filePath)
-      const absolutePath = join(this.#cwdPath, relativePath)
+      const absolutePath = join(this.cwdPath, relativePath)
       this.#hooks.runner('fileRemoved').run(relativePath, absolutePath, this)
     })
   }

src/test_runner.ts

@@ -95,11 +95,6 @@ export class TestRunner {
     }
   >
 
-  /**
-   * The current working directory path as a string
-   */
-  #cwdPath: string
-
   /**
    * Index generator for managing auto-generated index files
    */
@@ -145,12 +140,17 @@ export class TestRunner {
   /**
    * The current working directory URL
    */
-  public cwd: URL
+  cwd: URL
+
+  /**
+   * The current working directory path as a string
+   */
+  cwdPath: string
 
   /**
    * Test runner configuration options including filters, reporters, and hooks
    */
-  public options: TestRunnerOptions
+  options: TestRunnerOptions
 
   /**
    * Create a new TestRunner instance
@@ -161,8 +161,8 @@ export class TestRunner {
   constructor(cwd: URL, options: TestRunnerOptions) {
     this.cwd = cwd
     this.options = options
-    this.#cwdPath = string.toUnixSlash(fileURLToPath(this.cwd))
-    this.#indexGenerator = new IndexGenerator(this.#cwdPath, this.ui.logger)
+    this.cwdPath = string.toUnixSlash(fileURLToPath(this.cwd))
+    this.#indexGenerator = new IndexGenerator(this.cwdPath, this.ui.logger)
   }
 
   /**
@@ -462,7 +462,7 @@ export class TestRunner {
     }
 
     this.#stickyPort = String(await getPort(this.cwd))
-    this.#fileSystem = new FileSystem(this.#cwdPath, tsConfig, {
+    this.#fileSystem = new FileSystem(this.cwdPath, tsConfig, {
       ...this.options,
       suites: this.options.suites?.filter((suite) => {
         if (this.options.filters.suites) {
@@ -503,7 +503,7 @@ export class TestRunner {
      */
     this.#watcher = watch({
       usePolling: options?.poll ?? false,
-      cwd: this.#cwdPath,
+      cwd: this.cwdPath,
       ignoreInitial: true,
       ignored: (file, stats) => {
         if (!stats) {
@@ -536,12 +536,12 @@ export class TestRunner {
 
     this.#watcher.on('add', (filePath) => {
       const relativePath = string.toUnixSlash(filePath)
-      const absolutePath = join(this.#cwdPath, filePath)
+      const absolutePath = join(this.cwdPath, filePath)
       this.#hooks.runner('fileAdded').run(relativePath, absolutePath, this)
     })
     this.#watcher.on('change', (filePath) => {
       const relativePath = string.toUnixSlash(filePath)
-      const absolutePath = join(this.#cwdPath, filePath)
+      const absolutePath = join(this.cwdPath, filePath)
       this.#hooks.runner('fileChanged').run(
         relativePath,
         absolutePath,
@@ -555,7 +555,7 @@ export class TestRunner {
     })
     this.#watcher.on('unlink', (filePath) => {
       const relativePath = string.toUnixSlash(filePath)
-      const absolutePath = join(this.#cwdPath, filePath)
+      const absolutePath = join(this.cwdPath, filePath)
       this.#hooks.runner('fileRemoved').run(relativePath, absolutePath, this)
     })
   }