body method

  1. @override
String body(
  1. String baseName,
  2. String className
)
override

Defines the actual body code. path is passed relative to lib, baseName is the filename, and className is the filename converted to Pascal case.

実際の本体コードを定義します。pathlibからの相対パス、baseNameにファイル名が渡され、classNameにファイル名をパスカルケースに変換した値が渡されます。

Implementation

@override
String body(String baseName, String className) {
  return r"""
## コミット前のチェック作業について。

- コミット前に必ず下記を実施しコードの品質と安全性を保つ。
  1. 下記のコマンドを実施してコードのフォーマットを行う。
      ```bash
      dart fix --apply lib && dart format . && flutter pub run import_sorter:main
      ```

  2. 下記のコマンドを実施してコードのバリデーションを行う。ErrorやWarningがあれば修正して再度実行。ErrorやWarningがなくなるまで繰り返す。
      ```bash
      flutter analyze && dart run custom_lint
      ```

  3. `Page`や`Widget`、`Model`の`toTile`のエクステンションの更新が行われていた場合は、下記のコマンドを実施してゴールデンテスト用の画像を更新する。ErrorやWarningがあれば修正して再度実行。ErrorやWarningがなくなるまで繰り返す。
      - **重要**: このコマンドはDocker使用のため時間がかかります。コミット前に1度だけ実行してください。
      - 開発中のUI確認には`katana code debug [クラス名]`を使用してください(素早く確認できます)。
      - 各種UIが更新されているにも関わらずこのステップが実行されない場合は`katana test run`でエラーになります。

      ```bash
      katana test update [テスト対象のクラス名],[テスト対象のクラス名],...
      ```

      - 出力先: `documents/test/**/*.png`
      - 例:
          ```bash
          katana test update TestPage,TestWidget,TestModel
          ```

  4. 下記のコマンドを実施して全体のテストを行う。ErrorやWarningがあれば修正して再度実行。ErrorやWarningがなくなるまで繰り返す。
      ```bash
      katana test run
      ```

  5. 1〜4のステップでエラーやWarningが発生した場合は、再度1からステップをやり直す。エラーやWarningがなくなるまで繰り返す。
""";
}