OLD | NEW |
1 Adblock Plus for Chrome and Opera | 1 Adblock Plus for Chrome, Opera and Firefox |
2 ================================= | 2 ========================================== |
3 | 3 |
4 This repository contains the platform-specific Adblock Plus source code for | 4 This repository contains the platform-specific Adblock Plus source code for |
5 Chrome and Opera. It can be used to build Adblock Plus for these platforms, | 5 Chrome, Opera and Firefox. It can be used to build Adblock Plus for these |
6 generic Adblock Plus code will be extracted from other repositories | 6 platforms, generic Adblock Plus code will be extracted from other repositories |
7 automatically (see _dependencies_ file). | 7 automatically (see _dependencies_ file). |
8 | 8 |
| 9 Note that the Firefox extension built from this repository is the new |
| 10 [WebExtension](https://developer.mozilla.org/en-US/Add-ons/WebExtensions). |
| 11 The source code of the legacy Adblock Plus extension, |
| 12 can be found [here](https://hg.adblockplus.org/adblockplus). |
| 13 |
9 Building | 14 Building |
10 --------- | 15 --------- |
11 | 16 |
12 ### Requirements | 17 ### Requirements |
13 | 18 |
14 - [Mercurial](https://www.mercurial-scm.org/) or [Git](https://git-scm.com/) (wh
ichever you used to clone this repository) | 19 - [Mercurial](https://www.mercurial-scm.org/) or [Git](https://git-scm.com/) (wh
ichever you used to clone this repository) |
15 - [Python 2.7](https://www.python.org) | 20 - [Python 2.7](https://www.python.org) |
16 - [The Jinja2 module](http://jinja.pocoo.org/docs) (>= 2.8) | 21 - [The Jinja2 module](http://jinja.pocoo.org/docs) (>= 2.8) |
17 - [The PIL module](http://www.pythonware.com/products/pil/) | 22 - [The PIL module](http://www.pythonware.com/products/pil/) |
18 - For signed builds: [PyCrypto module](https://www.dlitz.net/software/pycrypto/) | 23 - For signed builds: [PyCrypto module](https://www.dlitz.net/software/pycrypto/) |
19 | 24 |
20 ### Building the extension | 25 ### Building the extension |
21 | 26 |
22 Run the following command in the project directory: | 27 Run one of the following commands in the project directory, depending on your |
| 28 target platform: |
23 | 29 |
24 ./build.py -t chrome build -k adblockpluschrome.pem | 30 ./build.py -t chrome build -k adblockpluschrome.pem |
| 31 ./build.py -t gecko-webext build |
25 | 32 |
26 This will create a build with a name in the form | 33 This will create a build with a name in the form |
27 _adblockpluschrome-1.2.3.nnnn.crx_ | 34 _adblockpluschrome-1.2.3.nnnn.crx_ or _adblockplusfirefox-1.2.3.nnnn.xpi_ |
| 35 |
28 Note that you don't need an existing signing key for Chrome, a new key | 36 Note that you don't need an existing signing key for Chrome, a new key |
29 will be created automatically if the file doesn't exist. | 37 will be created automatically if the file doesn't exist. |
30 | 38 |
| 39 The Firefox extension will be unsigned, and therefore is mostly only useful for |
| 40 upload to Mozilla Add-ons. You can also also load it for testing purposes under |
| 41 about:debugging or by disabling signature enforcement in Firefox Nightly. |
| 42 |
31 ### Development environment | 43 ### Development environment |
32 | 44 |
33 To simplify the process of testing your changes you can create an unpacked | 45 To simplify the process of testing your changes you can create an unpacked |
34 development environment. For that run the following command: | 46 development environment. For that run one of the following commands: |
35 | 47 |
36 ./build.py -t chrome devenv | 48 ./build.py -t chrome devenv |
| 49 ./build.py -t gecko-webext devenv |
37 | 50 |
38 This will create a _devenv.chrome_ directory in the repository. In Chrome you | 51 This will create a _devenv.*_ directory in the repository. You can load the |
39 should load the directory as an unpacked extension. After making changes to the | 52 directory as an unpacked extension, under _chrome://extensions_ in Chrome, |
| 53 or under _about:debugging_ in Firefox. After making changes to the |
40 source code re-run the command to update the development environment, the | 54 source code re-run the command to update the development environment, the |
41 extension should reload automatically after a few seconds. | 55 extension should reload automatically after a few seconds. |
42 | 56 |
43 Running the unit tests | 57 Running the unit tests |
44 ---------------------- | 58 ---------------------- |
45 | 59 |
46 To verify your changes you can use the unit test suite located in the _qunit_ | 60 To verify your changes you can use the unit test suite located in the _qunit_ |
47 directory of the repository. In order to run the unit tests go to the | 61 directory of the repository. In order to run the unit tests go to the |
48 extension's Options page, open the JavaScript Console and type in: | 62 extension's Options page, open the JavaScript Console and type in: |
49 | 63 |
50 location.href = "qunit/index.html"; | 64 location.href = "qunit/index.html"; |
51 | 65 |
52 The unit tests will run automatically once the page loads. | 66 The unit tests will run automatically once the page loads. |
53 | 67 |
54 Linting | 68 Linting |
55 ------- | 69 ------- |
56 | 70 |
57 You can lint the code using [ESLint](http://eslint.org). | 71 You can lint the code using [ESLint](http://eslint.org). |
58 | 72 |
59 eslint *.js lib/ qunit/ ext/ chrome/ | 73 eslint *.js lib/ qunit/ ext/ chrome/ |
60 | 74 |
61 You will need to set up ESLint and our configuration first, see | 75 You will need to set up ESLint and our configuration first, see |
62 [eslint-config-eyeo](https://hg.adblockplus.org/codingtools/file/tip/eslint-conf
ig-eyeo) | 76 [eslint-config-eyeo](https://hg.adblockplus.org/codingtools/file/tip/eslint-conf
ig-eyeo) |
63 for more information. | 77 for more information. |
OLD | NEW |