Skip to content

chore(scaffold): remove unused sample components and templates#898

Open
teppei-d wants to merge 5 commits into
d-zero-dev:devfrom
teppei-d:chore/scaffold-remove-sample-components
Open

chore(scaffold): remove unused sample components and templates#898
teppei-d wants to merge 5 commits into
d-zero-dev:devfrom
teppei-d:chore/scaffold-remove-sample-components

Conversation

@teppei-d
Copy link
Copy Markdown
Collaborator

closes #878

削除内容

コンポーネント

ファイル 理由
c-nav-global.pug / .css 使用頻度低い
c-nav-sitemap.pug / .css ほぼ使われない
c-card.pug / .css / c-card-list.css 210_blog_index 専用
c-media.pug / .css / c-media-list.css 200_blog_index 専用
c-content-index.css 200/210 専用

テンプレート

ファイル 理由
200_blog_index.pug / .json ブログ一覧(使用頻度低い)
210_blog_index.pug / .json ブログ一覧カード(使用頻度低い)
htdocs/sample/index.html 教義的なサンプルファイル

付随修正

  • layouts/home.pug / sub.pugc-nav-global / c-nav-sitemap の include と wrapper div を削除
  • c-page-home.css / c-page-sub.css — 削除コンポーネントに対応する grid-area・セレクタを削除
  • htdocs/css/style.css — 削除コンポーネントの @import を除去
  • __tmpl/index.pug — 削除テンプレートに対応するコメント行を削除

残したもの

  • c-header / c-footer / c-nav-breadcrumb / c-title-page / c-pagination
  • c-content-main(baser 案件で必須)
  • 000_home / 100_sub / 300〜302 フォームテンプレート

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown
Collaborator

@arktds arktds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@teppei-d
ありがとうございます!
ひとまず次のファイルも削除をお願いします!

  • packages/@d-zero/scaffold/__assets/_libs/data/data.yml
    • 削除した 200_blog_index.pug / 210_blog_index.pug だけで使用されていた。
  • packages/@d-zero/scaffold/__assets/_libs/img/bg-repeat-01.gif
    • 元からどこからも参照されていない画像
    • /packages/@d-zero/create-frontend/snapshots/index.spec.js.snap から該当行の削除もお願いします!
  • packages/@d-zero/scaffold/__assets/_libs/component/c-page-sub.css 内の .c-page-sub__content-main のスタイル
    • 元から未使用だったコード

@arktds
Copy link
Copy Markdown
Collaborator

arktds commented May 21, 2026

@teppei-d

  • packages/@d-zero/scaffold/__assets/_libs/component/c-page-sub.css 内の .c-page-sub__content-main のスタイル
    • 元から未使用だったコード

とコメントしましたが、sub.pug 側が c-page-sub__content-body で、CSS 側が c-page-sub__content-main でクラス名の不一致が問題のようです。
参考までに home.pug とその CSS は c-page-home__main なので、sub.pug とその CSS も c-page-sub__main が良さそうと思ったのですが、home.pug と sub.pug で main 要素の位置だったり、全体的な構造が結構異なっているので、悩みます。

とりあえず .c-page-sub__content-main のスタイルの削除は保留でお願いします!

@teppei-d
Copy link
Copy Markdown
Collaborator Author

@arktds
ご確認ありがとうございます!以下の修正対応しております。

packages/@d-zero/scaffold/__assets/_libs/data/data.yml
削除した 200_blog_index.pug / 210_blog_index.pug だけで使用されていた。
packages/@d-zero/scaffold/__assets/_libs/img/bg-repeat-01.gif
元からどこからも参照されていない画像
/packages/@d-zero/create-frontend/snapshots/index.spec.js.snap から該当行の削除もお願いします!

@arktds
Copy link
Copy Markdown
Collaborator

arktds commented May 21, 2026

参考までに home.pug とその CSS は c-page-home__main なので、sub.pug とその CSS も c-page-sub__main が良さそうと思ったのですが、home.pug と sub.pug で main 要素の位置だったり、全体的な構造が結構異なっているので、悩みます。

に関して、さらに訂正です。

次の関連性は合致していました!

  • home.pug の .c-page-home__main とその直下の main 要素
  • sub.pug の.c-page-sub__main とその直下の main 要素

home.pug

.c-page-home__main
	main !{ content }

sub.pug

.c-page-sub__main
	main

やはり問題は単に sup.pug のコンテンツの親要素のクラス名の不一致だけでした。
.c-page-sub__content-body.c-page-sub__content-main

			.c-page-sub__main
				main
					article.c-page-sub__content
						// ...
						.c-page-sub__content-body !{ content }

どちらか、または、より良い名前に変更が良さそうですね。

@teppei-d
Copy link
Copy Markdown
Collaborator Author

@arktds
調査ありがとうございます。

個人的には以下の理由から .c-page-sub__content-body に合わせるのが良いと思いますがいかがでしょうか?(髙田は命名に特に希望あるわけでないです。)

  • __content-main は「content の中の main 要素」と紛らわしい(main 要素は上位の .c-page-sub__main に対応している)
  • __content-body の方が「コンテンツ本文エリア」として意味が明確

contentもbodyも似たような意味でつかわれ同義語の重複のような気もするので、__content-inner__content-containerでもいいのかなとも思います👀

@arktds
Copy link
Copy Markdown
Collaborator

arktds commented May 21, 2026

@teppei-d
そうですね、どちらかと言えば c-page-sub__content-body の方が良さそうですね!それか、他のより良い名前か。
このプルリクから外れそうなので、別でイシュー立ててそちらで進めます!

他にもページネーションのロジックや関連コードが必要なのか、不要カスタムプロパティがありそうなど思いついたのですが、これらも別で進行します!

LGTMです👍

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ここのグローバルデータを使っていたサンプルテンプレートが無くなったので不要なのはわかるのですが、完全に削除してしまうとYAMLファイルでグローバルデータを置けること自体がこのscaffoldを見るだけではわからなくなってしまうと思うので、意見がほしいです。

kamadoの機能なので、そちらのドキュメント等に任せるで済む話かもしれませんが。

Copy link
Copy Markdown
Collaborator Author

@teppei-d teppei-d May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arktds @yusasa16 @dz-furukawa @YusukeHirao
もちろん佐藤さんの懸念も理解できるのですが、サンプルコードをドキュメント代わりにするのは好ましくないかなというお気持ちです。

  • scaffoldはプロジェクトの初期ファイルであってチュートリアルではない
  • 「使い方を示すためだけに残す」ファイルは、実プロジェクトでそのまま放置されるリスクがある(このプルリク自体の理由でもある)
  • kamadoの機能はkamadoのドキュメントで説明すべきで、scaffoldに依存するのは責務の分離として良くないのでは?

もし「機能の存在を伝えたい」なら、data.yml を残すよりも README やkamadoのドキュメントに一行追記する方が親切かなと考えてます!

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

__assets/_libs/data/data.yml を残したとしても、__assets/_libs/data/ 内のファイルがグローバルデータとして置かれていることが認知されていなさそう・認知されにくいと思います。
もちろんあるほうがないほうより認知はされるきっかけにはなりますが。
そして、それをより認知させるのは kamado のお仕事かなと思います!

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 this pull request may close these issues.

scaffold から不要なサンプルコンポーネントを削除する

3 participants