Skip to content
@aws/nx-plugin
Blog

ジェネレーターを作成する

@aws/nx-plugin向けの新しいジェネレーターを作成して、tRPC API用のプロシージャを生成してみましょう。

プラグインのチェックアウト

まずプラグインをクローンします：

Terminal window
git clone git@github.com:awslabs/nx-plugin-for-aws.git

依存関係のインストールとビルド：

Terminal window
cd nx-plugin-for-aws
pnpm i
pnpm nx run-many --target build --all

空のジェネレーター作成

新しいジェネレーターをpackages/nx-plugin/src/trpc/procedureに作成します。

ジェネレーター作成用のジェネレーターを利用してスキャフォールディングできます：

  1. インストール Nx Console VSCode Plugin まだインストールしていない場合
  2. VSCodeでNxコンソールを開く
  3. クリック Generate (UI) "Common Nx Commands"セクションで
  4. 検索 @aws/nx-plugin - ts#nx-generator
  5. 必須パラメータを入力
    • pluginProject: @aws/nx-plugin
    • name: ts#trpc-api#procedure
    • directory: trpc/procedure
    • description: Adds a procedure to a tRPC API
  6. クリック Generate

以下のファイルが自動生成されます：

  • Directorypackages/nx-plugin/src/trpc/procedure
    • schema.json ジェネレーターの入力スキーマ定義
    • schema.d.ts スキーマに対応するTypeScriptインターフェース
    • generator.ts ジェネレーター実行関数
    • generator.spec.ts テストコード
  • Directorydocs/src/content/docs/guides/
    • trpc-procedure.mdx ジェネレーターのドキュメント
  • packages/nx-plugin/generators.json ジェネレーター登録情報

ジェネレーターに必要なプロパティをスキーマに追加します：

{
  "$schema": "https://json-schema.org/schema",
  "$id": "tRPCProcedure",
  "title": "Adds a procedure to a tRPC API",
  "type": "object",
  "properties": {
    "project": {
      "type": "string",
      "description": "tRPC API project",
      "x-prompt": "Select the tRPC API project to add the procedure to",
      "x-dropdown": "projects",
      "x-priority": "important"
    },
    "procedure": {
      "description": "The name of the new procedure",
      "type": "string",
      "x-prompt": "What would you like to call your new procedure?",
      "x-priority": "important",
    },
    "type": {
      "description": "The type of procedure to generate",
      "type": "string",
      "x-prompt": "What type of procedure would you like to generate?",
      "x-priority": "important",
      "default": "query",
      "enum": ["query", "mutation"]
    }
  },
  "required": ["project", "procedure"]
}

packages/nx-plugin/generators.jsonにジェネレーターが登録されています：

 ...
  "generators": {
    ...
    "ts#trpc-api#procedure": {
      "factory": "./src/trpc/procedure/generator",
      "schema": "./src/trpc/procedure/schema.json",
      "description": "Adds a procedure to a tRPC API"
    }
  },
...

ジェネレーターの実装

tRPC APIにプロシージャを追加するには：

  1. 新しいプロシージャ用TypeScriptファイルの作成
  2. ルーターへのプロシージャ登録

プロシージャファイルの作成

generateFilesユーティリティとEJSテンプレートを使用します。テンプレートはpackages/nx-plugin/src/trpc/procedure/files/procedures/__procedureNameKebabCase__.ts.templateに配置：

files/procedures/__procedureNameKebabCase__.ts.template
import { publicProcedure } from '../init.js';
import { z } from 'zod';


export const <%- procedureNameCamelCase %> = publicProcedure
  .input(z.object({
    // TODO: define input
  }))
  .output(z.object({
    // TODO: define output
  }))
  .<%- procedureType %>(async ({ input, ctx }) => {
    // TODO: implement!
    return {};
  });

テンプレートで使用する変数を渡すため、ジェネレーターを更新：

procedure/generator.ts
import {
  generateFiles,
  joinPathFragments,
  readProjectConfiguration,
  Tree,
} from '@nx/devkit';
import { TrpcProcedureSchema } from './schema';
import { formatFilesInSubtree } from '../../utils/format';
import camelCase from 'lodash.camelcase';
import kebabCase from 'lodash.kebabcase';


