Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prsprsbk/ffext-manifest-schema
JSON Schema for manifest.json of Firefox WebExtensions.
https://github.com/prsprsbk/ffext-manifest-schema
firefox json-schema webextensions
Last synced: about 1 month ago
JSON representation
JSON Schema for manifest.json of Firefox WebExtensions.
- Host: GitHub
- URL: https://github.com/prsprsbk/ffext-manifest-schema
- Owner: PrsPrsBK
- Created: 2019-04-02T03:06:38.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-27T13:50:50.000Z (over 3 years ago)
- Last Synced: 2024-11-18T19:46:59.334Z (about 1 month ago)
- Topics: firefox, json-schema, webextensions
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/ffext-manifest-schema
- Size: 314 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE/LICENSE_Chromium
Awesome Lists containing this project
README
* JSON Schema for Firefox WebExtensions.
* for ones who want to catch up new versions. npm package is based on nightly (mozilla-central).
* I do not think that this package is useful for Google Chrome's manifest.json,
so this package is prefixed as 'firefox'.
* status: raughly O.K.
## how to use
As for VS Code's workspace config, such as `foo.code-workspace`
```
{
"settings": {
"json.schemas": [
{
"fileMatch": ["*/path/to/manifest.json"],
"url": "./path/to/ffext.min.json",
}
]
}
}
```
Then you will get:
## how to make JSON Schema file
```console
$ npm run build -- --mozilla-repo /path/to/mozilla
```
# Known Issue
## `//` comment
One-line comment is allowed (only Firefox?), but I can not specify it in the JSON Scheme.
## `default_locale`
For `default_locale`, to be mandatory or prohibited is conditional.
Its condition cannot be described in this JSON Schema, because it involves the existence of `_locales` directory.
## Warning "Matches multiple schemas when only one must validate"
VS Code's validator does not discriminate objects inside `oneOf`
and result in that warning on `background` or so.
```sample.json
{
"two different subschema cannot be discriminated."
"background": {
"oneOf": [
{
"type": "object",
"properties": {
"page": {
"type": "number"
}
}
},
{
"type": "object",
"properties": {
"scripts": {
"type": "array",
"items": {
"$ref": "#/definitions/ExtensionURL"
}
},
"persistent": {
"$ref": "#/definitions/PersistentBackgroundProperty"
}
}
}
]
}
}
```
c.f. [Combining schemas — Understanding JSON Schema 7.0 documentation](https://json-schema.org/understanding-json-schema/reference/combining.html)
## `format` may result in error or warning
JSON Schema Document says "JSON Schema implementations are not required to implement this part of the specification, and many of them do not".
As for VS Code, validator seems to do nothing for `format`.
So, this schema currently does nothing for it, and non-standard `format`
such as `strictRelativeUrl` remains in.
c.f. [string — Understanding JSON Schema 7.0 documentation](https://json-schema.org/understanding-json-schema/reference/string.html)
## Note for implementation
### `$id` does not work
JSON Schema Document says "This functionality isn’t currently supported by the Python jsonschema library".
I do not know about VS Code's JSON Schema Validator, but anyway it does not handle `$id`.
c.f. [Structuring a complex schema — Understanding JSON Schema 7.0 documentation](https://json-schema.org/understanding-json-schema/structuring.html)
### 'match mode (?i)' of RegExp
For the case of `string` type, it can have `pattern` keyword.
JSON Schema does not handle it, and that results in RegExp error.
# Reference
some useful staff.
* [manifest.json - Mozilla | MDN](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json)
* [pkcs11 - Mozilla | MDN](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/pkcs11)
* [API Implementation Basics — Mozilla Source Tree Docs 68.0a1 documentation](https://firefox-source-docs.mozilla.org/toolkit/components/extensions/webextensions/basics.html#webextensions-experiments)
For `experiments`.
* [API Schemas — Mozilla Source Tree Docs 68.0a1 documentation](https://firefox-source-docs.mozilla.org/toolkit/components/extensions/webextensions/schema.html)
This says "Refer to the documentation and examples at the JSON Schema site for details on how these items are defined in a schema".
But some items in API schema (e.g. `choices`) does not match with specs of all versions like 4.0 or 7.0 currently (2019 March) on that site.
* mozilla-central (or mozilla-beta or so)'s `toolkit/components/extensions/Schemas.jsm`
This module handles `preprocess`, `optional` or so.
# License
MPL-2.0.
npm package includes json files. These contains contents which come from
json schema files of mozilla-central repository.
Some ones are under 3-Clause BSD License, others are under MPL-2.0 License.
Both are in `License` directory.
# Release Notes
* 2019-04-02 0.1.0
* 2019-04-28 0.2.0 `chrome_settings_overrides`: `search_url_get_params`, `suggest_url_get_params`, `search_form`
* 2019-05-09 0.3.0 New `captivePortal` Api. Deleted `icons` of `ThemeType`.
[1545159](https://bugzilla.mozilla.org/show_bug.cgi?id=1545159)
* 2019-05-19 0.4.0 fix: 10 permissions are not included.
* `downloads.open`, `management`, `nativeMessaging`, `theme`, `webRequestBlocking`, `devtools`, `menus.overrideContext`, `activeTab`, `tabs`, `tabHide`
* 2019-05-19 0.4.1 fix: again
* 2019-06-01 0.5.0 New: `urlbar` API
[1547285](https://bugzilla.mozilla.org/show_bug.cgi?id=1547285)
* 2019-06-15 0.6.0 new `edge` property of `browser_specific_settings`
[1542351](https://bugzilla.mozilla.org/show_bug.cgi?id=1542351)
* 2019-06-28 0.7.0 New: normandyAddonStudy.json
[1522214](https://bugzilla.mozilla.org/show_bug.cgi?id=1522214)
* 2019-07-05 No Release
* `topSites` API moved from `toolkit/` to `browser`
* 2019-07-24 0.8.0 New: `networkStatus` permission
[1550605](https://bugzilla.mozilla.org/show_bug.cgi?id=1550605)
* 2019-08-19 0.9.0 New: `activityLog` permission
[1542403](https://bugzilla.mozilla.org/show_bug.cgi?id=1542403)
* 2019-09-12 0.10.0 New: `memory` permission
[1296898](https://bugzilla.mozilla.org/show_bug.cgi?id=1296898)
* 2019-10-09 0.11.0 Removal: `memory` permission
* 2019-11-01 (NO RELEASE) New: `OnClickData`
[1405031](https://bugzilla.mozilla.org/show_bug.cgi?id=1405031)
* 2019-11-04 0.12.0 Add: `content_security_policy` may be `{ "extension_pages":xxxx, "content_scripts":xxxx }`
[1581609](https://bugzilla.mozilla.org/show_bug.cgi?id=1581609)
* 2019-11-08 0.13.0 New property: `l10n_resources`
[1457865](https://bugzilla.mozilla.org/show_bug.cgi?id=1457865)
* 2019-11-16 0.14.0
Change: `chrome_settings_overrides`: `search_provider`: format of `favicon_url` changed from `url` to `relativeUrl`
[1571110](https://bugzilla.mozilla.org/show_bug.cgi?id=1571110)
* 2019-11-24 0.15.0
Removal: `OnClickData` (fix for 2019-11-01 #1405031)
[1595931](https://bugzilla.mozilla.org/show_bug.cgi?id=1595931)
* 2020-01-31 0.16.0 New property: `isolated_world` of `content_security_policy`
[1594232](https://bugzilla.mozilla.org/show_bug.cgi?id=1594232)
* 2020-03-05 0.17.0 New permission: `privacy`
[1618399](https://bugzilla.mozilla.org/show_bug.cgi?id=1618399)
* 2020-10-26 0.18.0 very many changes from April To October.
* Permission [1630413](https://bugzilla.mozilla.org/show_bug.cgi?id=1630413)
* OptionalPermission [1622917](https://bugzilla.mozilla.org/show_bug.cgi?id=1622917)
* 2021-01-23 0.19.0
* Removal: `content_scripts` and `isolated_world` properties of `content_security_policy`
[1594234](https://bugzilla.mozilla.org/show_bug.cgi?id=1594234)
* Change: pattern of `suggest_url`of `search_provider` property of `chrome_settings_overrides`
[1687313](https://bugzilla.mozilla.org/show_bug.cgi?id=1687313)
(You may see "Access Denied - You are not authorized to access bug 1687313. To see this bug, you must first log in to an account with the appropriate permissions.")
* 2021-02-03 0.19.1 fix: some permissions are not included, e.g. `activeTab`
* 2021-02-06 No Update
* Change: `nativeMessaging` became optional permission
[1630415](https://bugzilla.mozilla.org/show_bug.cgi?id=1630415)
* 2021-03-18 0.20.0 New: `ftp` for `protocol_handlers`
[1626365](https://bugzilla.mozilla.org/show_bug.cgi?id=1626365)
* 2021-04-21 No Update
* Change: docstring of `toolbar_field_separator` of `colors` of `ThemeType`
[1703590](https://bugzilla.mozilla.org/show_bug.cgi?id=1703590)
* 2021-04-24 0.21.0 New: `matrix` scheme of `protocol` of `ProtocolHandler`
[1688030](https://bugzilla.mozilla.org/show_bug.cgi?id=1688030)
* 2021-05-02 No Update
* Change: `chrome_settings_overrides` - `search_provider.favicon_url` can be "strictRelativeUrl" on ManifestV3.
This has no effect because JSON Schema meta-spec (draft 7, and its validators) does not know Mozilla's "format"s.
[1697059](https://bugzilla.mozilla.org/show_bug.cgi?id=1697059)
* Change: `content_security_policy` has version specs(`max_manifest_version` and `min...`), but currently this Schema does not handle them.
Maybe [draft 7's `if-then-else`](https://json-schema.org/understanding-json-schema/reference/conditionals.html) resolves this.
[1696043](https://bugzilla.mozilla.org/show_bug.cgi?id=1696043)
* 2021-05-15 0.22.0 New: object `{ resources: [string], matches: [string] }` array for `web_accessible_resources` (ManifestV3)
[1696580](https://bugzilla.mozilla.org/show_bug.cgi?id=1696580)
[1697334](https://bugzilla.mozilla.org/show_bug.cgi?id=1697334)
* 2021-06-17 0.23.0 Rename: `browserAction` API to `action` API only on Manifest V3.
On Manifest V2, `browserAction` API still remains.
**This schema file does not handle whether Manifest V is 2 or 3.**
So, the properties of both API are available.
[1706398](https://bugzilla.mozilla.org/show_bug.cgi?id=1706398)
* 2021-06-25 0.24.0 New: `extensions` array for `web_accessible_resources` (ManifestV3)
[1711168](https://bugzilla.mozilla.org/show_bug.cgi?id=1711168)
* 2021-07-08 0.25.0 Removed(0.24.0): : `extensions` array for `web_accessible_resources` (ManifestV3)
[1711168](https://bugzilla.mozilla.org/show_bug.cgi?id=1711168)
* 2021-07-26 0.26.0 New: `host_permissions` for ManifestV3
[1693385](https://bugzilla.mozilla.org/show_bug.cgi?id=1693385)
* 2021-08-27 No Update
* New: `resetScrollPosition` property of argument of `captureTab()` and `captureVisibleTab()` of `tabs` API.
[1708403](https://bugzilla.mozilla.org/show_bug.cgi?id=1708403)
[//]: # (vim:expandtab ff=unix fenc=utf-8 sw=2)