Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move the code for section-editor to a separate repository, and basic-editor and section-editor should each be their own repository #148

Closed
hidakatsuya opened this issue Feb 6, 2022 · 1 comment · Fixed by #151

Comments

@hidakatsuya
Copy link
Member

hidakatsuya commented Feb 6, 2022

背景

0.12.0 以前、Thinreports Editor は現在で言うところの basic-editor のみでした。当然、thinreports-editor リポジトリには basic-editor 専用のコードベースのみ存在していました。

その後、section-editor が追加され、Thinreports Editor は二種類のエディタを持つ形となりました。その結果、thinreports-editor リポジトリは basic-editor と section-editor の二つのコードベースをサブディレクトリに持つ、いわゆる monorepo の構成となりました。

この構成にすることは、section-editor が追加されたときの #87 でも言及されていますし、section-editor はこのリポジトリに追加される形での提案であったため、自然な結果だとは思います。

課題

しかし、本格的に section-editor を開発していくにあたり、 Monorepo の利点 を享受できておらず、デメリットの方が強いと感じています。

  1. basic-editor と section-editor は使用するライブラリも異なり、根本的な設計も異なる。モジュールの共有や、lint やテスト、ビルドプロセスの共通化もできない
  2. basic-editor と section-editor は v1.0.0 ではリリースの足並みを揃えるものの、section-editor の方が圧倒的に成熟度が低く、その後は section-editor のみパッチまたはマイナーリリースする頻度が増えることは明らか。その際、同一リポジトリでは basic-editor と section-editor のバージョン番号をわかりやすく管理することが難しいし、そもそも basic-editor と section-editor のバージョニングを同期する必要性もない

提案

  • このリポジトリの名前を thinreports/thinreports-basic-editor に変更し、basic-editor/ 配下のコードのみ配置するようにする
  • 新たに thinreports/thinreports-section-editor リポジトリを作成し、section-editor/ 配下のコードを移動する

つまり、変更後のリポジトリの構成は次のようになる。

  • thinreports/thinreports-basic-editor: Thinreports Basic Editor のリポジトリ
  • thinreports/thinreports-section-editor: Thinreports Section Editor のリポジトリ🆕
@maeda-m
Copy link
Member

maeda-m commented Feb 11, 2022

@hidakatsuya リポジトリ構成の変更提案ありがとうございます。

同意します。
課題解消できそうだと思いました。

@hidakatsuya hidakatsuya pinned this issue Feb 14, 2022
@hidakatsuya hidakatsuya changed the title section-editor のコードを別のリポジトリに移動し、basic-editor と section-editor をそれぞれ単独のリポジトリにしたい basic-editor and section-editor should each be their own repository Feb 14, 2022
@hidakatsuya hidakatsuya changed the title basic-editor and section-editor should each be their own repository Move the code for section-editor to a separate repository, and basic-editor and section-editor should each be their own repository Feb 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants