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

Decide the pack catalog distribution model and implement it

オープン
#52 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
typescript
領域
full-stack

調査の方向性

Start by reading docs/adr/0006-offline-first-pwa-on-github-pages.md and docs/architecture.md, section 9, to understand the existing constraints and pack sources. Then inspect packages/cli/src/commands/build.ts, apps/web/src/logic/catalog.ts, and apps/web/src/services/packs.ts. Done means the distribution decision is recorded in an accepted ADR, catalog validation and CI checks are documented and implemented, catalog packs work offline through the listed player flows, the end-to-end test verifies no cross-origin requests, and the offline file stays within the ADR’s budget.

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

説明

area: content area: infra area: web priority: medium type: decision

Context

Packs are bundled into the player at build time (the lexvm-catalog/1 index.json from lexvm build) or imported from files. As community packs grow, bundling everything into the PWA and into lexvm-offline.html stops scaling, and players need a way to discover packs. At the v0.1 pull request, with two packs, lexvm-offline.html is 660 KB (209 KB gzip), and the noir pack alone is a 100 KB .lexpack.json. Constraints: no server, no accounts, no tracking, no network requests beyond the player's own files (ADR 0006), offline-first, and no pack enters the catalog without passing lexvm check.

Options

  • A. Status quo: every pack in this repository is bundled. Simple, but the offline file and the precache grow with every pack.
  • B. Same-origin catalog on GitHub Pages: all packs stay in this repository; the catalog lists them; only featured packs are bundled and precached; the others are downloaded on demand from the same origin and stored on the device.
  • C. A separate registry repository with its own Pages site. The player would fetch a cross-origin index, which needs an amendment to ADR 0006 and a content security policy for it.
  • D. GitHub Releases as the distribution channel. Cross-origin, with CORS and rate-limit issues.

Proposed: B.

Scope

  • ADR for the chosen model.
  • Catalog format (a new version if needed): id, version, hash, language, estimated length, license, author, size, content notes; generated and validated in CI.
  • Library: a "More adventures" section with download, size, update notice when the hash changes (using the existing replay flow) and delete.
  • lexvm-offline.html contains only the featured packs.

Acceptance criteria

  • The ADR is accepted.
  • The catalog format is documented, and CI fails if a listed pack does not pass lexvm check.
  • The player lists, downloads, stores, updates and deletes catalog packs, and downloaded packs play offline.
  • An end-to-end test asserts that no cross-origin request is made.
  • The size of lexvm-offline.html stays within a budget recorded in the ADR.

References

  • packages/cli/src/commands/build.ts
  • apps/web/src/logic/catalog.ts
  • apps/web/src/services/packs.ts
  • docs/adr/0006-offline-first-pwa-on-github-pages.md
  • docs/architecture.md (section 9, Pack sources)
主要言語
TypeScript
スター
0
フォーク
0
平均マージ
28分
マージ済み PR(30日)
2

環境構築

はじめの一歩

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

nullthrone/lexvm のほかの issue

nullthrone/lexvm の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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