Skip to content
⚠️ This article was written in 2019. Some content may be outdated.

Angular 8 CLI Builders:カスタムビルドパイプラインとng-addソリューション

Angular 8はBuilders APIを正式に公開し、コミュニティがng buildng testng serveなどのコマンドに対してカスタム実装を提供できるようになりました。これは@angular-builders/custom-webpack@nrwl/workspaceなどの多くの優れたツールの基盤にもなっています。

angular.jsonのarchitect設定

json
{
  "projects": {
    "my-app": {
      "architect": {
        "build": {
          "builder": "@angular-devkit/build-angular:browser",
          "options": {
            "outputPath": "dist/my-app",
            "index": "src/index.html",
            "main": "src/main.ts"
          },
          "configurations": {
            "production": {
              "optimization": true,
              "sourceMap": false
            }
          }
        }
      }
    }
  }
}

カスタムビルダー

typescript
// builders/timestamp-copy/index.ts
import {
  createBuilder,
  BuilderOutput,
  BuilderContext,
} from "@angular-devkit/architect";
import * as fs from "fs";

export interface TimestampCopyOptions {
  sourceDir: string;
  targetDir: string;
}

export default createBuilder<TimestampCopyOptions>(
  async (options, context): Promise<BuilderOutput> => {
    context.logger.info(
      `コピー開始: ${options.sourceDir} -> ${options.targetDir}`,
    );
    try {
      const timestamp = new Date().toISOString();
      const files = fs.readdirSync(options.sourceDir);
      if (!fs.existsSync(options.targetDir))
        fs.mkdirSync(options.targetDir, { recursive: true });
      files.forEach((file) => {
        fs.copyFileSync(
          `${options.sourceDir}/${file}`,
          `${options.targetDir}/${timestamp}-${file}`,
        );
      });
      return { success: true };
    } catch (e) {
      return { success: false, error: e.message };
    }
  },
);
json
// builders.json
{
  "builders": {
    "timestamp-copy": {
      "implementation": "./index",
      "schema": "./schema.json",
      "description": "タイムスタンププレフィックスでファイルをコピー"
    }
  }
}

Builders APIを使えば、フレームワークをフォークせずにAngularのビルドパイプラインを深くカスタマイズできます。高度なビルド要件を持つチームにとって強力な拡張ポイントです。

MIT Licensed