Merge pull request #68 from zirkelc/fix-60-tsconfig-paths

fix: resolve tsconfig paths with tsx

Author: mnapoli

lib/configuration/read.js

@@ -56,12 +56,16 @@ const parseConfigurationFile = async (configurationPath) => {
     case '.ts':
     case '.mts': {
       try {
-        const { createJiti } = require('jiti');
-        const jiti = createJiti(null, { interopDefault: true });
+        /**
+         * Jiti does not support `tsconfig.paths`, so we need to use tsx to load the configuration file.
+         * @see https://github.com/unjs/jiti/issues/373
+         * @see https://tsx.is/dev-api/tsx-require
+         */
+        // eslint-disable-next-line import/no-unresolved
+        const tsx = require('tsx/cjs/api');
+        const content = tsx.require(configurationPath, __filename);
 
-        const content = await jiti.import(configurationPath, { default: true });
-
-        return content;
+        return content.default || content;
       } catch (error) {
         throw new ServerlessError(
           `Cannot parse "${path.basename(configurationPath)}": Initialization error: ${

package.json

@@ -53,7 +53,6 @@
     "graceful-fs": "^4.2.11",
     "https-proxy-agent": "^5.0.1",
     "is-docker": "^2.2.1",
-    "jiti": "^2.4.2",
     "js-yaml": "^4.1.0",
     "json-cycle": "^1.5.0",
     "json-refs": "^3.0.15",
@@ -73,6 +72,7 @@
     "strip-ansi": "^6.0.1",
     "supports-color": "^8.1.1",
     "timers-ext": "^0.1.7",
+    "tsx": "^4.20.3",
     "type": "^2.7.2",
     "untildify": "^4.0.0",
     "uuid": "^9.0.0",

test/unit/lib/configuration/read.test.js

@@ -117,6 +117,50 @@ describe('test/unit/lib/configuration/read.test.js', () => {
     }
   });
 
+  it('should support tsconfig.paths', async () => {
+    await fse.ensureDir('node_modules');
+    const tsconfigPath = 'tsconfig.json';
+    const servicePath = 'test.ts';
+
+    try {
+      await fse.writeFile(
+        tsconfigPath,
+        JSON.stringify({
+          compilerOptions: {
+            paths: {
+              '@/test': ['./test.ts'],
+            },
+          },
+          include: ['**/*.ts'],
+        })
+      );
+
+      await fse.writeFile(servicePath, "export const service = 'test-ts';");
+
+      configurationPath = 'serverless.ts';
+      const configuration = {
+        service: 'test-ts',
+        provider: { name: 'aws' },
+      };
+
+      await fsp.writeFile(
+        configurationPath,
+        `import { service } from '@/test';
+
+        export default {
+          service: service,
+          provider: { name: 'aws' },
+        }`
+      );
+      const result = await readConfiguration(configurationPath);
+      expect(result).to.deep.equal(configuration);
+    } finally {
+      await fse.remove('node_modules');
+      await fsp.unlink(tsconfigPath);
+      await fsp.unlink(servicePath);
+    }
+  });
+
   it('should support deferred configuration result', async () => {
     // JS configurations are required (so immune to modules caching).
     // In this tests we cannot use same JS configuration path twice for testing