Skip to content
This repository has been archived by the owner on Jun 4, 2024. It is now read-only.

【タスク】scaffdog導入 #18

Open
shinGangan opened this issue Aug 19, 2023 · 0 comments
Open

【タスク】scaffdog導入 #18

shinGangan opened this issue Aug 19, 2023 · 0 comments
Assignees
Labels
🏰 design / consider desgin, conside, built environment 🏕️Priority: low High priority
Milestone

Comments

@shinGangan
Copy link
Owner

内容

  • scaffdogを導入し以下のテンプレートを自動生成できるようにする

    • /components/xxx.vue
    • /components/xxx.story.vue
    • /composables/xxx.vue
    • /stores/xxx.vue
  • Unitテストは同一ファイル中に実装する( #4: Build Vitest environment for Testing #7 のPR参照)

検討

以下は検討中の要件である

  • componentの階層粒度
    • ファイル数増大を考慮し、フォルダを1つ挟んだ方が良いと考えている。ただ、どのような命名にするかは検討する必要がある。
  • schemaファイルをどこに配置するのか
    • components 内 vs schemaフォルダ内

検討理由

コンポーネントの分割粒度、実装方針は人によって持っている指針が異なる。そのため、ルールがないとブレる事が多い。実装方針・アーキテクチャを明確化・明文化していないと保守コストが増大する恐れもある。

上記問題が起こらないようにscaffdogを用いたテンプレートの作成を行う。Railsに存在するrails generate scaffoldコマンドを自作するイメージである。

利用フローは以下のようになる。

  1. scaffdog generate xxxで新規component / composabels / stores を作成する
  2. テンプレートの質問に回答し命名などを行う
  3. 生成されたファイルを元に実装する
@shinGangan shinGangan added 🏰 design / consider desgin, conside, built environment 🏕️Priority: low High priority labels Aug 19, 2023
@shinGangan shinGangan added this to the 0.1.0 milestone Aug 19, 2023
@shinGangan shinGangan self-assigned this Aug 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🏰 design / consider desgin, conside, built environment 🏕️Priority: low High priority
Projects
None yet
Development

No branches or pull requests

1 participant