크롬 익스텐션 (크롬 확장 프로그램) 개발 팁 (Manifest.json 파일에 대해)

크롬 익스텐션은 Manifest.json이란 제이슨파일이 정말 중요하다. Manifest.json파일에서 해당 크롬 익스텐션의 옵션들과 환경을 설정해줄 수 있다.

 

그래서 이번엔 크롬 익스텐션을 업로드하고 사용해볼때 정말 중요한 Manifest.json파일에 대해서 알아보았다.

 

일단, 크롬 개발자 지원 사이트에서 개발자들이 맨 처음 크롬 익스텐션을 시작할 때 참고하도록 만든 사이트의 주소이다.

https://developer.chrome.com/docs/extensions/mv3/getstarted/

 

위 사이트에 들어가면, 맨 처음 크롬 익스텐션을 등록하고 사용하는 예제가 등록되어있다.

아래는 해당 사이트에서 참고하면서 만든 Manifest.json파일 예제이다.

 

 

{
  "name": "Getting Started Example",
  "description": "Build an Extension!",
  "version": "1.0",
  "manifest_version": 3,
  "options_page" : "options.html",
  "background": {
    "service_worker": "background.js"
  },
  "permissions": ["storage", "activeTab", "scripting"],
  "action": {
    "default_popup": "popup.html",
	"default_icon": {
      "16": "/images/get_started16.png",
      "32": "/images/get_started32.png",
      "48": "/images/get_started48.png",
      "128": "/images/get_started128.png"
    }
  },
  "icons": {
    "16": "/images/get_started16.png",
    "32": "/images/get_started32.png",
    "48": "/images/get_started48.png",
    "128": "/images/get_started128.png"
  }
}

 

 

그래서, Manifest.json 파일에서 주로 사용하는 옵션들에 대해서 알아보았다.

 

1. manifest_version

패키지에 필요한 매니페스트 파일 형식의 버전을 지정하는 하나의 숫자로 이루어진 정보이다.

 

2. name

해당 옵션은 최대 45자 이내로 작성해야 하며 확장 프로그램의 이름을 나타난다. 여기에서의 이름은 확장 프로그램 관리, 크롬 브라우저의 Toolbox 내 그리고 Chrome 의 웹 스토어에 기재된다. short_name 의 경우, name 보다는 짧은 이름을 정할 때 사용하며, 최대 12자 이내로 작성한다. 해당 필드는 필수값은 아니며, 따로 기재하지 않으면 name 옵션의 이름을 따라 간다. 해당 옵션 같은 경우는 긴 글자의 name 을 노출하기에 공간이 부족한 앱 실행기나 새 탭 페이지 등에서 사용된다. 3. version 해당 필드는 크롬 익스텐션의 버전을 식별하기 위한 1~4개의 점으로 이루어진 정수이다.

 

4. icons

해당 익스텐션의 아이콘을 설정해줄 수 있다. 이미지 파일을 등록하면 해당 이미지가 아이콘이 된다.

 

5. permissions

크롬api를 사용하기 위해 크롬 익스텐션에 해당 필드의 사용 목적에 따른 권한을 입력해주도록 한다.

예를 들어, Storage 페이지는 storage권한을 어떻게 선언하면 되는지 알려준다.

 

6. description

해당 크롬 익스텐션에 대해서 설명하는 필드로, 최대 132자까지 입력이 가능하다.