Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Component groups: allowedComponents by component name, and what an empty list means

クローズ 初心者向け
  • 何か問題がありますか？
#96 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
78/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
nuxt, typescript
領域
documentation

調査の方向性

コンポーネントグループのドキュメントから始め、この issue にある CwaComponentGroup の例を推奨構文の参照として使用してください。CwaComponentNames、allowed-components の3つすべての状態、バリデーションへの影響、保存済みリストがないグループのアップグレード時の動作をドキュメント化してください。記載された各ケースとアップグレードに関する注記をドキュメントが正確にカバーしていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

documentation

Source: components-web-app/cwa-nuxt-module#352 and #351.

What changed

Component names (#352). <CwaComponentGroup :allowed-components> accepts component names as well as collection IRIs:

<CwaComponentGroup reference="main" :location="publishedIri" :allowed-components="[CwaComponentNames.HtmlContent, CwaComponentNames.WatchPastConference]" />
<!-- identical -->
<CwaComponentGroup reference="main" :location="publishedIri" :allowed-components="['HtmlContent', 'WatchPastConference']" />
  • CwaComponentNames (constant) and CwaComponentName (type) are generated from each app/cwa/components/<Name>/<Name>.vue and auto-imported. Editors complete them, and vue-tsc rejects a typo or a removed component.
  • Names are resolved to endpoints at runtime from the API docs. If a name matches no API component, a warning is logged and the group is not synced.
  • Collection IRIs ('/component/html_contents') still work, alone or mixed with names.

Groups with no stored list (#351). Groups created by fixtures or the REST API without a list now receive the template's list on the first signed-in load.

To document

  • Names as the recommended form in the component group docs, with the constant.
  • The three states of the prop:
    • a complete list — must name every type already placed in the group, plus any #[ExplicitAllowOnly] type to offer. A placed type missing from the list fails validation on its next save.
    • omitted — leaves the stored list as it is.
    • null or [] — unrestricted (explicit-only types stay hidden).
  • Upgrade note: groups that never had a list will be PATCHed with the template's list on the first admin load, so check the lists are complete first.
主要言語
Vue
スター
0
フォーク
0
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

components-web-app/docs のほかの issue

components-web-app/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。