BUILD SOMETHING USEFUL
小さな工夫を、みんなの便利に。
WSIプラグインをつくって、コミュニティに届けるためのガイド。
01 / CREATE
プラグインをつくる
開発環境でひな形を用意し、JavaScriptやCSSで対象サイトの使い心地を改善します。
02 / PACKAGE
確認して、ZIPにまとめる
plugin.json に対象サイトと権限を記載。動作を確認したら、配布用ZIPを作成します。
03 / PUBLISH
アップロードして公開申請
ZIPと掲載情報を登録し、公開を申請。運営の確認後に掲載されます。
このプロジェクトでZIPを作成する
既存のプラグイン開発環境をセットアップした状態で実行する例です。
npm run create -- my-site-enhancer --name "My Site Enhancer" cd plugins/my-site-enhancer npm run validate npm run build npm run pack
配布用ZIPはプラグインの dist フォルダに生成されます。更新版を公開するときは、 plugin.json の version を上げてください。
Hubが受け付けるZIPの条件
- 20MB 以下で、空ではないこと
- ルートに
plugin.jsonが1つだけあること (フォルダごと圧縮した場合は、中身だけを圧縮し直してください) formatVersion: 2が明示されていること。省略と形式 v1 は受け付けません- プラグインIDが
^[a-z0-9]+(-[a-z0-9]+)*$に一致すること。 大文字・先頭末尾のハイフン・連続ハイフンは使えません - 参照するファイル(
scripts.main/ styles / background / pages)が すべて含まれていること - 相対パスのみ。
..・絶対パス・ドライブ文字・バックスラッシュ・ シンボリックリンクは使えません - 暗号化されたZIP、重複パス、CRC不一致は受け付けません
旧形式・大文字IDのプラグインは、plugin.json を修正して再パッケージしてから 投稿してください。Hub側でIDの小文字変換やZIP内部の書き換えは行いません。
外部更新(updateUrl)と外部設定(policy)
updateUrl付きのZIPを受け付けます。ただし外部経由の更新はHubの審査対象外で、掲載ページにその旨を表示します。 Hubは外部更新先を巡回・取得・代理配布しません。policy付きのZIPも受け付けます。申請時に用途と挙動への影響を 説明していただき、運営が確認します。掲載ページには外部設定の利用・取得先・用途を表示します。
審査について
- 新規・更新とも、Hubで配布するには運営の審査が必要です
- 更新の審査中は、承認済みの旧版を配布し続けます
- 差し戻された場合は、同じ申請のまま修正して再申請できます
- 公開済みの同じバージョンでZIPを差し替えることはできません
- 提出されたコードを運営が実行することはありません。内容の確認は ソース表示・ファイルツリー・ハッシュ・前版との差分で行います
掲載情報で伝えてほしいこと
- どんな機能があり、どのサイトで動作するか
- 対応するWSIの環境と、動作確認したバージョン
- 必要な権限、その用途、配布ライセンス
- 更新内容と、不具合の問い合わせ先
導入手順(利用者向け)
- 掲載ページからZIPをダウンロードします
- WSI側のプラグイン管理画面から手動で取り込みます
- 対象サイトと権限を確認して有効にします
Hubからの直接インストール連携は行っていません。
プラグインを投稿する