如何在serverless.yml中导入TS变量文件并保留类型信息？

这个场景我碰到过好多次了——手里有个类型定义得特别完善的大型TS配置对象，想在整个应用里复用，还得传给Serverless框架，但它只认JS文件，又不想丢了类型提示的安全感对吧？别慌，这几个方案能完美解决你的问题：

1. 抽离共享配置为TS模块，编译生成JS供Serverless调用 #

这是最稳妥的生产级方案，核心就是把配置单独放在TS文件里，编译出对应的JS版本，让应用代码用TS（保类型），Serverless用编译后的JS（保兼容性）。

具体步骤： #

• 先把你的类型化配置抽成单独的config.ts：

// config.ts
// 先定义类型，保证全应用的类型一致性
export type AppConfig = {
  apiUrl: string;
  timeout: number;
  env: 'dev' | 'prod';
};

// 再导出实际的配置对象，支持环境变量注入
export const appConfig: AppConfig = {
  apiUrl: process.env.API_URL || 'https://api.example.com',
  timeout: 30000,
  env: (process.env.NODE_ENV as 'dev' | 'prod') || 'dev'
};

• 确保tsconfig.json里把这个文件纳入编译范围，编译后会在输出目录（比如dist/）生成config.js和config.d.ts——前者给Serverless用，后者给你的TS代码提供类型提示。
• 应用代码里直接导入TS版本，享受完整类型提示：

// 你的业务TS文件
import { appConfig } from './config';

// 这里用appConfig的时候，编辑器会自动提示属性和类型
console.log(appConfig.apiUrl);

• 在serverless.yml里，用框架自带的${file(...)}语法导入编译后的JS配置：

# serverless.yml
service: my-awesome-service

custom:
  # 直接读取JS文件里导出的appConfig对象
  appConfig: ${file(./dist/config.js):appConfig}

provider:
  name: aws
  runtime: nodejs18.x
  # 把配置注入到函数环境变量里，函数里也能直接用
  environment:
    API_URL: ${self:custom.appConfig.apiUrl}
    TIMEOUT: ${self:custom.appConfig.timeout}

这样一来，配置逻辑只写一次，应用端有类型，Serverless端能读取，完全不会出现配置不一致的问题。

2. 开发阶段用ts-node让Serverless直接读TS配置 #

如果开发时不想每次改配置都手动编译TS，你可以用ts-node让Serverless直接识别TS配置文件，省掉编译步骤：

具体步骤： #

• 先装依赖：npm install ts-node typescript --save-dev
• 可以单独写个Serverless专用的TS配置入口（也可以直接用原有的config.ts）：

// serverless.config.ts
import { appConfig } from './config';

// 导出给Serverless用的配置结构
export default {
  appConfig
};

• 在serverless.yml里直接引用TS文件，同时通过ts-node/register让Node.js能解析TS：

# serverless.yml
service: my-awesome-service

custom:
  # 直接读取TS文件里的默认导出
  appConfig: ${file(./serverless.config.ts):default}

provider:
  name: aws
  runtime: nodejs18.x
  # ...其他配置

• 最后，在启动Serverless命令时加上ts-node/register，或者在package.json里写个脚本：

{
  "scripts": {
    "deploy:dev": "ts-node/register node_modules/serverless/bin/serverless deploy",
    "offline": "ts-node/register node_modules/serverless/bin/serverless offline"
  }
}

这个方式适合开发阶段快速迭代，不过生产环境还是建议用编译后的JS，避免运行时编译的性能开销。

3. 用Serverless插件一键搞定TS配置导入 #

还有个更省心的方式——用serverless-plugin-typescript插件，它不仅能帮你编译函数的TS代码，还能自动处理配置文件的TS导入：

具体步骤： #

• 安装插件：npm install serverless-plugin-typescript --save-dev
• 在serverless.yml里配置插件，然后直接引用你的TS配置文件：

# serverless.yml
service: my-awesome-service

plugins:
  - serverless-plugin-typescript

custom:
  # 直接引用原TS配置文件里的appConfig
  appConfig: ${file(./config.ts):appConfig}

provider:
  name: aws
  runtime: nodejs18.x
  # ...其他配置

插件会自动帮你处理TS的编译和导入逻辑，你不用手动管编译步骤，开发和部署都能直接用TS配置，同时应用代码的类型提示也完全保留。

几个关键注意点 #

• 环境变量要确保Serverless运行时能读到：比如部署时可以通过.env文件、CI/CD变量或者Serverless的参数注入来设置，避免配置里的process.env取不到值。
• 如果配置有复杂的动态逻辑（比如根据环境计算值），直接写在TS文件里就行，编译后的JS会保留这些逻辑，Serverless执行时会正确计算。

内容的提问来源于stack exchange，提问作者Daniel Birowsky Popeski