Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mellowtel.com/llms.txt

Use this file to discover all available pages before exploring further.

このガイドでは、WebpackやViteのようなバンドラーを使用せずに、Mellowtelをブラウザ拡張機能に統合する方法を説明します。その代わりに、コンテンツスクリプトとサービスワーカーの両方で動作する単一の事前バンドルファイルを使用します。

プロジェクトセットアップ

基本的なブラウザ拡張機能の構造から始めます:
your-extension/
├── icons/
├── popup/
│   ├── popup.html
│   └── popup.js
├── background.js           # あなたのサービスワーカー
├── content_script.js
├── manifest.json
└── mellowtel.js           # 次のステップで追加されます

Mellowtelバンドルの取得

拡張機能用のmellowtel.jsファイルを取得するには、2つのオプションがあります:

オプション1: 事前バンドルファイルを使用

最も簡単に始める方法は、mellowtel-bundledリポジトリから事前バンドルされたmellowtel.jsファイルを使用することです。
  1. mellowtel-bundledリポジトリにアクセス
  2. mellowtel.jsファイルをダウンロード
  3. それを拡張機能ディレクトリにコピー

オプション2: 自分でバンドルを生成

自分でバンドルを生成したい場合は、次の手順に従ってください:

一時的なバンドリングディレクトリを作成

Mellowtelをインストールし、バンドルを生成するための一時ディレクトリを作成します:
mkdir mellowtel-bundling
cd mellowtel-bundling
npm init -y
npm install mellowtel
これにより、バンドリングのみに使用するMellowtelパッケージを含む別のフォルダが作成されます。

esbuildでMellowtelをバンドル

mellowtel-bundlingディレクトリ内から、サービスワーカーとコンテンツスクリプトの両方で動作する単一のバンドルを作成します:
npx esbuild node_modules/mellowtel/dist/index.js --bundle --format=iife --global-name=Mellowtel --footer:js="globalThis.Mellowtel = Mellowtel.default" --platform=browser --outfile=mellowtel.js --minify --legal-comments=none
このコマンドは:
  • node_modules/mellowtel/dist/index.jsからMellowtelのソースを取得
  • すべての依存関係を単一ファイルにバンドル
  • IIFE形式を使用して、普遍的な互換性を持たせるためのグローバル名を使用
  • デフォルトエクスポートをグローバルに利用可能にするフッターを追加
  • ブラウザ環境向けに最適化し、出力を最小化
  • バンドリングディレクトリにmellowtel.jsを作成

バンドルを拡張機能にコピー

esbuildコマンドを実行した後、生成されたファイルを拡張機能ディレクトリにコピーします:
cp mellowtel.js ../your-extension/
出力ファイルのみが必要なので、一時バンドリングディレクトリを削除できます:
cd ..
rm -rf mellowtel-bundling
これで、拡張機能フォルダには使用準備が整ったMellowtelのバンドルファイルが含まれています。

マニフェストの設定(どちらのオプションでも)

上記のどちらのオプションを選んだ場合でも、manifest.jsonを設定してコンテンツスクリプトにMellowtelバンドルを含めます:
{
  "manifest_version": 3,
  "name": "Your Extension Name",
  "version": "1.0",
  "background": {
    "service_worker": "background.js",
    "type": "module"
  },
  "content_scripts": [
    {
      "matches": ["<all_urls>"],
      "js": ["mellowtel.js", "content_script.js"]
    }
  ],
  "permissions": [
    "storage",
    "declarativeNetRequestWithHostAccess"
  ],
  "host_permissions": [
    "\u003Call_urls\u003E"
  ]
}
重要:
  • "type": "module"フィールドは、サービスワーカーでのESモジュールインポートを有効にします。
  • コンテンツスクリプトの配列では、mellowtel.jscontent_script.jsより前にロードされる必要があります。これにより、コンテンツスクリプトが実行されるときにMellowtelのグローバル変数が利用可能になります。

拡張機能でMellowtelを使用する

サービスワーカー(background.js)では、バンドルファイルをインポートします:
// background.js
import './mellowtel.js';

(async () => {
    const mellowtel = new Mellowtel("<configuration_key>"); // あなたの設定キーに置き換えてください
    await mellowtel.initBackground();
})();
コンテンツスクリプトでは、Mellowtelはグローバル変数として利用可能です(インポートは不要、マニフェスト経由でロードされるため):
// content_script.js
// Mellowtelはmellowtel.jsからのグローバル変数として利用可能です

(async () => {
  const mellowtel = new Mellowtel("<configuration_key>"); // あなたの設定キーに置き換えてください
  await mellowtel.initContentScript();
})();

拡張機能のテスト

拡張機能をテストするには:
  1. Chromeでchrome://extensions/にアクセス(他のブラウザでも同様)
  2. 「デベロッパーモード」を有効にする
  3. 「パッケージ化されていない拡張機能を読み込む」をクリックし、拡張機能フォルダを選択
このアプローチにより、WebpackやViteのようなフルビルドシステムを設定する複雑さなしに、Mellowtelを使用する利点を得ることができます。