export const trpcProcedureGenerator = async (
  tree: Tree,
  options: TrpcProcedureSchema,
) => {
  const projectConfig = readProjectConfiguration(tree, options.project);


  const procedureNameCamelCase = camelCase(options.procedure);
  const procedureNameKebabCase = kebabCase(options.procedure);


  generateFiles(
    tree,
    joinPathFragments(__dirname, 'files'),
    projectConfig.sourceRoot,
    {
      procedureNameCamelCase,
      procedureNameKebabCase,
      procedureType: options.type,
    },
  );


  await formatFilesInSubtree(tree);
};


export default trpcProcedureGenerator;

ルーターへのプロシージャ追加

TypeScript AST操作でソースコードを更新：

procedure/generator.ts
import {
  generateFiles,
  joinPathFragments,
  readProjectConfiguration,
  Tree,
} from '@nx/devkit';
import { TrpcProcedureSchema } from './schema';
import { formatFilesInSubtree } from '../../utils/format';
import camelCase from 'lodash.camelcase';
import kebabCase from 'lodash.kebabcase';
import { destructuredImport, replace } from '../../utils/ast';
import { factory, ObjectLiteralExpression } from 'typescript';


export const trpcProcedureGenerator = async (
  tree: Tree,
  options: TrpcProcedureSchema,
) => {
  const projectConfig = readProjectConfiguration(tree, options.project);


  const procedureNameCamelCase = camelCase(options.procedure);
  const procedureNameKebabCase = kebabCase(options.procedure);


  generateFiles(
    tree,
    joinPathFragments(__dirname, 'files'),
    projectConfig.sourceRoot,
    {
      procedureNameCamelCase,
      procedureNameKebabCase,
      procedureType: options.type,
    },
  );


  const routerPath = joinPathFragments(projectConfig.sourceRoot, 'router.ts');


  destructuredImport(
    tree,
    routerPath,
    [procedureNameCamelCase],
    `./procedures/${procedureNameKebabCase}.js`,
  );


  replace(
    tree,
    routerPath,
    'CallExpression[expression.name="router"] > ObjectLiteralExpression',
    (node) =>
      factory.createObjectLiteralExpression([
        ...(node as ObjectLiteralExpression).properties,
        factory.createShorthandPropertyAssignment(procedureNameCamelCase),
      ]),
  );


  await formatFilesInSubtree(tree);
};


export default trpcProcedureGenerator;

ジェネレーターをコンパイル：

Terminal window
pnpm nx run @aws/nx-plugin:compile

ジェネレーターのテスト

テストプロジェクトの作成

新規ワークスペース作成：

Terminal window
npx create-nx-workspace@~20.6.3 trpc-generator-test --pm=pnpm --preset=ts --ci=skip --formatter=prettier

tRPC API生成：

  1. インストール Nx Console VSCode Plugin まだインストールしていない場合
  2. VSCodeでNxコンソールを開く
  3. クリック Generate (UI) "Common Nx Commands"セクションで
  4. 検索 @aws/nx-plugin - ts#trpc-api
  5. 必須パラメータを入力
    • apiName: test-api
  6. クリック Generate

ローカルプラグインのリンク

Terminal window
cd path/to/trpc-generator-test
pnpm link path/to/nx-plugin-for-aws/dist/packages/nx-plugin

ジェネレーターの実行

  1. インストール Nx Console VSCode Plugin まだインストールしていない場合
  2. VSCodeでNxコンソールを開く
  3. クリック Generate (UI) "Common Nx Commands"セクションで
  4. 検索 @aws/nx-plugin - ts#trpc-api#procedure
  5. 必須パラメータを入力
    • クリック Generate

    発展課題

    1. ネストされた操作

    • procedure入力でドット表記をサポート（例：games.query）
    • ネストされたルーターの生成・更新

    2. バリデーション

    • tRPC API以外のプロジェクト選択防止

    3. ユニットテスト

    • テストツリーの作成
    • ファイル生成の検証

    4. E2Eテスト

    • スモークテストの拡張