docs/metadata.edge.example - Issue 29345751: Issue 4028 - Add support for Edge extensions to buildtools

Delta Between Two Patch Sets: docs/metadata.edge.example

Issue 29345751: Issue 4028 - Add support for Edge extensions to buildtools (Closed)

Left Patch Set: Created June 13, 2016, 12:31 p.m.

Right Patch Set: Address Windows Store issues with blockmap and devbuild display name Created Oct. 14, 2016, 12:07 p.m.

Left:
Right:

Use n/p to move between diff chunks; N/P to move between comments.

Jump to:

Left: Side by side diff | Download
Right: Side by side diff | Download

LEFT	RIGHT
1 [default]	1 [default]
Vasily Kuznetsov 2016/06/13 12:57:31 Rough example of how `metadata.edge` is supposed t Rough example of how `metadata.edge` is supposed to look to make this code work. At the moment this is here just to make it possible to test the changes with `adblockpluschrome`. Ideally, I think the dependency on specific metadata content should be documented in buildtools for all types of builds. Wladimir Palant 2016/06/17 09:53:45 Documented - yes. But this content is very specifi Show quoted text On 2016/06/13 12:57:31, Vasily Kuznetsov wrote: > Ideally, I think the dependency on specific metadata content should be > documented in buildtools for all types of builds. Documented - yes. But this content is very specific to adblockpluschrome and I don't think it belongs here in this form. Vasily Kuznetsov 2016/06/17 17:53:26 Yeah, I agree. This example is pretty rough and ha Show quoted text On 2016/06/17 09:53:45, Wladimir Palant wrote: > On 2016/06/13 12:57:31, Vasily Kuznetsov wrote: > > Ideally, I think the dependency on specific metadata content should be > > documented in buildtools for all types of builds. > > Documented - yes. But this content is very specific to adblockpluschrome and I > don't think it belongs here in this form. Yeah, I agree. This example is pretty rough and has too much specific data. What we want is more like the list of the sections and keys that are significant for the packager, what values are expected and what will be done with them. Do you think it makes more sense to strip this file down and add comments with descriptions or to write an .md documentation file instead? Wladimir Palant 2016/06/29 19:33:44 IMHO, this isn't worth documenting "properly" - an Show quoted text On 2016/06/17 17:53:26, Vasily Kuznetsov wrote: > Do you think it makes more sense to strip this file down and add comments with > descriptions or to write an .md documentation file instead? IMHO, this isn't worth documenting "properly" - an example and a few comments where necessary will do. Maybe even split the example into a "common" part (not platform-specific) and an Edge-specific one, this will make adding examples for other platforms later easier. Vasily Kuznetsov 2016/07/01 19:51:27 For now I made the existing example more abstract Show quoted text On 2016/06/29 19:33:44, Wladimir Palant wrote: > On 2016/06/17 17:53:26, Vasily Kuznetsov wrote: > > Do you think it makes more sense to strip this file down and add comments with > > descriptions or to write an .md documentation file instead? > > IMHO, this isn't worth documenting "properly" - an example and a few comments > where necessary will do. Maybe even split the example into a "common" part (not > platform-specific) and an Edge-specific one, this will make adding examples for > other platforms later easier. For now I made the existing example more abstract and compact and added comments. I'd appreciate some review on the comments because I might have misunderstood the meaning of some keys. The common part is not (and wasn't) in this example file at the moment, We should probably add and example for it too, together with example metadata for other targets, but perhaps not in this issue.
	2 # Base metadata file whose sections and keys we inherit but can override.

2 inherit = metadata.common	3 inherit = metadata.common

3	4

4 # App identity assigned by the Store.	5 # Icons to be placed into /Assets and referenced in AppxManifest.xml.

5 [package_identity]	6 [appx_assets]

6 name = EyeoGmbH.AdblockPlus	7 # 50x50 logo for the store.

7 publisher = CN=4F066043-8AFE-41C9-B762-6C15E77E3F88	8 logo_50.png = path/to/logo_50.png

8	9

9 # Icons to be placed in /Assets and referenced in AppxManifest.xml.	10 # 44x44 and 150x150 logos for Windows UI.

10 [appx_assets]	11 logo_44.png = path/to/logo_44.png

11 logo_44.png = chrome/icons/abp-38.png	12 logo_150.png = path/to/big_logo.png

12 logo_50.png = chrome/icons/detailed/abp-48.png

13 logo_150.png = adblockplusui/skin/abp-128.png

14	13

15 [compat]	14 [compat]

	15 # Target Edge version (for manifest.json)

16 edge = 37.14332.1000.0	16 edge = 37.14332.1000.0

	17 # Min/max windows version (for AppxManifest.xml)

	18 windows = 10.0.14332.0/12.0.0.0

17	19

18 [general]	20 [general]

19 basename = adblockplusedge	21 # App identity and publisher ID assigned by the Windows Dev Center.

20 display_name = Adblock Plus	22 app_id = ACME.MyExt

21 description = Adblock Plus is the most popular ad blocker ever, and also support s websites by not blocking unobstrusive ads by default (configurable).	23 publisher_id = CN=4F066043-8AFE-41C9-B762-6C15E77E3F88

22 background_color = red	24

23 extension_id = 1.0	25 # Base name of the plugin file (version and extension will be added to this).

24 permissions = tabs	26 basename = myext-edge

	27

	28 # Background color for the Appx manifest.

	29 background_color = pink

	30

	31 # Permissions of the extension to place into manifest.json

	32 # (see https://developer.chrome.com/extensions/declare_permissions).

	33 permissions =

	34 tabs

	35 bookmarks

25 http:///	36 http:///

26 https:///	37 https:///

27 contextMenus	38

28 webRequest	39 # UI definitions.

29 webRequestBlocking

30 webNavigation

31 storage

32 unlimitedStorage

33 notifications

34 options = options.html	40 options = options.html

35 devtools = devtools.html

36 browserAction = icons/abp-19.png icons/abp-38.png popup.html

37 icons = icons/abp-16.png icons/abp-32.png icons/detailed/abp-48.png

38 icons/detailed/abp-64.png icons/detailed/abp-128.png

39 managedStorageSchema = managed-storage-schema.json

40	41

	42 # Icon for the browser toolbar. Used to produce browser_action key in

	43 # manifest.json (see https://developer.chrome.com/extensions/browserAction).

	44 browserAction = icons/icon-19.png icons/icon-38.png popup.html

	45

	46 # Icons for manifest.json.

	47 icons = icon-16.png icon-32.png icon-48.png icon-64.png icon-128.png

	48

	49 # Files that are renamed/moved when placed into the package.

41 [mapping]	50 [mapping]

42 icons/abp-19.png = chrome/icons/abp-19.png	51 target/path/file.png = source/path/icon.png

43 icons/abp-19-whitelisted.png = chrome/icons/abp-19-whitelisted.png

44 icons/abp-19-notification-critical.png = chrome/icons/abp-19-notification-critic al.png

45 icons/abp-19-notification-information.png = chrome/icons/abp-19-notification-inf ormation.png

46 icons/abp-38.png = chrome/icons/abp-38.png

47 icons/abp-38-whitelisted.png = chrome/icons/abp-38-whitelisted.png

48 icons/abp-38-notification-critical.png = chrome/icons/abp-38-notification-critic al.png

49 icons/abp-38-notification-information.png = chrome/icons/abp-38-notification-inf ormation.png

50 icons/detailed/abp-48.png = chrome/icons/detailed/abp-48.png

51 ext/devtools.js = chrome/ext/devtools.js

52 devtools.html = chrome/devtools.html

53 devtools.js = chrome/devtools.js

54 devtools-panel.html = adblockplusui/devtools-panel.html

55 devtools-panel.js = adblockplusui/devtools-panel.js

56 skin/devtools-panel.css = adblockplusui/skin/devtools-panel.css

57 managed-storage-schema.json = chrome/managed-storage-schema.json

58	52

	53 # Javascript source files to be compiled/bundled by JSHydra.

59 [convert_js]	54 [convert_js]

60 lib/adblockplus.js -= abp2blocklist/lib/abp2blocklist.js safari/contentBlocking. js	55 # Two files bundled into one.

	56 path/bundle.js = source/path/src1.js src2.js

	57

	58 # Remove a file from a bundle defined in common.metadata.

	59 path/common-bundle.js -= removed/src.js

LEFT	RIGHT