openapi generator cliのbatchコマンドでFILESにopenapi-generator-ignoreが出現する原因を探る

[kenjiyoshid-a]

概要

フロントエンドのopenapi generator cli のbatchコマンドで意図せぬ挙動を示しているため、原因を探りたい。

詳細 / 機能詳細（オプション）

起きている挙動は以下の通り。

• generatedフォルダを削除してから、npm run generate-clientを走らせる→FILESに.openapi-generator-ignoreあり
• generatedフォルダがある状態で、npm run generate-clientを走らせる→FILESに.openapi-generator-ignoreなし

※generatedフォルダはopenapi generator cliの自動生成コード格納用フォルダ
※npm run generate-clientはpackage.json内で以下のように定義されており、batchコマンドを呼んでいる。

"generate-client": "openapi-generator-cli batch ./openapisettings.json --clean"

完了条件

• 詳細に記述した挙動の原因が判明している
• 修正が必要な場合、openapi generator cliの設定ファイルやpackage.jsonに反映されている

[kenjiyoshid-a]

挙動の調査結果

.openapi-generator-ignoreだけ1回消して再度生成すると
.openapi-generator-ignoreが出現してFILESにも名称が入るので、
.openapi-generator-ignoreが存在しないときは新規で作る、（作ったのでFILESに書く）
存在しない場合は作らない（作らなかったのでFILESに書かない）という挙動をしていそうです。

どちらのケースでもgenerater側がignoreファイルをいじくって悪さすることはなかったので、問題はなさそうです。
・.openapi-generator-ignoreを使っているケース
⇒上書き（再作成）しないので、除外設定が保たれる
・.openapi-generator-ignoreを使っていないケース
⇒何もしないので影響なし

また、こういう感じのログが出るのでジェネレーター側で勝手にクリーンするとまずいファイルはいい感じにクリーンをスキップする仕様になっていそうです。

[pool-1-thread-1] Generator typescript-axios skip cleaning special filename .gitignore…
[pool-1-thread-1] Generator typescript-axios skip cleaning special filename .npmignore…