Chrome Extension 開發入門篇 05 - Chrome Extension 設定檔

每一個 Chrome Extension 都會有一個 JSON 格式的設定檔(manifest.json)，裡面會定義這個 Extension 的名稱、版本、類型、權限等等。

接下來，將以官方的文件來說明。

必要的設定

manifest 裡至少要設定這三項，如下。

manifest.json

{
  "manifest_version": 2,
  "name": "您的 Extension 名稱",
  "version": "您的 Extension 版本"
}

name 和 version 應該沒什麼疑問，但 manifest_version 是什麼勒？其實以前是沒有這一項的，是因為 Chrome Extension 有一次大改版，加強了很多安全性上的問題，那為了要區別兩個版本，所以就加上了 manifest_version。注意！現在只允許 2 的版本。

建議的設定

官方建議要設定這三項，如下。

manifest.json

{
  "default_locale": "en",
  "description": "簡短描述你的專案",
  "icons": {
    "16": "icon16.png",
    "48": "icon48.png",
    "128": "icon128.png"
  },
}

但是，如果沒有要做多國語言的話，就不要設定 default_locale (整行拿掉，不是設為空字串)，因為您的專案資料夾下必須有這個檔案 (您的專案/_locales/en/messages.json) 才能設定，而 default_locale 只是設定預設使用哪個語言。

description 不能超過 132 個字元，如果您需要更多的文字說明，在發佈到線上應用程式商店時可以設定。

icons 有三種大小，分別是 16x16, 48x48, 128x128，如果沒有設定的話就會是預設圖。

顯示類型的設定

Extension 有三種顯示的類型，browser_action 是顯示在瀏覽器右上角，page_action 是顯示在網址列裡面的右側，這兩種都可設定圖示、標題、彈出頁面，只是顯示位置不同。如果您的 Extension 只有在少部分的網站需要執行，就選擇 page_action，經常需要用到的就選擇 browser_action。如果您不需要彈出頁面和按鈕，那這兩項都不要設定，就會是隱藏的狀態。

manifest.json

{
  "browser_action": {...},
  "page_action": {...},
}

注意！ browser_action 和 page_action 只能選擇一個來設定，或者都不設定。

可選的設定

除了上面提到的設定以外，還有很多項目可以自行選擇要不要設定，這邊就不一一細講，在官網和中文版裡的項目都可以點選進去看更詳細的內容。

結語：

希望您看完這篇後，對 Chrome Extension 的設定檔有基本的了解。如果您有問題，歡迎在下方留言。謝謝！