ナガモト の blog

Full Cycle Developerを目指すエンジニアが有用そうな技術記事や、ポエムのようなよしなしごとを投稿するブログです。

簡単なChrome拡張機能(Extension)のmanifest.jsonの書き方

先日Chrome拡張機能をリリースしました。

chrome.google.com

かなり単純で作成も簡単だったのですが、拡張機能作成において唯一独特なmanifest.jsonについて解説します。今回はわかりやすさのために最小限の構成で解説します。

※実際に作って理解するのもおすすめです。その場合は公式のチュートリアルをおすすめします。

最小限の構成で作れるもの

解説するのは拡張機能のほぼ最小限の機能しか使わない場合のmanifest.jsonです。具体的には下記の通りです。

最小限のmanifest.json

{
  "manifest_version": 2,
  "name": "Tweet Hider",
  "version": "1.0",
  "content_scripts": [
    {
      "matches": [
        "https://twitter.com/*"
      ],
      "js": [ "content-script.js" ]
    }
  ],
  "icons": {
    "128": "images/icon-128x128.png"
  }
}

1つずつ簡単に説明していきます。

manifest_version

manifest.json自身のバージョンですが、現状有効なものは2しかないため、何も考えず2にしてかまいません。

name

拡張機能の名前です。任意の名前をつけましょう。

version

拡張機能のバージョンです。リリースを積み重ねれば上がっていくあれです。

content_scripts

指定URLで自動実行する場合に設定が必要です。ここの設定が拡張機能の動作を決めるため、設定可能な項目は多いです。(今回は最小限の設定のみ)

matches

スクリプトを動作させたいURLをここに記述します。例のように*でまとめて指定することもできます。詳細はMatch Patterns - Google Chromeを参照して書きましょう。

js

動作させるスクリプトを指定します。私はjQueryを使用することが多いので、つぎのように合わせて指定します。

"js": [ "jquery-3.3.1.min.js", "content-script.js" ]

これによって、自作するスクリプトでもjQueryが使用できます。

icons

拡張機能のアイコンを設定します。複数サイズ用意するのがよいですが、とりあえず1サイズだけでも用意しましょう。

最後に

今回はかなりシンプルな拡張機能の前提でmanifest.jsonの解説をしました。実際には多くの設定項目が存在し、混乱してしまうこともあるので、シンプルなものから挑戦し、少しずつ覚えていくといいと思います。