parcel-bundler/parcel

webextension: add support for `options_page` key

Open

#10,076 opened on 2025年1月22日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)JavaScript (44,030 stars) (2,274 forks)batch import
Good First Issue

説明

🙋 feature request

Chrome supports two keys to specify the options page:

  • options_ui
  • options_page

MDN reports that options_page is deprecated and so does Parcel's schema:

https://github.com/parcel-bundler/parcel/blob/53633df12ad9bba5d6ed5360e935fde8de0342fe/packages/transformers/webextension/src/schema.js#L289

However that doesn't reflect reality, Chrome does not deem the key deprecated in their docs and even Firefox eventually added support for it: https://bugzilla.mozilla.org/show_bug.cgi?id=1816960

You can find further reasoning in the bugzilla.

🤔 Expected Behavior

options_page should be equivalent to options_ui.page

😯 Current Behavior

The key is ignored and the specified options.html is not processed.

💻 manifest.json demo

{
	"$schema": "https://json.schemastore.org/chrome-manifest",
	"name": "options_page minimal extension",
	"version": "0.0.0",
	"manifest_version": 3,
	"options_page": "options.html"
}

コントリビューターガイド

技術スタック
javascript
領域
build system
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Web extensions manifestParcel transformer internals
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75
調査方針
Start by examining the schema file at `packages/transformers/webextension/src/schema.js`, particularly the handling of `options ui`. The fix should alias `options page` to `options ui.page` in the transformer's manifest validation and processing logic. Check existing tests and add a test case for the `options page` key. Look for any references to `options page` in the codebase to ensure consistent handling.