Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
目的
コンポーネントを開発時にプレビューする場所がほしい
コンポーネントの振る舞いを共有しやすくしたい
変更の要点
@types/react
との競合について@HikaruEgashira 先輩がコメントしてくださったように@types/reactと競合する問題があります。
現状これに対する根本的な解決策はなくとりあえずの回避策は以下の2つの方向性に絞られます。(参考)
tsconfig の exlude に
*.stories.ts
を指定する素直なやり方ですが
*.stories.ts
に tsconfig が割り当てられず path alias や未使用変数の検知などが行えなくなり不便ですので今回は却下しました。@types/react を削除する
根本的な解決策ではなく
node_modules
以下を操作するのでnode_modules
の変更により通用しなくなる可能性もあります。しかし単純ですし tsconfig を
*.stories.ts
に効かせることができるメリットが大きいのでこちらを採用しました。応急的な処置ではありますが、検索機能強化やタグ機能の開発・レビュー時にいち早く活用したいとも考えているので一旦はこれでいきたいと考えています。
一方で落ち着いたら本格的な解決を模索する必要がありそうです。この Pull Request が Approve されたら、この問題を根本的に解決するための Issue を発行します。
stories.ts
の配置ファイル名でソートしたときに、どのコンポーネントがまだ stories が書かれていないのかがわかりやすいよう、/componets 直下に stories を配置しました。
src 以下に成果物に関係ないものがあることに違和感はあるものの、usecase/test など成果物に関係ないテストなどがが存在することを考えると stories.ts を src 以下に置くことについては一貫性はあるのかなと考えています。
その他
各種変更の方針については人によって意見が違いそうなのでご意見下さい。
fix: #470