こんにちは!フロントエンドエンジニアのyoshidaです!
テンプレートからのファイルの自動生成ができるscaffdogというパッケージの存在を知り、ちょうどよく解決できそうな課題を見つけたので、使ってみました。

はじめに

普段の開発時、以下の一連の流れが面倒だと課題に感じていました。

  1. ロジックファイルを作成
  2. ロジックファイル内の共通処理(ファイルと同名の関数のexportなど)を書く
  3. ロジックファイルに対応するテストファイルの作成
  4. テストファイル内の共通処理を書く

 

また、「ロジックを書いたらテストも書く」という意識を強めるために何か良い方法はないかと考えていました。

そこで、「ロジックファイルとテストファイルをテンプレートから自動生成する」というアプローチで上記の課題の解決を試みました。

対象読者

  • 似た構成のファイルを何度も手動で作成している人
  • テストを書く意識を強制的に強めたい人

scaffdogとは

scaffdogとは、markdownファイルで設定を元に、ファイルを自動生成することができるパッケージです。

設定次第で、プロンプト入力を元にファイル名の指定や条件分岐など、柔軟なファイル生成を行うことができます。

似たようなパッケージにHygenもあるので、ご興味がある方はこちらも試してみてください。

 

scaffdogを実際に使ってみる

基本的な使い方

まずは公式ドキュメントに従ってセットアップを行います。

プロンプトに従ってファイル名を入力すると、設定ファイルとexample用のテンプレートファイルが生成されます。

scaffdogの初期コマンド

 

generateコマンドを実行し、

  • 使用するテンプレート
  • 出力先
  • テンプレートで設定されているquestions

に答えていくと、それに従って雛形ファイルが生成されます。

 

scaffdogでファイル生成した際のコマンド

 

これで、exampleのテンプレートから、ファイルを生成することができました????

 

プロンプトは、テンプレートファイルのquestionsで設定することができます。

以下の入力形式を受け取ることが可能です。

(参考:https://scaff.dog/docs/templates/attributes#questions

  • text
  • boolean
  • choice
  • array

 

ロジックファイルとテストファイルを生成するテンプレートを作成

それでは、ロジックファイルとテストファイルを同時に作成してくれるテンプレートを作成していきます。

.scaffdog/templateに、createLogicWithSpec.md という名前でmarkdownファイルを作成します。

 

上記のテンプレートを作成し、generateコマンド実行します。

プロンプトに従い、使用するテンプレート・出力先・ファイル名を入力し実行が完了すると、以下の2ファイルが生成されていることを確認できます????

(例としてファイル名はcustomLogicとして生成しています)

 

 

まとめ

テンプレートから自動生成することで、何度も同じファイルを生成したり、同じようなimport文を手動で書く手間がなくなるので、おすすめです。

また、ロジックファイルを作れば、テストファイルも自動で作成されるようになる為、「テストを書かなくては」という意識も強めてくれる点も良かったかなと思います。

今後もテンプレート的な処理は自動化し、時間をかけるべきところに集中できるような環境を作り、生産性を高めていけたらと思います!

最後までお読み頂いてありがとうございました!

 

ソニックムーブは一緒に働くメンバーを募集しています

Wantedlyには具体的な業務内容のほかメンバーインタビューも掲載しております。ぜひご覧ください。

あわせて読みたい記事