tree -I node_modules -L 2 ./
./
├── example # ライブラリの動作検証用のサンプルコードを配置するフォルダ
│   ├── handler.js
│   ├── package.json
│   └── serverless.yml
├── lib     # src フォルダ内のファイルをコンパイルした結果を配置するフォルダ (ライブラリとして利用する際に含まれるソースコード群)
│   ├── index.js
│   └── index.js.map
├── package-lock.json
├── package.json
├── src     # Serverless プラグインのソースコードを配置するフォルダ
│   └── index.ts
└── tsconfig.json

# TypeScript の開発に必要なパッケージインストール
npm i -D typescript

# TypeScript の型定義ファイルのインストール
npm i -D @types/node @types/serverless

# 今回は AWS プロバイダー向けの開発を行うため SDK をインストールする
npm i --save aws-sdk

{
  "compilerOptions": {
    "target": "es6",
    "module": "commonjs",
    "moduleResolution": "node",

    "strict": true,

    "strictBindCallApply": false,
    "strictNullChecks": false,

    "outDir": "lib",

    "sourceMap": true
  },
  "include": ["src/**/*"]
}

{
  "main": "lib/index.js",
  "files": ["lib"],
  "scripts": {
    "build": "rm -rf lib && tsc",
    "test": "echo \"Error: no test specified\" && exit 1"
  }
}

// src/index.ts

import * as Serverless from "serverless";
import { SharedIniFileCredentials, config } from "aws-sdk";

/**
 * serverless.yml の custom property の型定義
 */
interface Variables {
  value1: string;
  value2: number;
  value3: boolean;
  profile?: string;
}

export default class Plugin {
  serverless: Serverless;
  options: Serverless.Options;
  hooks: {
    [event: string]: () => Promise<void>;
  };
  variables: Variables;

  /**
   * プラグインの初期化関数。
   * 注意点として、初期化関数内では serverless.yml 内の変数展開が行われないので、
   * ${ssm:~} 等で設定した値を呼び出しても、適切に値が設定されない状態で呼び出すことになる。
   */
  constructor(serverless: Serverless, options: Serverless.Options) {
    this.serverless = serverless;
    this.options = options;

    /**
     * serverless.service.custom 内の特定プロパティを取得するための記述
     * 今回は Serverless のプラグイン名に serverless-typescript を設定したため、
     * serverless-typescript 文字列をキーとして指定する。
     */
    this.variables = serverless.service.custom["serverless-typescript"];

    /**
     * プラグインがフックする関数を指定する。複数指定することも可能だが、
     * 今回は before:package:createDeploymentArtifacts を指定して、
     * パッケージングの手前の処理を定義した run 関数でフックする。
     */
    this.hooks = {
      "before:package:createDeploymentArtifacts": this.run.bind(this),
    };
  }

  /**
   * before:package:createDeploymentArtifacts 時に実行される関数
   */
  async run() {
    /**
     * プラグイン実行時に必要となるフィールドがセットされていなければ処理をスキップする
     */
    if (!this.variables) {
      this.serverless.cli.log(
        `serverless-typescript: Set the custom.serverless-typescript field to an appropriate value.`
      );
      return;
    }

    /**
     * this.serverless.getProvider 関数を用いることで、
     * デプロイ時のアカウントの各種情報について取得することが出来る
     */
    const awsProvider = this.serverless.getProvider("aws");
    const region = await awsProvider.getRegion();
    const accountId = await awsProvider.getAccountId();
    const stage = await awsProvider.getStage();

    /**
     * serverless.yml で指定した値や AWS 情報が取得できているか、
     * 確認するために標準出力する
     */
    this.serverless.cli.log(
      `serverless-typescript values: ${JSON.stringify({
        stage: stage,
        region: region,
        accountId: accountId,
        variables: this.variables,
      })}`
    );

    /**
     * プラグイン内で処理を実行する際、別の特定 Profile を用いたい際は、
     * AWS SDK の SharedIniFileCredentials を用いて切り替えると楽に切替可能。
     * その際は process.env.AWS_SDK_LOAD_CONFIG に値を設定しておくこと
     */
    if (this.variables.profile) {
      process.env.AWS_SDK_LOAD_CONFIG = "true";
      const credentials = new SharedIniFileCredentials({
        profile: this.variables.profile,
      });
      config.credentials = credentials;
    }
  }
}

module.exports = Plugin;

# serverless.yml

custom:
  # custom.serverless-typescript 内の定義を Object として取得可能
  serverless-typescript:
    value1: "value1"
    value2: 0
    value3: true
    # profile: default (optional)

# package.json ファイルを作成する
cd example && npm init -y

