refactor: move extension rewrite logic to paths resolver

Author: thetutlage

src/code_scanners/routes_scanner/main.ts

@@ -202,7 +202,7 @@ export class RoutesScanner {
  return {
  name,
  method: method ?? 'handle',
- path: string.toUnixSlash(this.pathsResolver.resolve(specifier)),
+ path: string.toUnixSlash(this.pathsResolver.resolve(specifier, true)),
  import: {
  specifier,
  type: 'default',

src/paths_resolver.ts

@@ -73,7 +73,7 @@ export class PathsResolver {
  * const path = resolver.resolve('#app/models/user')
  * const path2 = resolver.resolve('@/utils/helper')
  */
- resolve(specifier: string) {
+ resolve(specifier: string, rewriteAliasImportExtension: boolean = false) {
  if (isRelative(specifier)) {
  throw new Error('Cannot resolve relative paths using PathsResolver')
  }
@@ -84,7 +84,21 @@ export class PathsResolver {
  return cached
  }
 
- this.#resolvedPaths[cacheKey] = fileURLToPath(this.#resolver(specifier, this.#appRoot))
+ /**
+ * Currently the PathsResolver relies on a non-standard way of resolving
+ * absolute paths or paths with subpath imports. Because of which, the
+ * on-disk file could be TypeScript, while the resolved filepath is
+ * JavaScript.
+ *
+ * To overcome this limitation, we rewrite the file extension to ".ts" when
+ * the import specifier starts with a "#".
+ */
+ let resolvedPath = fileURLToPath(this.#resolver(specifier, this.#appRoot))
+ if (rewriteAliasImportExtension && specifier.startsWith('#') && resolvedPath.endsWith('.js')) {
+ resolvedPath = resolvedPath.replace(/\.js$/, '.ts')
+ }
+
+ this.#resolvedPaths[cacheKey] = resolvedPath
  return this.#resolvedPaths[cacheKey]
  }
 }

src/virtual_file_system.ts

@@ -86,32 +86,6 @@ export class VirtualFileSystem {
  this.#matcher = picomatch(this.#options.glob ?? DEFAULT_GLOB, this.#picoMatchOptions)
  }
 
- /**
- * Currently the PathsResolver relies on a non-standard way of resolving
- * absolute paths or paths with subpath imports. Because of which, the
- * on-disk file could be TypeScript, while the resolved filepath is
- * JavaScript.
- *
- * To overcome this limitation, we start by first looking for a `.ts` file
- * (because of high probability) and then look for `.js` file
- */
- async #readTSOrJSFile(filePath: string): Promise<string> {
- if (filePath.endsWith('.js')) {
- try {
- const contents = await readFile(filePath.replace(/\.js$/, '.ts'), 'utf-8')
- debug('read as TypeScript file "%s"', filePath)
- return contents
- } catch (error) {
- if (error.code === 'ENOENT') {
- return readFile(filePath, 'utf-8')
- }
- throw error
- }
- }
-
- return readFile(filePath, 'utf-8')
- }
-
  /**
  * Scans the filesystem to collect the files. Newly files must
  * be added via the ".add" method.
@@ -262,7 +236,7 @@ export class VirtualFileSystem {
  return cached
  }
 
- const fileContents = await this.#readTSOrJSFile(filePath)
+ const fileContents = await readFile(filePath, 'utf-8')
  debug('parsing "%s" file to AST', filePath)
 
  this.#astCache.set(filePath, parse(Lang.TypeScript, fileContents).root())

tests/dev_server.spec.ts

@@ -293,7 +293,7 @@ test.group('DevServer', () => {
  await fs.createJson('tsconfig.json', { include: ['**/*'], exclude: [] })
  await fs.create(
  'bin/server.ts',
- `process.send({ type: 'hot-hook:invalidated', path: '${normalizePathForWindows(join(fs.basePath, 'start/routes.ts'))}' });`
+ `process.send({ type: 'hot-hook:invalidated', paths: ['${normalizePathForWindows(join(fs.basePath, 'start/routes.ts'))}'] });`
  )
  await fs.create('start/routes.ts', ``)
  await fs.create('.env', 'PORT=3338')