mdn / mdn/content

Native Messaging documentation can be more explicit about the location of application manifest

Open
#22,534 0 comments 0 reactions 1 assignee Claimed by @rebloor View on GitHub
Content:WebExt help wanted p2
Dominant language
Markdown
Stars
11k
Forks
23.2k
Avg merge
2d 9h
Merged PRs (30d)
331

Description

### MDN URL

https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_messaging

### What specific section or headline is this issue about?

App manifest

### What information was incorrect, unhelpful, or incomplete?

> The app manifest file must be installed along with the native application. The browser reads and validates app manifest files, but it does not install or manage them. The security model for when and how these files are installed and updated is much more like that for native applications than that for extensions using WebExtension APIs.

This section doesn't make it explicitly clear that the app manifest has to be present in a very particular location on the operating system, depending on the operating system. Clicking on the link in the next paragragh

> For details of native app manifest syntax and location, see [Native manifests](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_manifests).

And scrolling all the way down to `Manifest Location` > `Mac OS` is when that detail is revealed which is a bit hidden in my opinion.

### What did you expect to see?

In my case, I had a script that needed to be run and exchange message with the browser, and I spent a lot of time looking for how exactly will the browser read my manifest (or that I was supposed to put it somewhere very specific).

I expected a warning that said "made sure the app manifest is added to the right directory and check if that's the case using the following steps". I discovered it upon clicking the more [Native Manifests](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_manifests), and reading through it.

I guess it was just because I was using native messaging for the first time, but I thought that could be the case with many.

### Do you have any supporting links, references, or citations?

_No response_

### Do you have anything more you want to share?

_No response_

### MDN metadata

Page report details

* Folder: `en-us/mozilla/add-ons/webextensions/native_messaging`
* MDN URL: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_messaging
* GitHub URL: https://github.com/mdn/content/blob/main/files/en-us/mozilla/add-ons/webextensions/native_messaging/index.md
* Last commit: https://github.com/mdn/content/commit/cf500f11973696ed3d20f032cf465a165bdba286
* Document last modified: 2022-10-09T22:09:58.000Z

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.