web-ext-experiments / boilerplate-experiment

This is a boilerplate extension for experiments. It is not designed to work out of the box. It is designed to be:

• something you can clone from this repository
• alter some key values
• create a simple experiment that you can use elsewhere

To use (on Linux or OS X):

curl -L https://github.com/web-ext-experiments/boilerplate-experiment/archive/master.tar.gz | tar zxf -

This will download this repository without the git configuration so that you can use your own source control tool as needed.

Next steps, the order is not important:

• api.js is where the code for your API is added.
• schema.json describes how methods are going to be used.
• install.rdf is the registration of your experiment. The only thing you really need to change here is the id.
• LICENSE choose a license of your liking.
• README.md describe your API and tell us how to use it.

To do:

• testing

boilerplate-experiment's Issues

Doesn't work anymore in Firefox Developers Edition

Since Firefox Developers Edition 54.0b14 (32bit / Win7) this extension can't be loaded anymore temporary by using "about:debugging". This seems to be a general issue, extension type 256 isn't recognized as a valid type.

Bad link

The link to install the boilerplate does not download the boilerplate, but rather the Extension Tester addon.

curl -L https://github.com/web-ext-experiments/boilerplate-experiment/archive/master.tar.gz | tar zxf -

CODE_OF_CONDUCT.md file missing

As of January 1 2019, Mozilla requires that all GitHub projects include this CODE_OF_CONDUCT.md file in the project root. The file has two parts:

1. Required Text - All text under the headings Community Participation Guidelines and How to Report, are required, and should not be altered.
2. Optional Text - The Project Specific Etiquette heading provides a space to speak more specifically about ways people can work effectively and inclusively together. Some examples of those can be found on the Firefox Debugger project, and Common Voice. (The optional part is commented out in the raw template file, and will not be visible until you modify and uncomment that part.)

If you have any questions about this file, or Code of Conduct policies and procedures, please see Mozilla-GitHub-Standards or email [email protected].

(Message COC001)

em:id, em:name, em:version should be elements, not attributes

STR:

1. Clone the repo
2. zip boilerplate.xpi LICENSE api.js install.rdf schema.json
3. addons-validator boilerplate.xpi

Expected results:

Validation Summary:

errors          0

Actual results:

Validation Summary:

errors          3
notices         1
warnings        0

ERRORS:

Code                  Message                                    Description                                 File          Line   Column
RDF_ID_MISSING        No <em:id> element at the top level of     <em:id> at the top level is required        install.rdf
                      install.rdf
RDF_NAME_MISSING      No <em:name> element at the top level of   <em:name> at the top level is required      install.rdf
                      install.rdf
RDF_VERSION_MISSING   No <em:version> element at the top level   <em:version> at the top level is required   install.rdf
                      of install.rdf
NOTICES:

Code               Message                                     Description                                                                           File          Line   Column
RDF_TYPE_MISSING   No <em:type> element found in install.rdf   It isn't always required, but it is the most reliable method for determining add-on   install.rdf
                                                               type.

Looking for property example

I've been desperately looking for an example on how to implement properties (i e values declared in the manifest.json. Similarly to how themes can be created without a single line of JS).

I even studied ext-theme.js to some extent.

Is it at all possible to create webextension experiments that include new, custom properties?

Update to non-legacy format

This repo needs to be updated to use manifest.json to define the API.