latteart-ui-migration-gen

latteart-repositoryのREST APIに変更(※1)があった場合に、latteart-repositoryと通信(※2)しているクライアントコードに変更が必要な箇所の通知・自動修正するESLintPluginを生成するツールです。

※1: requestBodyの変更のみ対応しています。

※2: latteart-clientのRESTClientImpl経由で通信している必要があります。

セットアップ

1. lateart-ui-migration-genディレクトリ直下で以下コマンドを実行し、依存ライブラリをダウンロードしてください。

   $ npm install

2. latteart-ui-migration-genはAPIの差分抽出にoasdiffを使用しています。「oasdiffのGitHubページ 」のReleasesからダウンロード後、任意のフォルダ配下に配置し、oasdiffの実行ファイルのあるディレクトリにパスを通してください。

3. lateart-ui-migration-genディレクトリ直下で以下コマンドを実行し、ツールをビルドしてください。

   $ npm run build

利用方法

1. ツールのビルド後、lateart-ui-migration-genディレクトリ直下で以下コマンドを実行してください。

   ⚠️ OpenAPISpecファイルパスは古いバージョンから順番に指定してください。

   $ npm run run ＜OpenAPISpecファイルパス＞ ＜OpenAPISpecファイルパス＞ ...

   カレントディレクトリにoutputディレクトリが生成され、配下にESLintプラグイン一式(eslint-plugin-latteart-ui-migration)のディレクトリが生成されます。

2. ESLintプラグインを適用するプロジェクトのeslint.config.jsと同階層にeslint-plugin-latteart-ui-migrationディレクトリをコピーしてください。

3. eslint.config.jsに以下を追記してください。

   // ...省略...
   
   import latteartUiMigration from "./eslint-plugin-latteart-ui-migration/index.js";
   
   export default [
     // ... 省略 ...
     {
       plugins: { "latteart-ui-migration": latteartUiMigration },
       rules: {
         "latteart-ui-migration/migration-rule": "error",
         // ... 省略 ...
       },
     },
   ];

4. ESLintを実行すると、追加されたルールに従ってチェックされます。

開発用コマンド

# テストの実行
$ npm run test

# ソースコードのビルド
$ npm run build

# ソースコードの変更検知、再ビルド
$ npm run watch

# ビルド済スクリプトの実行
$ npm run run ＜OpenAPISpecファイルパス＞ ＜OpenAPISpecファイルパス＞ ...