feat: additional paths for SWC server compilation (#264)

Author: dgaponov

.gitignore

@@ -9,3 +9,4 @@ node_modules
 dist
 
 examples/**/package-lock.json
+.DS_Store

src/commands/build/build-service/server.ts

@@ -16,6 +16,8 @@ compile({
     logger,
     outputPath: ${JSON.stringify(paths.appDist)},
     projectPath: ${JSON.stringify(paths.appServer)},
+    additionalPaths: ${JSON.stringify(config.server.swcOptions?.additionalPaths)},
+    exclude: ${JSON.stringify(config.server.swcOptions?.exclude)},
 });`;
 }
 

src/commands/dev/server.ts

@@ -48,6 +48,8 @@ watch(
         onAfterFilesEmitted: () => {
             process.send({type: 'Emitted'});
         },
+        additionalPaths: ${JSON.stringify(config.server.swcOptions?.additionalPaths)},
+        exclude: ${JSON.stringify(config.server.swcOptions?.exclude)},
     }
 );`;
 }

src/common/models/index.ts

@@ -365,11 +365,21 @@ export interface ServerConfig {
     watchThrottle?: number;
     inspect?: number | true;
     inspectBrk?: number | true;
+
     /**
      * Compiler for server code compilation
      * @default 'typescript'
      */
     compiler?: ServerCompiler;
+
+    /**
+     * Additional options for SWC compilation.
+     * Works only if `compiler` is 'swc'.
+     */
+    swcOptions?: {
+        additionalPaths?: string[];
+        exclude?: string | string[];
+    };
 }
 export interface ServiceConfig {
     target?: 'client' | 'server';

src/common/swc/compile.ts

@@ -3,18 +3,29 @@ import {elapsedTime} from '../logger/pretty-time';
 // @ts-ignore @swc/cli is not typed
 import {swcDir} from '@swc/cli';
 import {EXTENSIONS_TO_COMPILE, getSwcOptionsFromTsconfig} from './utils';
+import type {GetSwcOptionsFromTsconfigOptions} from './utils';
 
-interface SwcCompileOptions {
+type SwcCompileOptions = Pick<GetSwcOptionsFromTsconfigOptions, 'additionalPaths' | 'exclude'> & {
     projectPath: string;
     outputPath: string;
     logger: Logger;
-}
+};
 
-export async function compile({projectPath, outputPath, logger}: SwcCompileOptions): Promise<void> {
+export async function compile({
+    projectPath,
+    outputPath,
+    logger,
+    additionalPaths,
+    exclude,
+}: SwcCompileOptions): Promise<void> {
     const start = process.hrtime.bigint();
     logger.message('Start compilation');
 
-    const {swcOptions, directoriesToCompile} = getSwcOptionsFromTsconfig(projectPath);
+    const {swcOptions, directoriesToCompile} = getSwcOptionsFromTsconfig({
+        projectPath,
+        additionalPaths,
+        exclude,
+    });
 
     const cliOptions = {
         filenames: directoriesToCompile,

src/common/swc/utils.ts

@@ -1,6 +1,8 @@
 import path from 'path';
 import {convert} from 'tsconfig-to-swcconfig';
 
+const DEFAULT_EXCLUDE = ['node_modules'];
+
 export const EXTENSIONS_TO_COMPILE = ['.js', '.ts', '.mts', '.mjs', '.cjs'];
 
 function resolvePaths(paths: Record<string, string[]>, baseUrl: string) {
@@ -14,17 +16,41 @@ function resolvePaths(paths: Record<string, string[]>, baseUrl: string) {
     return entries;
 }
 
-export function getSwcOptionsFromTsconfig(projectPath: string, filename = 'tsconfig.json') {
+export type GetSwcOptionsFromTsconfigOptions = {
+    projectPath: string;
+    filename?: string;
+    additionalPaths?: string[];
+    exclude?: string | string[];
+};
+
+export function getSwcOptionsFromTsconfig({
+    projectPath,
+    filename = 'tsconfig.json',
+    additionalPaths,
+    exclude,
+}: GetSwcOptionsFromTsconfigOptions) {
     const swcOptions = convert(filename, projectPath);
+    swcOptions.exclude = swcOptions.exclude || [];
     swcOptions.jsc = {
         ...swcOptions.jsc,
         // SWC requires absolute path as baseUrl
         baseUrl: projectPath,
     };
 
+    let customExclude: string[] = [];
+    if (Array.isArray(exclude)) {
+        customExclude = exclude;
+    } else if (exclude) {
+        customExclude = [exclude];
+    }
+
+    swcOptions.exclude = [...(swcOptions.exclude || []), ...DEFAULT_EXCLUDE, ...customExclude];
+
     // SWC don't compile referenced files like tsc, so we need collect all directories to compile.
     const paths = swcOptions.jsc.paths || {};
-    const directoriesToCompile = [projectPath, ...resolvePaths(paths, projectPath)];
+    const directoriesToCompile = [
+        ...new Set([projectPath, ...resolvePaths(paths, projectPath), ...(additionalPaths || [])]),
+    ];
 
     return {
         swcOptions,

src/common/swc/watch.ts

@@ -2,19 +2,24 @@ import type {Logger} from '../logger';
 // @ts-ignore @swc/cli is not typed
 import {swcDir} from '@swc/cli';
 import {EXTENSIONS_TO_COMPILE, getSwcOptionsFromTsconfig} from './utils';
+import type {GetSwcOptionsFromTsconfigOptions} from './utils';
 
-interface SwcWatchOptions {
+type SwcWatchOptions = Pick<GetSwcOptionsFromTsconfigOptions, 'additionalPaths' | 'exclude'> & {
     outputPath: string;
     logger: Logger;
     onAfterFilesEmitted?: () => void;
-}
+};
 
 export async function watch(
     projectPath: string,
-    {outputPath, logger, onAfterFilesEmitted}: SwcWatchOptions,
+    {outputPath, logger, onAfterFilesEmitted, additionalPaths, exclude}: SwcWatchOptions,
 ) {
     logger.message('Start compilation in watch mode');
-    const {swcOptions, directoriesToCompile} = getSwcOptionsFromTsconfig(projectPath);
+    const {swcOptions, directoriesToCompile} = getSwcOptionsFromTsconfig({
+        projectPath,
+        additionalPaths,
+        exclude,
+    });
 
     const cliOptions = {
         filenames: directoriesToCompile,