{
  "scripts": {
    "prestart": "cd ../ && npm run build",
    "start": "sls package",
    "test": "echo \"Error: no test specified\" && exit 1"
  }
}

# serverless.yml

service:
  name: serverless-typescript
  publish: false

# プラグイン内で利用する設定値を定義する
custom:
  serverless-typescript:
    value1: "value1"
    value2: 0
    value3: true
    profile: custom_profile

provider:
  name: aws
  runtime: nodejs12.x
  region: ap-northeast-1

# プラグインのパスを指定して読み込む
plugins:
  localPath: "../../"
  modules:
    - serverless-typescript

# 何でも良いので動作検証用の関数を定義する (関数の定義は後述)
functions:
  hello:
    handler: handler.hello

// example/handler.js

"use strict";

// 検証用の関数。serverless.yml 内では handler.hello で参照可能
module.exports.hello = (event, context, callback) => {
  callback(null, {
    statusCode: 200,
    body: "Hello World!",
  });
};

cd example && npm start

> example@1.0.0 prestart /Users/nika/Desktop/serverless-typescript/example
> cd ../ && npm run build


> serverless-typescript@1.0.0 build /Users/nika/Desktop/serverless-typescript
> rm -rf lib && tsc


> example@1.0.0 start /Users/nika/Desktop/serverless-typescript/example
> sls package

Serverless: Configuration warning at 'service': unrecognized property 'publish'
Serverless:
Serverless: Learn more about configuration validation here: http://slss.io/configuration-validation
Serverless:
# src/index.ts 内の this.serverless.cli.log の出力内容
# 各種値が正常にセットされていることが確認出来る
Serverless: serverless-typescript values: {"stage":"dev","region":"ap-northeast-1","accountId":"XXXXXXXXXX","variables":{"value1":"value1","value2":0,"value3":true,"profile":"custom_profile"}}
Serverless: Packaging service...
Serverless: Excluding development dependencies...

# serverless.yml (一部抜粋)

custom:
  serverless-typescript:
    profile: <プラグイン実行時に使用したい Profile 名>

// src/index.ts

import * as Serverless from "serverless";
import { SharedIniFileCredentials, config } from "aws-sdk";

interface Variables {
  value1: string;
  value2: number;
  value3: boolean;
  profile?: string;
}

export default class Plugin {
  serverless: Serverless;
  options: Serverless.Options;
  hooks: {
    [event: string]: () => Promise<void>;
  };
  variables: Variables;

  constructor(serverless: Serverless, options: Serverless.Options) {
    this.serverless = serverless;
    this.options = options;

    this.variables = serverless.service.custom["serverless-typescript"];
    this.hooks = {
      "before:package:createDeploymentArtifacts": this.run.bind(this),
    };
  }

  async run() {
    if (!this.variables) {
      this.serverless.cli.log(
        `serverless-typescript: Set the custom.serverless-typescript field to an appropriate value.`
      );
      return;
    }

    const awsProvider = this.serverless.getProvider("aws");
    const region = await awsProvider.getRegion();
    const accountId = await awsProvider.getAccountId();
    const stage = await awsProvider.getStage();

    this.serverless.cli.log(
      `serverless-typescript values: ${JSON.stringify({
        stage: stage,
        region: region,
        accountId: accountId,
        variables: this.variables,
      })}`
    );

    if (this.variables.profile) {
      process.env.AWS_SDK_LOAD_CONFIG = "true";
      const credentials = new SharedIniFileCredentials({
        profile: this.variables.profile,
      });
      config.credentials = credentials;

      // Profile が切り替えられたか確認するためにログを出力する
      this.serverless.cli.log(
        `serverless-typescript profile: ${JSON.stringify(config.credentials)}`
      );
    }
  }
}

module.exports = Plugin;

# 成功時の実行結果
cd example && npm start

# ...
# accessKeyId のフィールドに ~/.aws/credentials 内に存在する値が出力されている
Serverless: serverless-typescript profile: {"expired":false,"expireTime":null,"refreshCallbacks":[],"accessKeyId":"XXXXXXXXXXXXXX","profile":"XXXXXXXXXXXXXX","disableAssumeRole":false,"preferStaticCredentials":false,"tokenCodeFn":null,"httpOptions":null}
# ...

# 失敗時の実行結果
cd example && npm start

# ...
# accessKeyId のフィールドが存在しない時は Profile が正しく設定出来ていない
Serverless: serverless-typescript profile: {"expired":false,"expireTime":null,"refreshCallbacks":[],"profile":"custom_profile","disableAssumeRole":false,"preferStaticCredentials":false,"tokenCodeFn":null,"httpOptions":null}
# ...